Skip to content

Commit

Permalink
Update schema and improve docstring punctuation for template_model.py
Browse files Browse the repository at this point in the history
  • Loading branch information
@nanglo123 @kkaris
nanglo123 authored and kkaris committed Dec 5, 2023
1 parent 93eb9a0 commit b6f556c
Show file tree
Hide file tree
Showing 2 changed files with 162 additions and 98 deletions.
106 changes: 81 additions & 25 deletions mira/metamodel/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,18 @@
"properties": {
"rate_law": {
"title": "Rate Law",
"type": "string",
"example": "2*x"
"description": "The rate law for the template.",
"example": "2*x",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the template.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "The display name of the template.",
"type": "string"
}
}
Expand All @@ -102,15 +105,18 @@
"properties": {
"rate_law": {
"title": "Rate Law",
"type": "string",
"example": "2*x"
"description": "The rate law for the template.",
"example": "2*x",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the template.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "The display name of the template.",
"type": "string"
},
"type": {
Expand Down Expand Up @@ -152,15 +158,18 @@
"properties": {
"rate_law": {
"title": "Rate Law",
"type": "string",
"example": "2*x"
"description": "The rate law for the template.",
"example": "2*x",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the template.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "The display name of the template.",
"type": "string"
},
"type": {
Expand Down Expand Up @@ -206,19 +215,23 @@
"properties": {
"rate_law": {
"title": "Rate Law",
"type": "string",
"example": "2*x"
"description": "The rate law for the template.",
"example": "2*x",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the template.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "The display name of the template.",
"type": "string"
},
"type": {
"title": "Type",
"description": "The type of the template",
"default": "GroupedControlledProduction",
"const": "GroupedControlledProduction",
"enum": [
Expand All @@ -228,16 +241,24 @@
},
"controllers": {
"title": "Controllers",
"description": "The controllers to be added to the template",
"type": "array",
"items": {
"$ref": "#/definitions/Concept"
}
},
"outcome": {
"$ref": "#/definitions/Concept"
"title": "Outcome",
"description": "The result of the template",
"allOf": [
{
"$ref": "#/definitions/Concept"
}
]
},
"provenance": {
"title": "Provenance",
"description": "The provenance associated with a template",
"type": "array",
"items": {
"$ref": "#/definitions/Provenance"
Expand All @@ -256,19 +277,23 @@
"properties": {
"rate_law": {
"title": "Rate Law",
"type": "string",
"example": "2*x"
"description": "The rate law for the template.",
"example": "2*x",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the template.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "The display name of the template.",
"type": "string"
},
"type": {
"title": "Type",
"description": "The the type of the template",
"default": "ControlledProduction",
"const": "ControlledProduction",
"enum": [
Expand All @@ -277,13 +302,26 @@
"type": "string"
},
"controller": {
"$ref": "#/definitions/Concept"
"title": "Controller",
"description": "The controller of the template",
"allOf": [
{
"$ref": "#/definitions/Concept"
}
]
},
"outcome": {
"$ref": "#/definitions/Concept"
"title": "Outcome",
"description": "The outcome of the template",
"allOf": [
{
"$ref": "#/definitions/Concept"
}
]
},
"provenance": {
"title": "Provenance",
"description": "The provenance associated with a template)",
"type": "array",
"items": {
"$ref": "#/definitions/Provenance"
Expand All @@ -302,15 +340,18 @@
"properties": {
"rate_law": {
"title": "Rate Law",
"type": "string",
"example": "2*x"
"description": "The rate law for the template.",
"example": "2*x",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the template.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "The display name of the template.",
"type": "string"
},
"type": {
Expand Down Expand Up @@ -348,15 +389,18 @@
"properties": {
"rate_law": {
"title": "Rate Law",
"type": "string",
"example": "2*x"
"description": "The rate law for the template.",
"example": "2*x",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the template.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "The display name of the template.",
"type": "string"
},
"type": {
Expand Down Expand Up @@ -390,15 +434,18 @@
"properties": {
"rate_law": {
"title": "Rate Law",
"type": "string",
"example": "2*x"
"description": "The rate law for the template.",
"example": "2*x",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the template.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "The display name of the template.",
"type": "string"
},
"type": {
Expand Down Expand Up @@ -432,15 +479,18 @@
"properties": {
"rate_law": {
"title": "Rate Law",
"type": "string",
"example": "2*x"
"description": "The rate law for the template.",
"example": "2*x",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the template.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "The display name of the template.",
"type": "string"
},
"type": {
Expand Down Expand Up @@ -478,15 +528,18 @@
"properties": {
"rate_law": {
"title": "Rate Law",
"type": "string",
"example": "2*x"
"description": "The rate law for the template.",
"example": "2*x",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the template.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "The display name of the template.",
"type": "string"
},
"type": {
Expand Down Expand Up @@ -528,15 +581,18 @@
"properties": {
"rate_law": {
"title": "Rate Law",
"type": "string",
"example": "2*x"
"description": "The rate law for the template.",
"example": "2*x",
"type": "string"
},
"name": {
"title": "Name",
"description": "The name of the template.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "The display name of the template.",
"type": "string"
},
"type": {
Expand Down
Loading

0 comments on commit b6f556c

Please sign in to comment.