Skip to content

Commit

Permalink
Add describer metadata property.
Browse files Browse the repository at this point in the history
  • Loading branch information
dglazkov committed Jan 15, 2025
1 parent 81264fc commit 564c0b0
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
4 changes: 4 additions & 0 deletions packages/manifest/bbm.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,10 @@
"$ref": "#/definitions/InputValues",
"description": "Arguments that are passed to the graph, useful to bind values to graphs."
},
"describer": {
"description": "The URL of the graph that will act as the describer for this graph. Can be a relative URL and refer to a sub-graph within this graph.\n\nThe describers in the format of \"module:name\" will be interpreted as \"use the `describe` export of the module named `name` to describe this graph\".",
"type": "string"
},
"description": {
"description": "The description of the graph.",
"type": "string"
Expand Down
4 changes: 4 additions & 0 deletions packages/schema/breadboard.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,10 @@
"type": "string",
"description": "Version of the graph. [semver](https://semver.org/) format is encouraged."
},
"describer": {
"type": "string",
"description": "The URL of the graph that will act as the describer for this graph. Can be a relative URL and refer to a sub-graph within this graph.\n\nThe describers in the format of \"module:name\" will be interpreted as \"use the `describe` export of the module named `name` to describe this graph\"."
},
"metadata": {
"$ref": "#/definitions/GraphMetadata",
"description": "Metadata associated with the graph."
Expand Down
10 changes: 10 additions & 0 deletions packages/types/src/graph-descriptor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,16 @@ export type GraphInlineMetadata = {
* [semver](https://semver.org/) format is encouraged.
*/
version?: string;
/**
* The URL of the graph that will act as the describer for
* this graph. Can be a relative URL and refer to a sub-graph
* within this graph.
*
* The describers in the format of "module:name" will be interpreted as
* "use the `describe` export of the module named `name` to describe this
* graph".
*/
describer?: string;
};

/**
Expand Down

0 comments on commit 564c0b0

Please sign in to comment.