diff --git a/openapi.yaml b/openapi.yaml index eeb0cb4..f06296d 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -7,8464 +7,8592 @@ externalDocs: description: Model Catalog url: https://w3id.org/okn/o/sdm servers: -- url: https://api.models.mint.isi.edu/v1.8.0 -- url: http://localhost:8080/v1.8.0 -- url: https://api.models.wifire.mint.isi.edu/v1.8.0 + - url: https://api.models.mint.isi.edu/v1.8.0 + - url: http://localhost:8080/v1.8.0 + - url: https://api.models.wifire.mint.isi.edu/v1.8.0 paths: /catalogidentifiers: get: - description: Gets a list of all instances of CatalogIdentifier (more information + description: + Gets a list of all instances of CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/CatalogIdentifier' + $ref: "#/components/schemas/CatalogIdentifier" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of CatalogIdentifier. summary: List all instances of CatalogIdentifier tags: - - CatalogIdentifier + - CatalogIdentifier post: - description: Create a new instance of CatalogIdentifier (more information in + description: + Create a new instance of CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/CatalogIdentifier' + $ref: "#/components/schemas/CatalogIdentifier" description: Information about the CatalogIdentifierto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CatalogIdentifier' + $ref: "#/components/schemas/CatalogIdentifier" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one CatalogIdentifier tags: - - CatalogIdentifier + - CatalogIdentifier /catalogidentifiers/{id}: delete: description: Delete an existing CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) parameters: - - description: The ID of the CatalogIdentifier to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the CatalogIdentifier to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing CatalogIdentifier tags: - - CatalogIdentifier + - CatalogIdentifier get: - description: Gets the details of a given CatalogIdentifier (more information + description: + Gets the details of a given CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the CatalogIdentifier to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the CatalogIdentifier to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CatalogIdentifier' + $ref: "#/components/schemas/CatalogIdentifier" description: Gets the details of a given CatalogIdentifier summary: Get a single CatalogIdentifier by its id tags: - - CatalogIdentifier + - CatalogIdentifier put: description: Updates an existing CatalogIdentifier (more information in https://w3id.org/okn/o/sd#CatalogIdentifier) parameters: - - description: The ID of the CatalogIdentifier to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the CatalogIdentifier to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/CatalogIdentifier' + $ref: "#/components/schemas/CatalogIdentifier" description: An old CatalogIdentifierto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CatalogIdentifier' + $ref: "#/components/schemas/CatalogIdentifier" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing CatalogIdentifier tags: - - CatalogIdentifier + - CatalogIdentifier /configurationsetups: get: - description: Gets a list of all instances of ConfigurationSetup (more information + description: + Gets a list of all instances of ConfigurationSetup (more information in https://w3id.org/okn/o/sd#ConfigurationSetup) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of ConfigurationSetup. summary: List all instances of ConfigurationSetup tags: - - ConfigurationSetup + - ConfigurationSetup post: - description: Create a new instance of ConfigurationSetup (more information in + description: + Create a new instance of ConfigurationSetup (more information in https://w3id.org/okn/o/sd#ConfigurationSetup) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" description: Information about the ConfigurationSetupto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one ConfigurationSetup tags: - - ConfigurationSetup + - ConfigurationSetup /configurationsetups/{id}: delete: description: Delete an existing ConfigurationSetup (more information in https://w3id.org/okn/o/sd#ConfigurationSetup) parameters: - - description: The ID of the ConfigurationSetup to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the ConfigurationSetup to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing ConfigurationSetup tags: - - ConfigurationSetup + - ConfigurationSetup get: - description: Gets the details of a given ConfigurationSetup (more information + description: + Gets the details of a given ConfigurationSetup (more information in https://w3id.org/okn/o/sd#ConfigurationSetup) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the ConfigurationSetup to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the ConfigurationSetup to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" description: Gets the details of a given ConfigurationSetup summary: Get a single ConfigurationSetup by its id tags: - - ConfigurationSetup + - ConfigurationSetup put: description: Updates an existing ConfigurationSetup (more information in https://w3id.org/okn/o/sd#ConfigurationSetup) parameters: - - description: The ID of the ConfigurationSetup to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the ConfigurationSetup to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" description: An old ConfigurationSetupto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing ConfigurationSetup tags: - - ConfigurationSetup + - ConfigurationSetup /constraints: get: - description: Gets a list of all instances of Constraint (more information in + description: + Gets a list of all instances of Constraint (more information in https://w3id.org/okn/o/sd#Constraint) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Constraint' + $ref: "#/components/schemas/Constraint" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Constraint. summary: List all instances of Constraint tags: - - Constraint + - Constraint post: description: Create a new instance of Constraint (more information in https://w3id.org/okn/o/sd#Constraint) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Constraint' + $ref: "#/components/schemas/Constraint" description: Information about the Constraintto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Constraint' + $ref: "#/components/schemas/Constraint" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Constraint tags: - - Constraint + - Constraint /constraints/{id}: delete: description: Delete an existing Constraint (more information in https://w3id.org/okn/o/sd#Constraint) parameters: - - description: The ID of the Constraint to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Constraint to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Constraint tags: - - Constraint + - Constraint get: description: Gets the details of a given Constraint (more information in https://w3id.org/okn/o/sd#Constraint) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Constraint to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Constraint to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Constraint' + $ref: "#/components/schemas/Constraint" description: Gets the details of a given Constraint summary: Get a single Constraint by its id tags: - - Constraint + - Constraint put: description: Updates an existing Constraint (more information in https://w3id.org/okn/o/sd#Constraint) parameters: - - description: The ID of the Constraint to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Constraint to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Constraint' + $ref: "#/components/schemas/Constraint" description: An old Constraintto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Constraint' + $ref: "#/components/schemas/Constraint" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Constraint tags: - - Constraint + - Constraint /datatransformations: get: - description: Gets a list of all instances of DataTransformation (more information + description: + Gets a list of all instances of DataTransformation (more information in https://w3id.org/okn/o/sd#DataTransformation) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/DataTransformation' + $ref: "#/components/schemas/DataTransformation" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of DataTransformation. summary: List all instances of DataTransformation tags: - - DataTransformation + - DataTransformation post: - description: Create a new instance of DataTransformation (more information in + description: + Create a new instance of DataTransformation (more information in https://w3id.org/okn/o/sd#DataTransformation) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/DataTransformation' + $ref: "#/components/schemas/DataTransformation" description: Information about the DataTransformationto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/DataTransformation' + $ref: "#/components/schemas/DataTransformation" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one DataTransformation tags: - - DataTransformation + - DataTransformation /datatransformations/{id}: delete: description: Delete an existing DataTransformation (more information in https://w3id.org/okn/o/sd#DataTransformation) parameters: - - description: The ID of the DataTransformation to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the DataTransformation to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing DataTransformation tags: - - DataTransformation + - DataTransformation get: - description: Gets the details of a given DataTransformation (more information + description: + Gets the details of a given DataTransformation (more information in https://w3id.org/okn/o/sd#DataTransformation) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the DataTransformation to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the DataTransformation to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DataTransformation' + $ref: "#/components/schemas/DataTransformation" description: Gets the details of a given DataTransformation summary: Get a single DataTransformation by its id tags: - - DataTransformation + - DataTransformation put: description: Updates an existing DataTransformation (more information in https://w3id.org/okn/o/sd#DataTransformation) parameters: - - description: The ID of the DataTransformation to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the DataTransformation to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/DataTransformation' + $ref: "#/components/schemas/DataTransformation" description: An old DataTransformationto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DataTransformation' + $ref: "#/components/schemas/DataTransformation" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing DataTransformation tags: - - DataTransformation + - DataTransformation /datatransformationsetups: get: - description: Gets a list of all instances of DataTransformationSetup (more information + description: + Gets a list of all instances of DataTransformationSetup (more information in https://w3id.org/okn/o/sd#DataTransformationSetup) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/DataTransformationSetup' + $ref: "#/components/schemas/DataTransformationSetup" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of DataTransformationSetup. summary: List all instances of DataTransformationSetup tags: - - DataTransformationSetup + - DataTransformationSetup post: - description: Create a new instance of DataTransformationSetup (more information + description: + Create a new instance of DataTransformationSetup (more information in https://w3id.org/okn/o/sd#DataTransformationSetup) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/DataTransformationSetup' + $ref: "#/components/schemas/DataTransformationSetup" description: Information about the DataTransformationSetupto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/DataTransformationSetup' + $ref: "#/components/schemas/DataTransformationSetup" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one DataTransformationSetup tags: - - DataTransformationSetup + - DataTransformationSetup /datatransformationsetups/{id}: delete: - description: Delete an existing DataTransformationSetup (more information in + description: + Delete an existing DataTransformationSetup (more information in https://w3id.org/okn/o/sd#DataTransformationSetup) parameters: - - description: The ID of the DataTransformationSetup to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the DataTransformationSetup to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing DataTransformationSetup tags: - - DataTransformationSetup + - DataTransformationSetup get: - description: Gets the details of a given DataTransformationSetup (more information + description: + Gets the details of a given DataTransformationSetup (more information in https://w3id.org/okn/o/sd#DataTransformationSetup) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the DataTransformationSetup to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the DataTransformationSetup to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DataTransformationSetup' + $ref: "#/components/schemas/DataTransformationSetup" description: Gets the details of a given DataTransformationSetup summary: Get a single DataTransformationSetup by its id tags: - - DataTransformationSetup + - DataTransformationSetup put: - description: Updates an existing DataTransformationSetup (more information in + description: + Updates an existing DataTransformationSetup (more information in https://w3id.org/okn/o/sd#DataTransformationSetup) parameters: - - description: The ID of the DataTransformationSetup to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the DataTransformationSetup to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/DataTransformationSetup' + $ref: "#/components/schemas/DataTransformationSetup" description: An old DataTransformationSetupto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DataTransformationSetup' + $ref: "#/components/schemas/DataTransformationSetup" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing DataTransformationSetup tags: - - DataTransformationSetup + - DataTransformationSetup /datasetspecifications: get: - description: Gets a list of all instances of DatasetSpecification (more information + description: + Gets a list of all instances of DatasetSpecification (more information in https://w3id.org/okn/o/sd#DatasetSpecification) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of DatasetSpecification. summary: List all instances of DatasetSpecification tags: - - DatasetSpecification + - DatasetSpecification post: - description: Create a new instance of DatasetSpecification (more information + description: + Create a new instance of DatasetSpecification (more information in https://w3id.org/okn/o/sd#DatasetSpecification) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" description: Information about the DatasetSpecificationto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one DatasetSpecification tags: - - DatasetSpecification + - DatasetSpecification /datasetspecifications/{id}: delete: description: Delete an existing DatasetSpecification (more information in https://w3id.org/okn/o/sd#DatasetSpecification) parameters: - - description: The ID of the DatasetSpecification to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the DatasetSpecification to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing DatasetSpecification tags: - - DatasetSpecification + - DatasetSpecification get: - description: Gets the details of a given DatasetSpecification (more information + description: + Gets the details of a given DatasetSpecification (more information in https://w3id.org/okn/o/sd#DatasetSpecification) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the DatasetSpecification to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the DatasetSpecification to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" description: Gets the details of a given DatasetSpecification summary: Get a single DatasetSpecification by its id tags: - - DatasetSpecification + - DatasetSpecification put: description: Updates an existing DatasetSpecification (more information in https://w3id.org/okn/o/sd#DatasetSpecification) parameters: - - description: The ID of the DatasetSpecification to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the DatasetSpecification to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" description: An old DatasetSpecificationto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing DatasetSpecification tags: - - DatasetSpecification + - DatasetSpecification /fundinginformations: get: - description: Gets a list of all instances of FundingInformation (more information + description: + Gets a list of all instances of FundingInformation (more information in https://w3id.org/okn/o/sd#FundingInformation) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of FundingInformation. summary: List all instances of FundingInformation tags: - - FundingInformation + - FundingInformation post: - description: Create a new instance of FundingInformation (more information in + description: + Create a new instance of FundingInformation (more information in https://w3id.org/okn/o/sd#FundingInformation) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" description: Information about the FundingInformationto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one FundingInformation tags: - - FundingInformation + - FundingInformation /fundinginformations/{id}: delete: description: Delete an existing FundingInformation (more information in https://w3id.org/okn/o/sd#FundingInformation) parameters: - - description: The ID of the FundingInformation to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the FundingInformation to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing FundingInformation tags: - - FundingInformation + - FundingInformation get: - description: Gets the details of a given FundingInformation (more information + description: + Gets the details of a given FundingInformation (more information in https://w3id.org/okn/o/sd#FundingInformation) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the FundingInformation to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the FundingInformation to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" description: Gets the details of a given FundingInformation summary: Get a single FundingInformation by its id tags: - - FundingInformation + - FundingInformation put: description: Updates an existing FundingInformation (more information in https://w3id.org/okn/o/sd#FundingInformation) parameters: - - description: The ID of the FundingInformation to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the FundingInformation to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" description: An old FundingInformationto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing FundingInformation tags: - - FundingInformation + - FundingInformation /images: get: description: Gets a list of all instances of Image (more information in https://w3id.org/okn/o/sd#Image) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Image. summary: List all instances of Image tags: - - Image + - Image post: description: Create a new instance of Image (more information in https://w3id.org/okn/o/sd#Image) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" description: Information about the Imageto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Image tags: - - Image + - Image /images/{id}: delete: description: Delete an existing Image (more information in https://w3id.org/okn/o/sd#Image) parameters: - - description: The ID of the Image to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Image to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Image tags: - - Image + - Image get: description: Gets the details of a given Image (more information in https://w3id.org/okn/o/sd#Image) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Image to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Image to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" description: Gets the details of a given Image summary: Get a single Image by its id tags: - - Image + - Image put: description: Updates an existing Image (more information in https://w3id.org/okn/o/sd#Image) parameters: - - description: The ID of the Image to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Image to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" description: An old Imageto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Image tags: - - Image + - Image /numericalindexs: get: - description: Gets a list of all instances of NumericalIndex (more information + description: + Gets a list of all instances of NumericalIndex (more information in https://w3id.org/okn/o/sd#NumericalIndex) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of NumericalIndex. summary: List all instances of NumericalIndex tags: - - NumericalIndex + - NumericalIndex post: description: Create a new instance of NumericalIndex (more information in https://w3id.org/okn/o/sd#NumericalIndex) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" description: Information about the NumericalIndexto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one NumericalIndex tags: - - NumericalIndex + - NumericalIndex /numericalindexs/{id}: delete: description: Delete an existing NumericalIndex (more information in https://w3id.org/okn/o/sd#NumericalIndex) parameters: - - description: The ID of the NumericalIndex to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the NumericalIndex to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing NumericalIndex tags: - - NumericalIndex + - NumericalIndex get: - description: Gets the details of a given NumericalIndex (more information in + description: + Gets the details of a given NumericalIndex (more information in https://w3id.org/okn/o/sd#NumericalIndex) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the NumericalIndex to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the NumericalIndex to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" description: Gets the details of a given NumericalIndex summary: Get a single NumericalIndex by its id tags: - - NumericalIndex + - NumericalIndex put: description: Updates an existing NumericalIndex (more information in https://w3id.org/okn/o/sd#NumericalIndex) parameters: - - description: The ID of the NumericalIndex to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the NumericalIndex to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" description: An old NumericalIndexto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing NumericalIndex tags: - - NumericalIndex + - NumericalIndex /organizations: get: - description: Gets a list of all instances of Organization (more information + description: + Gets a list of all instances of Organization (more information in https://w3id.org/okn/o/sd#Organization) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/Organization" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Organization. summary: List all instances of Organization tags: - - Organization + - Organization post: description: Create a new instance of Organization (more information in https://w3id.org/okn/o/sd#Organization) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/Organization" description: Information about the Organizationto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/Organization" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Organization tags: - - Organization + - Organization /organizations/{id}: delete: description: Delete an existing Organization (more information in https://w3id.org/okn/o/sd#Organization) parameters: - - description: The ID of the Organization to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Organization to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Organization tags: - - Organization + - Organization get: description: Gets the details of a given Organization (more information in https://w3id.org/okn/o/sd#Organization) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Organization to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Organization to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/Organization" description: Gets the details of a given Organization summary: Get a single Organization by its id tags: - - Organization + - Organization put: description: Updates an existing Organization (more information in https://w3id.org/okn/o/sd#Organization) parameters: - - description: The ID of the Organization to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Organization to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/Organization" description: An old Organizationto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/Organization" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Organization tags: - - Organization + - Organization /parameters: get: - description: Gets a list of all instances of Parameter (more information in + description: + Gets a list of all instances of Parameter (more information in https://w3id.org/okn/o/sd#Parameter) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Parameter. summary: List all instances of Parameter tags: - - Parameter + - Parameter post: description: Create a new instance of Parameter (more information in https://w3id.org/okn/o/sd#Parameter) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" description: Information about the Parameterto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Parameter tags: - - Parameter + - Parameter /parameters/{id}: delete: description: Delete an existing Parameter (more information in https://w3id.org/okn/o/sd#Parameter) parameters: - - description: The ID of the Parameter to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Parameter to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Parameter tags: - - Parameter + - Parameter get: description: Gets the details of a given Parameter (more information in https://w3id.org/okn/o/sd#Parameter) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Parameter to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Parameter to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" description: Gets the details of a given Parameter summary: Get a single Parameter by its id tags: - - Parameter + - Parameter put: description: Updates an existing Parameter (more information in https://w3id.org/okn/o/sd#Parameter) parameters: - - description: The ID of the Parameter to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Parameter to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" description: An old Parameterto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Parameter tags: - - Parameter + - Parameter /persons: get: description: Gets a list of all instances of Person (more information in https://w3id.org/okn/o/sd#Person) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Person. summary: List all instances of Person tags: - - Person + - Person post: description: Create a new instance of Person (more information in https://w3id.org/okn/o/sd#Person) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" description: Information about the Personto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Person tags: - - Person + - Person /persons/{id}: delete: description: Delete an existing Person (more information in https://w3id.org/okn/o/sd#Person) parameters: - - description: The ID of the Person to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Person to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Person tags: - - Person + - Person get: description: Gets the details of a given Person (more information in https://w3id.org/okn/o/sd#Person) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Person to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Person to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" description: Gets the details of a given Person summary: Get a single Person by its id tags: - - Person + - Person put: description: Updates an existing Person (more information in https://w3id.org/okn/o/sd#Person) parameters: - - description: The ID of the Person to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Person to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" description: An old Personto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Person tags: - - Person + - Person /samplecollections: get: - description: Gets a list of all instances of SampleCollection (more information + description: + Gets a list of all instances of SampleCollection (more information in https://w3id.org/okn/o/sd#SampleCollection) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/SampleCollection' + $ref: "#/components/schemas/SampleCollection" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of SampleCollection. summary: List all instances of SampleCollection tags: - - SampleCollection + - SampleCollection post: - description: Create a new instance of SampleCollection (more information in + description: + Create a new instance of SampleCollection (more information in https://w3id.org/okn/o/sd#SampleCollection) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SampleCollection' + $ref: "#/components/schemas/SampleCollection" description: Information about the SampleCollectionto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SampleCollection' + $ref: "#/components/schemas/SampleCollection" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one SampleCollection tags: - - SampleCollection + - SampleCollection /samplecollections/{id}: delete: description: Delete an existing SampleCollection (more information in https://w3id.org/okn/o/sd#SampleCollection) parameters: - - description: The ID of the SampleCollection to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SampleCollection to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing SampleCollection tags: - - SampleCollection + - SampleCollection get: - description: Gets the details of a given SampleCollection (more information + description: + Gets the details of a given SampleCollection (more information in https://w3id.org/okn/o/sd#SampleCollection) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the SampleCollection to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the SampleCollection to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SampleCollection' + $ref: "#/components/schemas/SampleCollection" description: Gets the details of a given SampleCollection summary: Get a single SampleCollection by its id tags: - - SampleCollection + - SampleCollection put: description: Updates an existing SampleCollection (more information in https://w3id.org/okn/o/sd#SampleCollection) parameters: - - description: The ID of the SampleCollection to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SampleCollection to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SampleCollection' + $ref: "#/components/schemas/SampleCollection" description: An old SampleCollectionto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SampleCollection' + $ref: "#/components/schemas/SampleCollection" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing SampleCollection tags: - - SampleCollection + - SampleCollection /sampleexecutions: get: - description: Gets a list of all instances of SampleExecution (more information + description: + Gets a list of all instances of SampleExecution (more information in https://w3id.org/okn/o/sd#SampleExecution) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/SampleExecution' + $ref: "#/components/schemas/SampleExecution" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of SampleExecution. summary: List all instances of SampleExecution tags: - - SampleExecution + - SampleExecution post: description: Create a new instance of SampleExecution (more information in https://w3id.org/okn/o/sd#SampleExecution) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SampleExecution' + $ref: "#/components/schemas/SampleExecution" description: Information about the SampleExecutionto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SampleExecution' + $ref: "#/components/schemas/SampleExecution" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one SampleExecution tags: - - SampleExecution + - SampleExecution /sampleexecutions/{id}: delete: description: Delete an existing SampleExecution (more information in https://w3id.org/okn/o/sd#SampleExecution) parameters: - - description: The ID of the SampleExecution to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SampleExecution to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing SampleExecution tags: - - SampleExecution + - SampleExecution get: - description: Gets the details of a given SampleExecution (more information in + description: + Gets the details of a given SampleExecution (more information in https://w3id.org/okn/o/sd#SampleExecution) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the SampleExecution to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the SampleExecution to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SampleExecution' + $ref: "#/components/schemas/SampleExecution" description: Gets the details of a given SampleExecution summary: Get a single SampleExecution by its id tags: - - SampleExecution + - SampleExecution put: description: Updates an existing SampleExecution (more information in https://w3id.org/okn/o/sd#SampleExecution) parameters: - - description: The ID of the SampleExecution to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SampleExecution to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SampleExecution' + $ref: "#/components/schemas/SampleExecution" description: An old SampleExecutionto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SampleExecution' + $ref: "#/components/schemas/SampleExecution" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing SampleExecution tags: - - SampleExecution + - SampleExecution /sampleresources: get: - description: Gets a list of all instances of SampleResource (more information + description: + Gets a list of all instances of SampleResource (more information in https://w3id.org/okn/o/sd#SampleResource) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of SampleResource. summary: List all instances of SampleResource tags: - - SampleResource + - SampleResource post: description: Create a new instance of SampleResource (more information in https://w3id.org/okn/o/sd#SampleResource) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" description: Information about the SampleResourceto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one SampleResource tags: - - SampleResource + - SampleResource /sampleresources/{id}: delete: description: Delete an existing SampleResource (more information in https://w3id.org/okn/o/sd#SampleResource) parameters: - - description: The ID of the SampleResource to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SampleResource to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing SampleResource tags: - - SampleResource + - SampleResource get: - description: Gets the details of a given SampleResource (more information in + description: + Gets the details of a given SampleResource (more information in https://w3id.org/okn/o/sd#SampleResource) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the SampleResource to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the SampleResource to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" description: Gets the details of a given SampleResource summary: Get a single SampleResource by its id tags: - - SampleResource + - SampleResource put: description: Updates an existing SampleResource (more information in https://w3id.org/okn/o/sd#SampleResource) parameters: - - description: The ID of the SampleResource to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SampleResource to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" description: An old SampleResourceto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing SampleResource tags: - - SampleResource + - SampleResource /softwares: get: description: Gets a list of all instances of Software (more information in https://w3id.org/okn/o/sd#Software) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Software. summary: List all instances of Software tags: - - Software + - Software post: description: Create a new instance of Software (more information in https://w3id.org/okn/o/sd#Software) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" description: Information about the Softwareto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Software tags: - - Software + - Software /softwares/{id}: delete: description: Delete an existing Software (more information in https://w3id.org/okn/o/sd#Software) parameters: - - description: The ID of the Software to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Software to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Software tags: - - Software + - Software get: description: Gets the details of a given Software (more information in https://w3id.org/okn/o/sd#Software) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Software to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Software to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" description: Gets the details of a given Software summary: Get a single Software by its id tags: - - Software + - Software put: description: Updates an existing Software (more information in https://w3id.org/okn/o/sd#Software) parameters: - - description: The ID of the Software to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Software to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" description: An old Softwareto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Software tags: - - Software + - Software /softwareconfigurations: get: - description: Gets a list of all instances of SoftwareConfiguration (more information + description: + Gets a list of all instances of SoftwareConfiguration (more information in https://w3id.org/okn/o/sd#SoftwareConfiguration) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/SoftwareConfiguration' + $ref: "#/components/schemas/SoftwareConfiguration" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of SoftwareConfiguration. summary: List all instances of SoftwareConfiguration tags: - - SoftwareConfiguration + - SoftwareConfiguration post: - description: Create a new instance of SoftwareConfiguration (more information + description: + Create a new instance of SoftwareConfiguration (more information in https://w3id.org/okn/o/sd#SoftwareConfiguration) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SoftwareConfiguration' + $ref: "#/components/schemas/SoftwareConfiguration" description: Information about the SoftwareConfigurationto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SoftwareConfiguration' + $ref: "#/components/schemas/SoftwareConfiguration" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one SoftwareConfiguration tags: - - SoftwareConfiguration + - SoftwareConfiguration /softwareconfigurations/{id}: delete: description: Delete an existing SoftwareConfiguration (more information in https://w3id.org/okn/o/sd#SoftwareConfiguration) parameters: - - description: The ID of the SoftwareConfiguration to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SoftwareConfiguration to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing SoftwareConfiguration tags: - - SoftwareConfiguration + - SoftwareConfiguration get: - description: Gets the details of a given SoftwareConfiguration (more information + description: + Gets the details of a given SoftwareConfiguration (more information in https://w3id.org/okn/o/sd#SoftwareConfiguration) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the SoftwareConfiguration to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the SoftwareConfiguration to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SoftwareConfiguration' + $ref: "#/components/schemas/SoftwareConfiguration" description: Gets the details of a given SoftwareConfiguration summary: Get a single SoftwareConfiguration by its id tags: - - SoftwareConfiguration + - SoftwareConfiguration put: - description: Updates an existing SoftwareConfiguration (more information in + description: + Updates an existing SoftwareConfiguration (more information in https://w3id.org/okn/o/sd#SoftwareConfiguration) parameters: - - description: The ID of the SoftwareConfiguration to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SoftwareConfiguration to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SoftwareConfiguration' + $ref: "#/components/schemas/SoftwareConfiguration" description: An old SoftwareConfigurationto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SoftwareConfiguration' + $ref: "#/components/schemas/SoftwareConfiguration" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing SoftwareConfiguration tags: - - SoftwareConfiguration + - SoftwareConfiguration /softwareimages: get: - description: Gets a list of all instances of SoftwareImage (more information + description: + Gets a list of all instances of SoftwareImage (more information in https://w3id.org/okn/o/sd#SoftwareImage) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/SoftwareImage' + $ref: "#/components/schemas/SoftwareImage" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of SoftwareImage. summary: List all instances of SoftwareImage tags: - - SoftwareImage + - SoftwareImage post: description: Create a new instance of SoftwareImage (more information in https://w3id.org/okn/o/sd#SoftwareImage) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SoftwareImage' + $ref: "#/components/schemas/SoftwareImage" description: Information about the SoftwareImageto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SoftwareImage' + $ref: "#/components/schemas/SoftwareImage" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one SoftwareImage tags: - - SoftwareImage + - SoftwareImage /softwareimages/{id}: delete: description: Delete an existing SoftwareImage (more information in https://w3id.org/okn/o/sd#SoftwareImage) parameters: - - description: The ID of the SoftwareImage to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SoftwareImage to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing SoftwareImage tags: - - SoftwareImage + - SoftwareImage get: - description: Gets the details of a given SoftwareImage (more information in + description: + Gets the details of a given SoftwareImage (more information in https://w3id.org/okn/o/sd#SoftwareImage) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the SoftwareImage to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the SoftwareImage to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SoftwareImage' + $ref: "#/components/schemas/SoftwareImage" description: Gets the details of a given SoftwareImage summary: Get a single SoftwareImage by its id tags: - - SoftwareImage + - SoftwareImage put: description: Updates an existing SoftwareImage (more information in https://w3id.org/okn/o/sd#SoftwareImage) parameters: - - description: The ID of the SoftwareImage to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SoftwareImage to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SoftwareImage' + $ref: "#/components/schemas/SoftwareImage" description: An old SoftwareImageto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SoftwareImage' + $ref: "#/components/schemas/SoftwareImage" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing SoftwareImage tags: - - SoftwareImage + - SoftwareImage /softwareversions: get: - description: Gets a list of all instances of SoftwareVersion (more information + description: + Gets a list of all instances of SoftwareVersion (more information in https://w3id.org/okn/o/sd#SoftwareVersion) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of SoftwareVersion. summary: List all instances of SoftwareVersion tags: - - SoftwareVersion + - SoftwareVersion post: description: Create a new instance of SoftwareVersion (more information in https://w3id.org/okn/o/sd#SoftwareVersion) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" description: Information about the SoftwareVersionto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one SoftwareVersion tags: - - SoftwareVersion + - SoftwareVersion /softwareversions/{id}: delete: description: Delete an existing SoftwareVersion (more information in https://w3id.org/okn/o/sd#SoftwareVersion) parameters: - - description: The ID of the SoftwareVersion to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SoftwareVersion to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing SoftwareVersion tags: - - SoftwareVersion + - SoftwareVersion get: - description: Gets the details of a given SoftwareVersion (more information in + description: + Gets the details of a given SoftwareVersion (more information in https://w3id.org/okn/o/sd#SoftwareVersion) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the SoftwareVersion to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the SoftwareVersion to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" description: Gets the details of a given SoftwareVersion summary: Get a single SoftwareVersion by its id tags: - - SoftwareVersion + - SoftwareVersion put: description: Updates an existing SoftwareVersion (more information in https://w3id.org/okn/o/sd#SoftwareVersion) parameters: - - description: The ID of the SoftwareVersion to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SoftwareVersion to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" description: An old SoftwareVersionto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing SoftwareVersion tags: - - SoftwareVersion + - SoftwareVersion /sourcecodes: get: - description: Gets a list of all instances of SourceCode (more information in + description: + Gets a list of all instances of SourceCode (more information in https://w3id.org/okn/o/sd#SourceCode) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of SourceCode. summary: List all instances of SourceCode tags: - - SourceCode + - SourceCode post: description: Create a new instance of SourceCode (more information in https://w3id.org/okn/o/sd#SourceCode) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" description: Information about the SourceCodeto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one SourceCode tags: - - SourceCode + - SourceCode /sourcecodes/{id}: delete: description: Delete an existing SourceCode (more information in https://w3id.org/okn/o/sd#SourceCode) parameters: - - description: The ID of the SourceCode to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SourceCode to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing SourceCode tags: - - SourceCode + - SourceCode get: description: Gets the details of a given SourceCode (more information in https://w3id.org/okn/o/sd#SourceCode) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the SourceCode to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the SourceCode to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" description: Gets the details of a given SourceCode summary: Get a single SourceCode by its id tags: - - SourceCode + - SourceCode put: description: Updates an existing SourceCode (more information in https://w3id.org/okn/o/sd#SourceCode) parameters: - - description: The ID of the SourceCode to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SourceCode to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" description: An old SourceCodeto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing SourceCode tags: - - SourceCode + - SourceCode /standardvariables: get: - description: Gets a list of all instances of StandardVariable (more information + description: + Gets a list of all instances of StandardVariable (more information in https://w3id.org/okn/o/sd#StandardVariable) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/StandardVariable' + $ref: "#/components/schemas/StandardVariable" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of StandardVariable. summary: List all instances of StandardVariable tags: - - StandardVariable + - StandardVariable post: - description: Create a new instance of StandardVariable (more information in + description: + Create a new instance of StandardVariable (more information in https://w3id.org/okn/o/sd#StandardVariable) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/StandardVariable' + $ref: "#/components/schemas/StandardVariable" description: Information about the StandardVariableto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/StandardVariable' + $ref: "#/components/schemas/StandardVariable" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one StandardVariable tags: - - StandardVariable + - StandardVariable /standardvariables/{id}: delete: description: Delete an existing StandardVariable (more information in https://w3id.org/okn/o/sd#StandardVariable) parameters: - - description: The ID of the StandardVariable to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the StandardVariable to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing StandardVariable tags: - - StandardVariable + - StandardVariable get: - description: Gets the details of a given StandardVariable (more information + description: + Gets the details of a given StandardVariable (more information in https://w3id.org/okn/o/sd#StandardVariable) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the StandardVariable to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the StandardVariable to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/StandardVariable' + $ref: "#/components/schemas/StandardVariable" description: Gets the details of a given StandardVariable summary: Get a single StandardVariable by its id tags: - - StandardVariable + - StandardVariable put: description: Updates an existing StandardVariable (more information in https://w3id.org/okn/o/sd#StandardVariable) parameters: - - description: The ID of the StandardVariable to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the StandardVariable to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/StandardVariable' + $ref: "#/components/schemas/StandardVariable" description: An old StandardVariableto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/StandardVariable' + $ref: "#/components/schemas/StandardVariable" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing StandardVariable tags: - - StandardVariable + - StandardVariable /units: get: description: Gets a list of all instances of Unit (more information in https://w3id.org/okn/o/sd#Unit) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Unit' + $ref: "#/components/schemas/Unit" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Unit. summary: List all instances of Unit tags: - - Unit + - Unit post: description: Create a new instance of Unit (more information in https://w3id.org/okn/o/sd#Unit) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Unit' + $ref: "#/components/schemas/Unit" description: Information about the Unitto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Unit' + $ref: "#/components/schemas/Unit" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Unit tags: - - Unit + - Unit /units/{id}: delete: description: Delete an existing Unit (more information in https://w3id.org/okn/o/sd#Unit) parameters: - - description: The ID of the Unit to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Unit to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Unit tags: - - Unit + - Unit get: description: Gets the details of a given Unit (more information in https://w3id.org/okn/o/sd#Unit) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Unit to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Unit to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Unit' + $ref: "#/components/schemas/Unit" description: Gets the details of a given Unit summary: Get a single Unit by its id tags: - - Unit + - Unit put: description: Updates an existing Unit (more information in https://w3id.org/okn/o/sd#Unit) parameters: - - description: The ID of the Unit to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Unit to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Unit' + $ref: "#/components/schemas/Unit" description: An old Unitto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Unit' + $ref: "#/components/schemas/Unit" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Unit tags: - - Unit + - Unit /variables: get: description: Gets a list of all instances of Variable (more information in https://w3id.org/okn/o/sd#Variable) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Variable' + $ref: "#/components/schemas/Variable" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Variable. summary: List all instances of Variable tags: - - Variable + - Variable post: description: Create a new instance of Variable (more information in https://w3id.org/okn/o/sd#Variable) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Variable' + $ref: "#/components/schemas/Variable" description: Information about the Variableto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Variable' + $ref: "#/components/schemas/Variable" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Variable tags: - - Variable + - Variable /variables/{id}: delete: description: Delete an existing Variable (more information in https://w3id.org/okn/o/sd#Variable) parameters: - - description: The ID of the Variable to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Variable to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Variable tags: - - Variable + - Variable get: description: Gets the details of a given Variable (more information in https://w3id.org/okn/o/sd#Variable) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Variable to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Variable to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Variable' + $ref: "#/components/schemas/Variable" description: Gets the details of a given Variable summary: Get a single Variable by its id tags: - - Variable + - Variable put: description: Updates an existing Variable (more information in https://w3id.org/okn/o/sd#Variable) parameters: - - description: The ID of the Variable to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Variable to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Variable' + $ref: "#/components/schemas/Variable" description: An old Variableto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Variable' + $ref: "#/components/schemas/Variable" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Variable tags: - - Variable + - Variable /variablepresentations: get: - description: Gets a list of all instances of VariablePresentation (more information + description: + Gets a list of all instances of VariablePresentation (more information in https://w3id.org/okn/o/sd#VariablePresentation) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of VariablePresentation. summary: List all instances of VariablePresentation tags: - - VariablePresentation + - VariablePresentation post: - description: Create a new instance of VariablePresentation (more information + description: + Create a new instance of VariablePresentation (more information in https://w3id.org/okn/o/sd#VariablePresentation) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" description: Information about the VariablePresentationto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one VariablePresentation tags: - - VariablePresentation + - VariablePresentation /variablepresentations/{id}: delete: description: Delete an existing VariablePresentation (more information in https://w3id.org/okn/o/sd#VariablePresentation) parameters: - - description: The ID of the VariablePresentation to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the VariablePresentation to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing VariablePresentation tags: - - VariablePresentation + - VariablePresentation get: - description: Gets the details of a given VariablePresentation (more information + description: + Gets the details of a given VariablePresentation (more information in https://w3id.org/okn/o/sd#VariablePresentation) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the VariablePresentation to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the VariablePresentation to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" description: Gets the details of a given VariablePresentation summary: Get a single VariablePresentation by its id tags: - - VariablePresentation + - VariablePresentation put: description: Updates an existing VariablePresentation (more information in https://w3id.org/okn/o/sd#VariablePresentation) parameters: - - description: The ID of the VariablePresentation to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the VariablePresentation to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" description: An old VariablePresentationto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing VariablePresentation tags: - - VariablePresentation + - VariablePresentation /visualizations: get: - description: Gets a list of all instances of Visualization (more information + description: + Gets a list of all instances of Visualization (more information in https://w3id.org/okn/o/sd#Visualization) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Visualization. summary: List all instances of Visualization tags: - - Visualization + - Visualization post: description: Create a new instance of Visualization (more information in https://w3id.org/okn/o/sd#Visualization) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" description: Information about the Visualizationto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Visualization tags: - - Visualization + - Visualization /visualizations/{id}: delete: description: Delete an existing Visualization (more information in https://w3id.org/okn/o/sd#Visualization) parameters: - - description: The ID of the Visualization to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Visualization to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Visualization tags: - - Visualization + - Visualization get: - description: Gets the details of a given Visualization (more information in + description: + Gets the details of a given Visualization (more information in https://w3id.org/okn/o/sd#Visualization) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Visualization to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Visualization to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" description: Gets the details of a given Visualization summary: Get a single Visualization by its id tags: - - Visualization + - Visualization put: description: Updates an existing Visualization (more information in https://w3id.org/okn/o/sd#Visualization) parameters: - - description: The ID of the Visualization to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Visualization to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" description: An old Visualizationto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Visualization tags: - - Visualization + - Visualization /causaldiagrams: get: - description: Gets a list of all instances of CausalDiagram (more information + description: + Gets a list of all instances of CausalDiagram (more information in https://w3id.org/okn/o/sdm#CausalDiagram) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/CausalDiagram' + $ref: "#/components/schemas/CausalDiagram" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of CausalDiagram. summary: List all instances of CausalDiagram tags: - - CausalDiagram + - CausalDiagram post: description: Create a new instance of CausalDiagram (more information in https://w3id.org/okn/o/sdm#CausalDiagram) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/CausalDiagram' + $ref: "#/components/schemas/CausalDiagram" description: Information about the CausalDiagramto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CausalDiagram' + $ref: "#/components/schemas/CausalDiagram" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one CausalDiagram tags: - - CausalDiagram + - CausalDiagram /causaldiagrams/{id}: delete: description: Delete an existing CausalDiagram (more information in https://w3id.org/okn/o/sdm#CausalDiagram) parameters: - - description: The ID of the CausalDiagram to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the CausalDiagram to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing CausalDiagram tags: - - CausalDiagram + - CausalDiagram get: - description: Gets the details of a given CausalDiagram (more information in + description: + Gets the details of a given CausalDiagram (more information in https://w3id.org/okn/o/sdm#CausalDiagram) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the CausalDiagram to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the CausalDiagram to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CausalDiagram' + $ref: "#/components/schemas/CausalDiagram" description: Gets the details of a given CausalDiagram summary: Get a single CausalDiagram by its id tags: - - CausalDiagram + - CausalDiagram put: description: Updates an existing CausalDiagram (more information in https://w3id.org/okn/o/sdm#CausalDiagram) parameters: - - description: The ID of the CausalDiagram to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the CausalDiagram to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/CausalDiagram' + $ref: "#/components/schemas/CausalDiagram" description: An old CausalDiagramto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CausalDiagram' + $ref: "#/components/schemas/CausalDiagram" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing CausalDiagram tags: - - CausalDiagram + - CausalDiagram /coupledmodels: get: - description: Gets a list of all instances of CoupledModel (more information + description: + Gets a list of all instances of CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/CoupledModel' + $ref: "#/components/schemas/CoupledModel" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of CoupledModel. summary: List all instances of CoupledModel tags: - - CoupledModel + - CoupledModel post: description: Create a new instance of CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/CoupledModel' + $ref: "#/components/schemas/CoupledModel" description: Information about the CoupledModelto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CoupledModel' + $ref: "#/components/schemas/CoupledModel" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one CoupledModel tags: - - CoupledModel + - CoupledModel /coupledmodels/{id}: delete: description: Delete an existing CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) parameters: - - description: The ID of the CoupledModel to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the CoupledModel to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing CoupledModel tags: - - CoupledModel + - CoupledModel get: description: Gets the details of a given CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the CoupledModel to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the CoupledModel to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CoupledModel' + $ref: "#/components/schemas/CoupledModel" description: Gets the details of a given CoupledModel summary: Get a single CoupledModel by its id tags: - - CoupledModel + - CoupledModel put: description: Updates an existing CoupledModel (more information in https://w3id.org/okn/o/sdm#CoupledModel) parameters: - - description: The ID of the CoupledModel to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the CoupledModel to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/CoupledModel' + $ref: "#/components/schemas/CoupledModel" description: An old CoupledModelto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CoupledModel' + $ref: "#/components/schemas/CoupledModel" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing CoupledModel tags: - - CoupledModel + - CoupledModel /empiricalmodels: get: - description: Gets a list of all instances of EmpiricalModel (more information + description: + Gets a list of all instances of EmpiricalModel (more information in https://w3id.org/okn/o/sdm#EmpiricalModel) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/EmpiricalModel' + $ref: "#/components/schemas/EmpiricalModel" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of EmpiricalModel. summary: List all instances of EmpiricalModel tags: - - EmpiricalModel + - EmpiricalModel post: description: Create a new instance of EmpiricalModel (more information in https://w3id.org/okn/o/sdm#EmpiricalModel) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/EmpiricalModel' + $ref: "#/components/schemas/EmpiricalModel" description: Information about the EmpiricalModelto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/EmpiricalModel' + $ref: "#/components/schemas/EmpiricalModel" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one EmpiricalModel tags: - - EmpiricalModel + - EmpiricalModel /empiricalmodels/{id}: delete: description: Delete an existing EmpiricalModel (more information in https://w3id.org/okn/o/sdm#EmpiricalModel) parameters: - - description: The ID of the EmpiricalModel to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the EmpiricalModel to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing EmpiricalModel tags: - - EmpiricalModel + - EmpiricalModel get: - description: Gets the details of a given EmpiricalModel (more information in + description: + Gets the details of a given EmpiricalModel (more information in https://w3id.org/okn/o/sdm#EmpiricalModel) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the EmpiricalModel to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the EmpiricalModel to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/EmpiricalModel' + $ref: "#/components/schemas/EmpiricalModel" description: Gets the details of a given EmpiricalModel summary: Get a single EmpiricalModel by its id tags: - - EmpiricalModel + - EmpiricalModel put: description: Updates an existing EmpiricalModel (more information in https://w3id.org/okn/o/sdm#EmpiricalModel) parameters: - - description: The ID of the EmpiricalModel to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the EmpiricalModel to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/EmpiricalModel' + $ref: "#/components/schemas/EmpiricalModel" description: An old EmpiricalModelto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/EmpiricalModel' + $ref: "#/components/schemas/EmpiricalModel" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing EmpiricalModel tags: - - EmpiricalModel + - EmpiricalModel /emulators: get: description: Gets a list of all instances of Emulator (more information in https://w3id.org/okn/o/sdm#Emulator) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Emulator' + $ref: "#/components/schemas/Emulator" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Emulator. summary: List all instances of Emulator tags: - - Emulator + - Emulator post: description: Create a new instance of Emulator (more information in https://w3id.org/okn/o/sdm#Emulator) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Emulator' + $ref: "#/components/schemas/Emulator" description: Information about the Emulatorto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Emulator' + $ref: "#/components/schemas/Emulator" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Emulator tags: - - Emulator + - Emulator /emulators/{id}: delete: description: Delete an existing Emulator (more information in https://w3id.org/okn/o/sdm#Emulator) parameters: - - description: The ID of the Emulator to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Emulator to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Emulator tags: - - Emulator + - Emulator get: description: Gets the details of a given Emulator (more information in https://w3id.org/okn/o/sdm#Emulator) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Emulator to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Emulator to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Emulator' + $ref: "#/components/schemas/Emulator" description: Gets the details of a given Emulator summary: Get a single Emulator by its id tags: - - Emulator + - Emulator put: description: Updates an existing Emulator (more information in https://w3id.org/okn/o/sdm#Emulator) parameters: - - description: The ID of the Emulator to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Emulator to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Emulator' + $ref: "#/components/schemas/Emulator" description: An old Emulatorto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Emulator' + $ref: "#/components/schemas/Emulator" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Emulator tags: - - Emulator + - Emulator /equations: get: description: Gets a list of all instances of Equation (more information in https://w3id.org/okn/o/sdm#Equation) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Equation. summary: List all instances of Equation tags: - - Equation + - Equation post: description: Create a new instance of Equation (more information in https://w3id.org/okn/o/sdm#Equation) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" description: Information about the Equationto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Equation tags: - - Equation + - Equation /equations/{id}: delete: description: Delete an existing Equation (more information in https://w3id.org/okn/o/sdm#Equation) parameters: - - description: The ID of the Equation to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Equation to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Equation tags: - - Equation + - Equation get: description: Gets the details of a given Equation (more information in https://w3id.org/okn/o/sdm#Equation) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Equation to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Equation to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" description: Gets the details of a given Equation summary: Get a single Equation by its id tags: - - Equation + - Equation put: description: Updates an existing Equation (more information in https://w3id.org/okn/o/sdm#Equation) parameters: - - description: The ID of the Equation to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Equation to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" description: An old Equationto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Equation tags: - - Equation + - Equation /geocoordinatess: get: - description: Gets a list of all instances of GeoCoordinates (more information + description: + Gets a list of all instances of GeoCoordinates (more information in https://w3id.org/okn/o/sdm#GeoCoordinates) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/GeoCoordinates' + $ref: "#/components/schemas/GeoCoordinates" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of GeoCoordinates. summary: List all instances of GeoCoordinates tags: - - GeoCoordinates + - GeoCoordinates post: description: Create a new instance of GeoCoordinates (more information in https://w3id.org/okn/o/sdm#GeoCoordinates) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/GeoCoordinates' + $ref: "#/components/schemas/GeoCoordinates" description: Information about the GeoCoordinatesto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/GeoCoordinates' + $ref: "#/components/schemas/GeoCoordinates" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one GeoCoordinates tags: - - GeoCoordinates + - GeoCoordinates /geocoordinatess/{id}: delete: description: Delete an existing GeoCoordinates (more information in https://w3id.org/okn/o/sdm#GeoCoordinates) parameters: - - description: The ID of the GeoCoordinates to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the GeoCoordinates to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing GeoCoordinates tags: - - GeoCoordinates + - GeoCoordinates get: - description: Gets the details of a given GeoCoordinates (more information in + description: + Gets the details of a given GeoCoordinates (more information in https://w3id.org/okn/o/sdm#GeoCoordinates) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the GeoCoordinates to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the GeoCoordinates to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GeoCoordinates' + $ref: "#/components/schemas/GeoCoordinates" description: Gets the details of a given GeoCoordinates summary: Get a single GeoCoordinates by its id tags: - - GeoCoordinates + - GeoCoordinates put: description: Updates an existing GeoCoordinates (more information in https://w3id.org/okn/o/sdm#GeoCoordinates) parameters: - - description: The ID of the GeoCoordinates to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the GeoCoordinates to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/GeoCoordinates' + $ref: "#/components/schemas/GeoCoordinates" description: An old GeoCoordinatesto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GeoCoordinates' + $ref: "#/components/schemas/GeoCoordinates" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing GeoCoordinates tags: - - GeoCoordinates + - GeoCoordinates /geoshapes: get: description: Gets a list of all instances of GeoShape (more information in https://w3id.org/okn/o/sdm#GeoShape) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/GeoShape' + $ref: "#/components/schemas/GeoShape" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of GeoShape. summary: List all instances of GeoShape tags: - - GeoShape + - GeoShape post: description: Create a new instance of GeoShape (more information in https://w3id.org/okn/o/sdm#GeoShape) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/GeoShape' + $ref: "#/components/schemas/GeoShape" description: Information about the GeoShapeto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/GeoShape' + $ref: "#/components/schemas/GeoShape" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one GeoShape tags: - - GeoShape + - GeoShape /geoshapes/{id}: delete: description: Delete an existing GeoShape (more information in https://w3id.org/okn/o/sdm#GeoShape) parameters: - - description: The ID of the GeoShape to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the GeoShape to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing GeoShape tags: - - GeoShape + - GeoShape get: description: Gets the details of a given GeoShape (more information in https://w3id.org/okn/o/sdm#GeoShape) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the GeoShape to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the GeoShape to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GeoShape' + $ref: "#/components/schemas/GeoShape" description: Gets the details of a given GeoShape summary: Get a single GeoShape by its id tags: - - GeoShape + - GeoShape put: description: Updates an existing GeoShape (more information in https://w3id.org/okn/o/sdm#GeoShape) parameters: - - description: The ID of the GeoShape to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the GeoShape to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/GeoShape' + $ref: "#/components/schemas/GeoShape" description: An old GeoShapeto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GeoShape' + $ref: "#/components/schemas/GeoShape" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing GeoShape tags: - - GeoShape + - GeoShape /grids: get: description: Gets a list of all instances of Grid (more information in https://w3id.org/okn/o/sdm#Grid) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Grid. summary: List all instances of Grid tags: - - Grid + - Grid post: description: Create a new instance of Grid (more information in https://w3id.org/okn/o/sdm#Grid) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" description: Information about the Gridto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Grid tags: - - Grid + - Grid /grids/{id}: delete: description: Delete an existing Grid (more information in https://w3id.org/okn/o/sdm#Grid) parameters: - - description: The ID of the Grid to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Grid to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Grid tags: - - Grid + - Grid get: description: Gets the details of a given Grid (more information in https://w3id.org/okn/o/sdm#Grid) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Grid to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Grid to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" description: Gets the details of a given Grid summary: Get a single Grid by its id tags: - - Grid + - Grid put: description: Updates an existing Grid (more information in https://w3id.org/okn/o/sdm#Grid) parameters: - - description: The ID of the Grid to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Grid to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" description: An old Gridto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Grid tags: - - Grid + - Grid /hybridmodels: get: - description: Gets a list of all instances of HybridModel (more information in + description: + Gets a list of all instances of HybridModel (more information in https://w3id.org/okn/o/sdm#HybridModel) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/HybridModel' + $ref: "#/components/schemas/HybridModel" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of HybridModel. summary: List all instances of HybridModel tags: - - HybridModel + - HybridModel post: description: Create a new instance of HybridModel (more information in https://w3id.org/okn/o/sdm#HybridModel) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/HybridModel' + $ref: "#/components/schemas/HybridModel" description: Information about the HybridModelto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/HybridModel' + $ref: "#/components/schemas/HybridModel" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one HybridModel tags: - - HybridModel + - HybridModel /hybridmodels/{id}: delete: description: Delete an existing HybridModel (more information in https://w3id.org/okn/o/sdm#HybridModel) parameters: - - description: The ID of the HybridModel to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the HybridModel to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing HybridModel tags: - - HybridModel + - HybridModel get: description: Gets the details of a given HybridModel (more information in https://w3id.org/okn/o/sdm#HybridModel) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the HybridModel to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the HybridModel to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/HybridModel' + $ref: "#/components/schemas/HybridModel" description: Gets the details of a given HybridModel summary: Get a single HybridModel by its id tags: - - HybridModel + - HybridModel put: description: Updates an existing HybridModel (more information in https://w3id.org/okn/o/sdm#HybridModel) parameters: - - description: The ID of the HybridModel to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the HybridModel to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/HybridModel' + $ref: "#/components/schemas/HybridModel" description: An old HybridModelto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/HybridModel' + $ref: "#/components/schemas/HybridModel" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing HybridModel tags: - - HybridModel + - HybridModel /interventions: get: - description: Gets a list of all instances of Intervention (more information + description: + Gets a list of all instances of Intervention (more information in https://w3id.org/okn/o/sdm#Intervention) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Intervention' + $ref: "#/components/schemas/Intervention" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Intervention. summary: List all instances of Intervention tags: - - Intervention + - Intervention post: description: Create a new instance of Intervention (more information in https://w3id.org/okn/o/sdm#Intervention) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Intervention' + $ref: "#/components/schemas/Intervention" description: Information about the Interventionto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Intervention' + $ref: "#/components/schemas/Intervention" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Intervention tags: - - Intervention + - Intervention /interventions/{id}: delete: description: Delete an existing Intervention (more information in https://w3id.org/okn/o/sdm#Intervention) parameters: - - description: The ID of the Intervention to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Intervention to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Intervention tags: - - Intervention + - Intervention get: description: Gets the details of a given Intervention (more information in https://w3id.org/okn/o/sdm#Intervention) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Intervention to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Intervention to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Intervention' + $ref: "#/components/schemas/Intervention" description: Gets the details of a given Intervention summary: Get a single Intervention by its id tags: - - Intervention + - Intervention put: description: Updates an existing Intervention (more information in https://w3id.org/okn/o/sdm#Intervention) parameters: - - description: The ID of the Intervention to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Intervention to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Intervention' + $ref: "#/components/schemas/Intervention" description: An old Interventionto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Intervention' + $ref: "#/components/schemas/Intervention" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Intervention tags: - - Intervention + - Intervention /models: get: description: Gets a list of all instances of Model (more information in https://w3id.org/okn/o/sdm#Model) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Model' + $ref: "#/components/schemas/Model" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Model. summary: List all instances of Model tags: - - Model + - Model post: description: Create a new instance of Model (more information in https://w3id.org/okn/o/sdm#Model) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Model' + $ref: "#/components/schemas/Model" description: Information about the Modelto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Model' + $ref: "#/components/schemas/Model" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Model tags: - - Model + - Model /models/{id}: delete: description: Delete an existing Model (more information in https://w3id.org/okn/o/sdm#Model) parameters: - - description: The ID of the Model to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Model to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Model tags: - - Model + - Model get: description: Gets the details of a given Model (more information in https://w3id.org/okn/o/sdm#Model) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Model to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Model to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Model' + $ref: "#/components/schemas/Model" description: Gets the details of a given Model summary: Get a single Model by its id tags: - - Model + - Model put: description: Updates an existing Model (more information in https://w3id.org/okn/o/sdm#Model) parameters: - - description: The ID of the Model to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Model to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Model' + $ref: "#/components/schemas/Model" description: An old Modelto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Model' + $ref: "#/components/schemas/Model" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Model tags: - - Model + - Model /modelcategorys: get: - description: Gets a list of all instances of ModelCategory (more information + description: + Gets a list of all instances of ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of ModelCategory. summary: List all instances of ModelCategory tags: - - ModelCategory + - ModelCategory post: description: Create a new instance of ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" description: Information about the ModelCategoryto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one ModelCategory tags: - - ModelCategory + - ModelCategory /modelcategorys/{id}: delete: description: Delete an existing ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) parameters: - - description: The ID of the ModelCategory to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the ModelCategory to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing ModelCategory tags: - - ModelCategory + - ModelCategory get: - description: Gets the details of a given ModelCategory (more information in + description: + Gets the details of a given ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the ModelCategory to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the ModelCategory to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" description: Gets the details of a given ModelCategory summary: Get a single ModelCategory by its id tags: - - ModelCategory + - ModelCategory put: description: Updates an existing ModelCategory (more information in https://w3id.org/okn/o/sdm#ModelCategory) parameters: - - description: The ID of the ModelCategory to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the ModelCategory to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" description: An old ModelCategoryto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing ModelCategory tags: - - ModelCategory + - ModelCategory /modelconfigurations: get: - description: Gets a list of all instances of ModelConfiguration (more information + description: + Gets a list of all instances of ModelConfiguration (more information in https://w3id.org/okn/o/sdm#ModelConfiguration) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/ModelConfiguration' + $ref: "#/components/schemas/ModelConfiguration" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of ModelConfiguration. summary: List all instances of ModelConfiguration tags: - - ModelConfiguration + - ModelConfiguration post: - description: Create a new instance of ModelConfiguration (more information in + description: + Create a new instance of ModelConfiguration (more information in https://w3id.org/okn/o/sdm#ModelConfiguration) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/ModelConfiguration' + $ref: "#/components/schemas/ModelConfiguration" description: Information about the ModelConfigurationto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ModelConfiguration' + $ref: "#/components/schemas/ModelConfiguration" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one ModelConfiguration tags: - - ModelConfiguration + - ModelConfiguration /modelconfigurations/{id}: delete: description: Delete an existing ModelConfiguration (more information in https://w3id.org/okn/o/sdm#ModelConfiguration) parameters: - - description: The ID of the ModelConfiguration to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the ModelConfiguration to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing ModelConfiguration tags: - - ModelConfiguration + - ModelConfiguration get: - description: Gets the details of a given ModelConfiguration (more information + description: + Gets the details of a given ModelConfiguration (more information in https://w3id.org/okn/o/sdm#ModelConfiguration) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the ModelConfiguration to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the ModelConfiguration to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ModelConfiguration' + $ref: "#/components/schemas/ModelConfiguration" description: Gets the details of a given ModelConfiguration summary: Get a single ModelConfiguration by its id tags: - - ModelConfiguration + - ModelConfiguration put: description: Updates an existing ModelConfiguration (more information in https://w3id.org/okn/o/sdm#ModelConfiguration) parameters: - - description: The ID of the ModelConfiguration to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the ModelConfiguration to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/ModelConfiguration' + $ref: "#/components/schemas/ModelConfiguration" description: An old ModelConfigurationto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ModelConfiguration' + $ref: "#/components/schemas/ModelConfiguration" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing ModelConfiguration tags: - - ModelConfiguration + - ModelConfiguration /modelconfigurationsetups: get: - description: Gets a list of all instances of ModelConfigurationSetup (more information + description: + Gets a list of all instances of ModelConfigurationSetup (more information in https://w3id.org/okn/o/sdm#ModelConfigurationSetup) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/ModelConfigurationSetup' + $ref: "#/components/schemas/ModelConfigurationSetup" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of ModelConfigurationSetup. summary: List all instances of ModelConfigurationSetup tags: - - ModelConfigurationSetup + - ModelConfigurationSetup post: - description: Create a new instance of ModelConfigurationSetup (more information + description: + Create a new instance of ModelConfigurationSetup (more information in https://w3id.org/okn/o/sdm#ModelConfigurationSetup) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/ModelConfigurationSetup' + $ref: "#/components/schemas/ModelConfigurationSetup" description: Information about the ModelConfigurationSetupto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ModelConfigurationSetup' + $ref: "#/components/schemas/ModelConfigurationSetup" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one ModelConfigurationSetup tags: - - ModelConfigurationSetup + - ModelConfigurationSetup /modelconfigurationsetups/{id}: delete: - description: Delete an existing ModelConfigurationSetup (more information in + description: + Delete an existing ModelConfigurationSetup (more information in https://w3id.org/okn/o/sdm#ModelConfigurationSetup) parameters: - - description: The ID of the ModelConfigurationSetup to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the ModelConfigurationSetup to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing ModelConfigurationSetup tags: - - ModelConfigurationSetup + - ModelConfigurationSetup get: - description: Gets the details of a given ModelConfigurationSetup (more information + description: + Gets the details of a given ModelConfigurationSetup (more information in https://w3id.org/okn/o/sdm#ModelConfigurationSetup) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the ModelConfigurationSetup to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the ModelConfigurationSetup to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ModelConfigurationSetup' + $ref: "#/components/schemas/ModelConfigurationSetup" description: Gets the details of a given ModelConfigurationSetup summary: Get a single ModelConfigurationSetup by its id tags: - - ModelConfigurationSetup + - ModelConfigurationSetup put: - description: Updates an existing ModelConfigurationSetup (more information in + description: + Updates an existing ModelConfigurationSetup (more information in https://w3id.org/okn/o/sdm#ModelConfigurationSetup) parameters: - - description: The ID of the ModelConfigurationSetup to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the ModelConfigurationSetup to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/ModelConfigurationSetup' + $ref: "#/components/schemas/ModelConfigurationSetup" description: An old ModelConfigurationSetupto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ModelConfigurationSetup' + $ref: "#/components/schemas/ModelConfigurationSetup" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing ModelConfigurationSetup tags: - - ModelConfigurationSetup + - ModelConfigurationSetup /pointbasedgrids: get: - description: Gets a list of all instances of PointBasedGrid (more information + description: + Gets a list of all instances of PointBasedGrid (more information in https://w3id.org/okn/o/sdm#PointBasedGrid) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/PointBasedGrid' + $ref: "#/components/schemas/PointBasedGrid" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of PointBasedGrid. summary: List all instances of PointBasedGrid tags: - - PointBasedGrid + - PointBasedGrid post: description: Create a new instance of PointBasedGrid (more information in https://w3id.org/okn/o/sdm#PointBasedGrid) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/PointBasedGrid' + $ref: "#/components/schemas/PointBasedGrid" description: Information about the PointBasedGridto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/PointBasedGrid' + $ref: "#/components/schemas/PointBasedGrid" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one PointBasedGrid tags: - - PointBasedGrid + - PointBasedGrid /pointbasedgrids/{id}: delete: description: Delete an existing PointBasedGrid (more information in https://w3id.org/okn/o/sdm#PointBasedGrid) parameters: - - description: The ID of the PointBasedGrid to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the PointBasedGrid to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing PointBasedGrid tags: - - PointBasedGrid + - PointBasedGrid get: - description: Gets the details of a given PointBasedGrid (more information in + description: + Gets the details of a given PointBasedGrid (more information in https://w3id.org/okn/o/sdm#PointBasedGrid) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the PointBasedGrid to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the PointBasedGrid to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/PointBasedGrid' + $ref: "#/components/schemas/PointBasedGrid" description: Gets the details of a given PointBasedGrid summary: Get a single PointBasedGrid by its id tags: - - PointBasedGrid + - PointBasedGrid put: description: Updates an existing PointBasedGrid (more information in https://w3id.org/okn/o/sdm#PointBasedGrid) parameters: - - description: The ID of the PointBasedGrid to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the PointBasedGrid to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/PointBasedGrid' + $ref: "#/components/schemas/PointBasedGrid" description: An old PointBasedGridto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/PointBasedGrid' + $ref: "#/components/schemas/PointBasedGrid" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing PointBasedGrid tags: - - PointBasedGrid + - PointBasedGrid /processs: get: description: Gets a list of all instances of Process (more information in https://w3id.org/okn/o/sdm#Process) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Process. summary: List all instances of Process tags: - - Process + - Process post: description: Create a new instance of Process (more information in https://w3id.org/okn/o/sdm#Process) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" description: Information about the Processto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Process tags: - - Process + - Process /processs/{id}: delete: description: Delete an existing Process (more information in https://w3id.org/okn/o/sdm#Process) parameters: - - description: The ID of the Process to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Process to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Process tags: - - Process + - Process get: description: Gets the details of a given Process (more information in https://w3id.org/okn/o/sdm#Process) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Process to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Process to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" description: Gets the details of a given Process summary: Get a single Process by its id tags: - - Process + - Process put: description: Updates an existing Process (more information in https://w3id.org/okn/o/sdm#Process) parameters: - - description: The ID of the Process to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Process to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" description: An old Processto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Process tags: - - Process + - Process /regions: get: description: Gets a list of all instances of Region (more information in https://w3id.org/okn/o/sdm#Region) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Region' + $ref: "#/components/schemas/Region" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Region. summary: List all instances of Region tags: - - Region + - Region post: description: Create a new instance of Region (more information in https://w3id.org/okn/o/sdm#Region) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Region' + $ref: "#/components/schemas/Region" description: Information about the Regionto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Region' + $ref: "#/components/schemas/Region" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Region tags: - - Region + - Region /regions/{id}: delete: description: Delete an existing Region (more information in https://w3id.org/okn/o/sdm#Region) parameters: - - description: The ID of the Region to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Region to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Region tags: - - Region + - Region get: description: Gets the details of a given Region (more information in https://w3id.org/okn/o/sdm#Region) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Region to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Region to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Region' + $ref: "#/components/schemas/Region" description: Gets the details of a given Region summary: Get a single Region by its id tags: - - Region + - Region put: description: Updates an existing Region (more information in https://w3id.org/okn/o/sdm#Region) parameters: - - description: The ID of the Region to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Region to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Region' + $ref: "#/components/schemas/Region" description: An old Regionto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Region' + $ref: "#/components/schemas/Region" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Region tags: - - Region + - Region /spatialresolutions: get: - description: Gets a list of all instances of SpatialResolution (more information + description: + Gets a list of all instances of SpatialResolution (more information in https://w3id.org/okn/o/sdm#SpatialResolution) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/SpatialResolution' + $ref: "#/components/schemas/SpatialResolution" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of SpatialResolution. summary: List all instances of SpatialResolution tags: - - SpatialResolution + - SpatialResolution post: - description: Create a new instance of SpatialResolution (more information in + description: + Create a new instance of SpatialResolution (more information in https://w3id.org/okn/o/sdm#SpatialResolution) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SpatialResolution' + $ref: "#/components/schemas/SpatialResolution" description: Information about the SpatialResolutionto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SpatialResolution' + $ref: "#/components/schemas/SpatialResolution" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one SpatialResolution tags: - - SpatialResolution + - SpatialResolution /spatialresolutions/{id}: delete: description: Delete an existing SpatialResolution (more information in https://w3id.org/okn/o/sdm#SpatialResolution) parameters: - - description: The ID of the SpatialResolution to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SpatialResolution to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing SpatialResolution tags: - - SpatialResolution + - SpatialResolution get: - description: Gets the details of a given SpatialResolution (more information + description: + Gets the details of a given SpatialResolution (more information in https://w3id.org/okn/o/sdm#SpatialResolution) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the SpatialResolution to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the SpatialResolution to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SpatialResolution' + $ref: "#/components/schemas/SpatialResolution" description: Gets the details of a given SpatialResolution summary: Get a single SpatialResolution by its id tags: - - SpatialResolution + - SpatialResolution put: description: Updates an existing SpatialResolution (more information in https://w3id.org/okn/o/sdm#SpatialResolution) parameters: - - description: The ID of the SpatialResolution to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SpatialResolution to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SpatialResolution' + $ref: "#/components/schemas/SpatialResolution" description: An old SpatialResolutionto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SpatialResolution' + $ref: "#/components/schemas/SpatialResolution" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing SpatialResolution tags: - - SpatialResolution + - SpatialResolution /spatiallydistributedgrids: get: - description: Gets a list of all instances of SpatiallyDistributedGrid (more + description: + Gets a list of all instances of SpatiallyDistributedGrid (more information in https://w3id.org/okn/o/sdm#SpatiallyDistributedGrid) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/SpatiallyDistributedGrid' + $ref: "#/components/schemas/SpatiallyDistributedGrid" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of SpatiallyDistributedGrid. summary: List all instances of SpatiallyDistributedGrid tags: - - SpatiallyDistributedGrid + - SpatiallyDistributedGrid post: - description: Create a new instance of SpatiallyDistributedGrid (more information + description: + Create a new instance of SpatiallyDistributedGrid (more information in https://w3id.org/okn/o/sdm#SpatiallyDistributedGrid) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SpatiallyDistributedGrid' + $ref: "#/components/schemas/SpatiallyDistributedGrid" description: Information about the SpatiallyDistributedGridto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SpatiallyDistributedGrid' + $ref: "#/components/schemas/SpatiallyDistributedGrid" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one SpatiallyDistributedGrid tags: - - SpatiallyDistributedGrid + - SpatiallyDistributedGrid /spatiallydistributedgrids/{id}: delete: - description: Delete an existing SpatiallyDistributedGrid (more information in + description: + Delete an existing SpatiallyDistributedGrid (more information in https://w3id.org/okn/o/sdm#SpatiallyDistributedGrid) parameters: - - description: The ID of the SpatiallyDistributedGrid to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SpatiallyDistributedGrid to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing SpatiallyDistributedGrid tags: - - SpatiallyDistributedGrid + - SpatiallyDistributedGrid get: - description: Gets the details of a given SpatiallyDistributedGrid (more information + description: + Gets the details of a given SpatiallyDistributedGrid (more information in https://w3id.org/okn/o/sdm#SpatiallyDistributedGrid) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the SpatiallyDistributedGrid to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the SpatiallyDistributedGrid to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SpatiallyDistributedGrid' + $ref: "#/components/schemas/SpatiallyDistributedGrid" description: Gets the details of a given SpatiallyDistributedGrid summary: Get a single SpatiallyDistributedGrid by its id tags: - - SpatiallyDistributedGrid + - SpatiallyDistributedGrid put: - description: Updates an existing SpatiallyDistributedGrid (more information + description: + Updates an existing SpatiallyDistributedGrid (more information in https://w3id.org/okn/o/sdm#SpatiallyDistributedGrid) parameters: - - description: The ID of the SpatiallyDistributedGrid to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the SpatiallyDistributedGrid to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/SpatiallyDistributedGrid' + $ref: "#/components/schemas/SpatiallyDistributedGrid" description: An old SpatiallyDistributedGridto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SpatiallyDistributedGrid' + $ref: "#/components/schemas/SpatiallyDistributedGrid" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing SpatiallyDistributedGrid tags: - - SpatiallyDistributedGrid + - SpatiallyDistributedGrid /theory-guidedmodels: get: - description: Gets a list of all instances of Theory-GuidedModel (more information + description: + Gets a list of all instances of Theory-GuidedModel (more information in https://w3id.org/okn/o/sdm#Theory-GuidedModel) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Theory-GuidedModel' + $ref: "#/components/schemas/Theory-GuidedModel" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of Theory-GuidedModel. summary: List all instances of Theory-GuidedModel tags: - - Theory-GuidedModel + - Theory-GuidedModel post: - description: Create a new instance of Theory-GuidedModel (more information in + description: + Create a new instance of Theory-GuidedModel (more information in https://w3id.org/okn/o/sdm#Theory-GuidedModel) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Theory-GuidedModel' + $ref: "#/components/schemas/Theory-GuidedModel" description: Information about the Theory-GuidedModelto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Theory-GuidedModel' + $ref: "#/components/schemas/Theory-GuidedModel" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one Theory-GuidedModel tags: - - Theory-GuidedModel + - Theory-GuidedModel /theory-guidedmodels/{id}: delete: description: Delete an existing Theory-GuidedModel (more information in https://w3id.org/okn/o/sdm#Theory-GuidedModel) parameters: - - description: The ID of the Theory-GuidedModel to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Theory-GuidedModel to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing Theory-GuidedModel tags: - - Theory-GuidedModel + - Theory-GuidedModel get: - description: Gets the details of a given Theory-GuidedModel (more information + description: + Gets the details of a given Theory-GuidedModel (more information in https://w3id.org/okn/o/sdm#Theory-GuidedModel) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the Theory-GuidedModel to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the Theory-GuidedModel to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Theory-GuidedModel' + $ref: "#/components/schemas/Theory-GuidedModel" description: Gets the details of a given Theory-GuidedModel summary: Get a single Theory-GuidedModel by its id tags: - - Theory-GuidedModel + - Theory-GuidedModel put: description: Updates an existing Theory-GuidedModel (more information in https://w3id.org/okn/o/sdm#Theory-GuidedModel) parameters: - - description: The ID of the Theory-GuidedModel to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the Theory-GuidedModel to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/Theory-GuidedModel' + $ref: "#/components/schemas/Theory-GuidedModel" description: An old Theory-GuidedModelto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Theory-GuidedModel' + $ref: "#/components/schemas/Theory-GuidedModel" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing Theory-GuidedModel tags: - - Theory-GuidedModel + - Theory-GuidedModel /timeintervals: get: - description: Gets a list of all instances of TimeInterval (more information + description: + Gets a list of all instances of TimeInterval (more information in https://w3id.org/okn/o/sdm#TimeInterval) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Filter by label - explode: true - in: query - name: label - required: false - schema: - type: string - style: form - - description: Page number - explode: true - in: query - name: page - required: false - schema: - default: 1 - format: int32 - type: integer - style: form - - description: Items per page - explode: true - in: query - name: per_page - required: false - schema: - default: 100 - format: int32 - maximum: 200 - minimum: 1 - type: integer - style: form + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Filter by label + explode: true + in: query + name: label + required: false + schema: + type: string + style: form + - description: Page number + explode: true + in: query + name: page + required: false + schema: + default: 1 + format: int32 + type: integer + style: form + - description: Items per page + explode: true + in: query + name: per_page + required: false + schema: + default: 100 + format: int32 + maximum: 200 + minimum: 1 + type: integer + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/TimeInterval' + $ref: "#/components/schemas/TimeInterval" type: array - description: Successful response - returns an array with the instances of + description: + Successful response - returns an array with the instances of TimeInterval. summary: List all instances of TimeInterval tags: - - TimeInterval + - TimeInterval post: description: Create a new instance of TimeInterval (more information in https://w3id.org/okn/o/sdm#TimeInterval) parameters: - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/TimeInterval' + $ref: "#/components/schemas/TimeInterval" description: Information about the TimeIntervalto be created responses: "201": content: application/json: schema: - $ref: '#/components/schemas/TimeInterval' + $ref: "#/components/schemas/TimeInterval" description: Created security: - - BearerAuth: [] + - BearerAuth: [] summary: Create one TimeInterval tags: - - TimeInterval + - TimeInterval /timeintervals/{id}: delete: description: Delete an existing TimeInterval (more information in https://w3id.org/okn/o/sdm#TimeInterval) parameters: - - description: The ID of the TimeInterval to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the TimeInterval to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form responses: "202": description: Deleted "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Delete an existing TimeInterval tags: - - TimeInterval + - TimeInterval get: description: Gets the details of a given TimeInterval (more information in https://w3id.org/okn/o/sdm#TimeInterval) parameters: - - description: Name of the user graph to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the TimeInterval to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the user graph to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the TimeInterval to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/TimeInterval' + $ref: "#/components/schemas/TimeInterval" description: Gets the details of a given TimeInterval summary: Get a single TimeInterval by its id tags: - - TimeInterval + - TimeInterval put: description: Updates an existing TimeInterval (more information in https://w3id.org/okn/o/sdm#TimeInterval) parameters: - - description: The ID of the TimeInterval to be retrieved - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Username - explode: true - in: query - name: user - required: false - schema: - type: string - style: form + - description: The ID of the TimeInterval to be retrieved + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Username + explode: true + in: query + name: user + required: false + schema: + type: string + style: form requestBody: content: application/json: schema: - $ref: '#/components/schemas/TimeInterval' + $ref: "#/components/schemas/TimeInterval" description: An old TimeIntervalto be updated responses: "200": content: application/json: schema: - $ref: '#/components/schemas/TimeInterval' + $ref: "#/components/schemas/TimeInterval" description: Updated "404": description: Not Found security: - - BearerAuth: [] + - BearerAuth: [] summary: Update an existing TimeInterval tags: - - TimeInterval + - TimeInterval /user/login: post: description: Login the user @@ -8472,7 +8600,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" description: User credentials responses: "200": @@ -8507,504 +8635,505 @@ paths: get: description: Gets the details of a single instance of a Model parameters: - - description: Name of the custom query - explode: true - in: query - name: custom_query_name - required: false - schema: - default: custom_model_index - type: string - style: form - - description: Username to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Label of NumericalIndex - explode: true - in: query - name: label - required: true - schema: - type: string - style: form + - description: Name of the custom query + explode: true + in: query + name: custom_query_name + required: false + schema: + default: custom_model_index + type: string + style: form + - description: Username to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Label of NumericalIndex + explode: true + in: query + name: label + required: true + schema: + type: string + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Model' + $ref: "#/components/schemas/Model" type: array description: Gets the details of a single instance of Model summary: Get a Model tags: - - Model + - Model x-oba-custom: true /custom/model/intervention: get: description: Gets the details of a single instance of a Model parameters: - - description: Name of the custom query - explode: true - in: query - name: custom_query_name - required: false - schema: - default: custom_model_intervetion - type: string - style: form - - description: Username to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: Label of intervation - explode: true - in: query - name: label - required: true - schema: - type: string - style: form + - description: Name of the custom query + explode: true + in: query + name: custom_query_name + required: false + schema: + default: custom_model_intervetion + type: string + style: form + - description: Username to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: Label of intervation + explode: true + in: query + name: label + required: true + schema: + type: string + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Model' + $ref: "#/components/schemas/Model" type: array description: Gets the details of a single instance of Model summary: Get a Model tags: - - Model + - Model x-oba-custom: true /custom/model/region: get: description: Gets the details of a single instance of a Model parameters: - - description: Name of the custom query - explode: true - in: query - name: custom_query_name - required: false - schema: - default: custom_model_region - type: string - style: form - - description: Username to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: region to search - explode: true - in: query - name: label - required: true - schema: - type: string - style: form + - description: Name of the custom query + explode: true + in: query + name: custom_query_name + required: false + schema: + default: custom_model_region + type: string + style: form + - description: Username to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: region to search + explode: true + in: query + name: label + required: true + schema: + type: string + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Model' + $ref: "#/components/schemas/Model" type: array description: Gets the details of a single instance of Model summary: Get a Model tags: - - Model + - Model x-oba-custom: true /custom/models/variable: get: description: Get models by variable name parameters: - - description: Name of the custom query - explode: true - in: query - name: custom_query_name - required: false - schema: - default: custom_models_variable - type: string - style: form - - description: Username to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: variable to search - explode: true - in: query - name: label - required: true - schema: - type: string - style: form + - description: Name of the custom query + explode: true + in: query + name: custom_query_name + required: false + schema: + default: custom_models_variable + type: string + style: form + - description: Username to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: variable to search + explode: true + in: query + name: label + required: true + schema: + type: string + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Model' + $ref: "#/components/schemas/Model" type: array description: Gets a list of instance of Model summary: Get a list of Model tags: - - Model + - Model x-oba-custom: true /custom/modelconfigurationsetups/variable: get: description: Get model configurations by variable name parameters: - - description: Name of the custom query - explode: true - in: query - name: custom_query_name - required: false - schema: - default: custom_modelconfigurationsetups_variable - type: string - style: form - - description: Username to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: variable to search - explode: true - in: query - name: label - required: true - schema: - type: string - style: form + - description: Name of the custom query + explode: true + in: query + name: custom_query_name + required: false + schema: + default: custom_modelconfigurationsetups_variable + type: string + style: form + - description: Username to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: variable to search + explode: true + in: query + name: label + required: true + schema: + type: string + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/ModelConfigurationSetup' + $ref: "#/components/schemas/ModelConfigurationSetup" type: array description: Gets a list of instance of ModelConfigurationSetup summary: Get a list Model tags: - - ModelConfigurationSetup + - ModelConfigurationSetup x-oba-custom: true /custom/configurationsetups/{id}: get: description: Gets the details of a single instance of a ModelConfigurationSetup parameters: - - description: Username to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the resource - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Name of the custom query - explode: true - in: query - name: custom_query_name - required: false - schema: - default: custom_configurationsetups - type: string - style: form + - description: Username to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the resource + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Name of the custom query + explode: true + in: query + name: custom_query_name + required: false + schema: + default: custom_configurationsetups + type: string + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ModelConfigurationSetup' + $ref: "#/components/schemas/ModelConfigurationSetup" description: Gets the details of a single instance of ModelConfigurationSetup summary: Get a ModelConfigurationSetup tags: - - ConfigurationSetup + - ConfigurationSetup x-oba-custom: true /custom/modelconfigurationsetups/{id}: get: description: Gets the details of a single instance of a ModelConfigurationSetup parameters: - - description: Username to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the resource - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Name of the custom query - explode: true - in: query - name: custom_query_name - required: false - schema: - default: custom_modelconfigurationsetups - type: string - style: form + - description: Username to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the resource + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Name of the custom query + explode: true + in: query + name: custom_query_name + required: false + schema: + default: custom_modelconfigurationsetups + type: string + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ModelConfigurationSetup' + $ref: "#/components/schemas/ModelConfigurationSetup" description: Gets the details of a single instance of ModelConfigurationSetup summary: Get a ModelConfigurationSetup tags: - - ModelConfigurationSetup + - ModelConfigurationSetup x-oba-custom: true /custom/modelconfigurations/{id}: get: description: Gets the details of a single instance of a ModelConfiguration parameters: - - description: Username to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the resource - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Name of the custom query - explode: true - in: query - name: custom_query_name - required: false - schema: - default: custom_modelconfigurations - type: string - style: form + - description: Username to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the resource + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Name of the custom query + explode: true + in: query + name: custom_query_name + required: false + schema: + default: custom_modelconfigurations + type: string + style: form responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ModelConfiguration' + $ref: "#/components/schemas/ModelConfiguration" description: Gets the details of a single instance of ModelConfiguration summary: Get a ModelConfiguration tags: - - ModelConfiguration + - ModelConfiguration x-oba-custom: true /custom/models/standard_variable: get: description: Gets a list of model filter by the label of a standard variable parameters: - - description: Name of the custom query - explode: true - in: query - name: custom_query_name - required: false - schema: - default: custom_model_standard_variable - type: string - style: form - - description: Username to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: standard variable name - explode: true - in: query - name: label - required: true - schema: - type: string - style: form + - description: Name of the custom query + explode: true + in: query + name: custom_query_name + required: false + schema: + default: custom_model_standard_variable + type: string + style: form + - description: Username to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: standard variable name + explode: true + in: query + name: label + required: true + schema: + type: string + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/Model' + $ref: "#/components/schemas/Model" type: array description: Gets a list of models summary: Get a list of models tags: - - Model + - Model x-oba-custom: true /custom/datasetspecifications/{id}/datatransformations: get: description: Gets a list of data transformations related a dataset parameters: - - description: Name of the custom query - explode: true - in: query - name: custom_query_name - required: false - schema: - default: custom_datatransformations - type: string - style: form - - description: Username to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the dataspecification - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple + - description: Name of the custom query + explode: true + in: query + name: custom_query_name + required: false + schema: + default: custom_datatransformations + type: string + style: form + - description: Username to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the dataspecification + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/DataTransformation' + $ref: "#/components/schemas/DataTransformation" type: array description: Gets a list of data transformations filter related a dataset. summary: Gets a list of data transformations related a dataset tags: - - DataTransformation + - DataTransformation x-oba-custom: true /custom/datasetspecifications: get: description: Gets all inputs of a configuration parameters: - - description: Username to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the configuration - explode: true - in: query - name: configurationid - required: true - schema: - type: string - style: form - - description: Name of the custom query - explode: true - in: query - name: custom_query_name - required: false - schema: - default: custom_allinputs - type: string - style: form + - description: Username to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the configuration + explode: true + in: query + name: configurationid + required: true + schema: + type: string + style: form + - description: Name of the custom query + explode: true + in: query + name: custom_query_name + required: false + schema: + default: custom_allinputs + type: string + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" type: array description: Gets all inputs of a configuration summary: Gets all inputs of a configuration tags: - - DatasetSpecification + - DatasetSpecification x-oba-custom: true /custom/configuration/{id}/inputs: get: description: Gets all inputs of a configuration parameters: - - description: Username to query - explode: true - in: query - name: username - required: false - schema: - type: string - style: form - - description: The ID of the resource - explode: false - in: path - name: id - required: true - schema: - type: string - style: simple - - description: Name of the custom query - explode: true - in: query - name: custom_query_name - required: false - schema: - default: search_datasetspecification_by_configurationid - type: string - style: form + - description: Username to query + explode: true + in: query + name: username + required: false + schema: + type: string + style: form + - description: The ID of the resource + explode: false + in: path + name: id + required: true + schema: + type: string + style: simple + - description: Name of the custom query + explode: true + in: query + name: custom_query_name + required: false + schema: + default: search_datasetspecification_by_configurationid + type: string + style: form responses: "200": content: application/json: schema: items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" type: array description: Gets all inputs of a configuration summary: Gets all inputs of a configuration tags: - - DatasetSpecification + - DatasetSpecification x-oba-custom: true components: schemas: Intervention: - description: Interference by a policy maker or modeler by modifying a variable + description: + Interference by a policy maker or modeler by modifying a variable or parameter of a model example: value: @@ -9035,7 +9164,8 @@ components: title: Intervention type: object Visualization: - description: "Class to represent any type of visualization related to a software.\ + description: + "Class to represent any type of visualization related to a software.\ \ For example, a dynamic HTML page, a video, etc." example: value: @@ -9048,11 +9178,13 @@ components: nullable: true type: array hadPrimarySource: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." items: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." type: object @@ -9061,7 +9193,7 @@ components: wasDerivedFromSoftware: description: Property that identifies the software used to create a visualization items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array description: @@ -9089,13 +9221,14 @@ components: value: description: Value associated to the described entity items: - $ref: '#/components/schemas/Visualization_value_inner' + $ref: "#/components/schemas/Visualization_value_inner" nullable: true type: array title: Visualization type: object SourceCode: - description: Class representing the characteristics of the code associated with + description: + Class representing the characteristics of the code associated with a software component example: value: @@ -9263,10 +9396,11 @@ components: nullable: true type: array hasVariable: - description: Property that links a rule and the variable that will test + description: + Property that links a rule and the variable that will test it items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array title: Constraint @@ -9326,7 +9460,8 @@ components: title: GeoShape type: object Grid: - description: Class that represents the geospatial information associated with + description: + Class that represents the geospatial information associated with a model example: value: @@ -9368,13 +9503,13 @@ components: hasDataTransformation: description: Description not available items: - $ref: '#/components/schemas/DataTransformation' + $ref: "#/components/schemas/DataTransformation" nullable: true type: array hasPresentation: description: Description not available items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array label: @@ -9392,7 +9527,7 @@ components: hasFixedResource: description: Description not available items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" nullable: true type: array hasCoordinateSystem: @@ -9411,11 +9546,12 @@ components: isTransformedFrom: description: Description not available items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array hasShape: - description: "Grids may be: rectangular, triangular, hexagonal, hybrid,\ + description: + "Grids may be: rectangular, triangular, hexagonal, hybrid,\ \ unstructured, block structure, etc." items: type: string @@ -9431,7 +9567,7 @@ components: hasDataTransformationSetup: description: Description not available items: - $ref: '#/components/schemas/DataTransformationSetup' + $ref: "#/components/schemas/DataTransformationSetup" nullable: true type: array position: @@ -9454,10 +9590,11 @@ components: id: some_id properties: influences: - description: Property that captures if a physical process influences another + description: + Property that captures if a physical process influences another process items: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" nullable: true type: array description: @@ -9485,7 +9622,8 @@ components: title: Process type: object Emulator: - description: "Type of models that emulates the behavior of another model. For\ + description: + "Type of models that emulates the behavior of another model. For\ \ example, an emulator can be a machine learning model trained on the output\ \ runs of a hydrology model" example: @@ -9513,7 +9651,7 @@ components: hasGrid: description: Grid information about the model items: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" nullable: true type: array softwareRequirements: @@ -9543,13 +9681,13 @@ components: compatibleVisualizationSoftware: description: Description not available items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -9561,13 +9699,13 @@ components: logo: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array id: @@ -9575,7 +9713,8 @@ components: nullable: false type: string limitations: - description: Known restrictions (i.e. cases where the model is known not + description: + Known restrictions (i.e. cases where the model is known not to be reliable or shouldn't be used) items: type: string @@ -9590,7 +9729,7 @@ components: author: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasBuildFile: @@ -9626,14 +9765,14 @@ components: hasSourceCode: description: Description not available items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasExplanationDiagram: description: Diagram used to explain the behavior of the model items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasExample: @@ -9645,11 +9784,12 @@ components: publisher: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array runtimeEstimation: - description: An estimate of the time required to run example codes or other + description: + An estimate of the time required to run example codes or other known configurations items: type: string @@ -9664,14 +9804,15 @@ components: hasFunding: description: Description not available items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array hasProcess: - description: Property that indicates which physical processes (if any) are + description: + Property that indicates which physical processes (if any) are associated with a model items: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" nullable: true type: array supportDetails: @@ -9683,7 +9824,7 @@ components: hasVersion: description: Description not available items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -9707,13 +9848,13 @@ components: screenshot: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasModelCategory: description: "Category associated with a model (e.g., Hydrology, etc.)" items: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" nullable: true type: array hadPrimarySource: @@ -9738,13 +9879,13 @@ components: contributor: description: Description not available items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasInputVariable: description: Variable that is used as input for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array hasPurpose: @@ -9762,7 +9903,7 @@ components: hasSampleVisualization: description: Description not available items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array memoryRequirements: @@ -9790,7 +9931,8 @@ components: nullable: true type: array parameterization: - description: Were there any simplifications made to processes to make the + description: + Were there any simplifications made to processes to make the model more efficient items: type: string @@ -9835,19 +9977,19 @@ components: hasEquation: description: Equations used in the model items: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" nullable: true type: array usefulForCalculatingIndex: description: Description not available items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasOutputVariable: description: Variable that is used as output for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array title: Emulator @@ -9859,7 +10001,8 @@ components: id: some_id properties: hasDimensionality: - description: Property to indicate dimensionality of the input or output + description: + Property to indicate dimensionality of the input or output of a dataset specification items: format: int32 @@ -9873,7 +10016,8 @@ components: nullable: true type: array pathLocation: - description: "Property that indicates the relative path of an input or output\ + description: + "Property that indicates the relative path of an input or output\ \ with respect to the folder structure of the executable. \n\nFor example,\ \ let's assume we have an input that has to exist in the folder `/datasets`\ \ or the executable will not work. This property ensures that this knowledge\ @@ -9900,18 +10044,20 @@ components: nullable: true type: array hasDataTransformation: - description: Property that associates an input/output with their corresponding + description: + Property that associates an input/output with their corresponding data transformation. items: - $ref: '#/components/schemas/DataTransformation' + $ref: "#/components/schemas/DataTransformation" nullable: true type: array hasPresentation: - description: Property that links an instance of a dataset (or a dataset + description: + Property that links an instance of a dataset (or a dataset specification) to the presentation of a variable contained (or expected to be contained) on it. items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array label: @@ -9927,43 +10073,49 @@ components: nullable: true type: array hasFixedResource: - description: "Property that links a parameter or an input to a fixed value.\ + description: + "Property that links a parameter or an input to a fixed value.\ \ For example, in a given configuration a parameter with the planting\ \ date for a model could be fixed to avoid the user changing it for that\ \ region." items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" nullable: true type: array isTransformedFrom: - description: "Property that links a dataset specification from a model configuration\ + description: + "Property that links a dataset specification from a model configuration\ \ or setup to the output from a target data transformation. This occurs\ \ when a data transformation produces several outputs, but only one of\ \ them is the one needed for a model" items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array hadPrimarySource: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." items: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." type: object nullable: true type: array hasDataTransformationSetup: - description: Property to link an input/output dataset to the specific data + description: + Property to link an input/output dataset to the specific data transformation (with URLs items: - $ref: '#/components/schemas/DataTransformationSetup' + $ref: "#/components/schemas/DataTransformationSetup" nullable: true type: array position: - description: Position of the parameter or input/output in the model configuration. + description: + Position of the parameter or input/output in the model configuration. This property is needed to know how to organize the I/O of the component on execution items: @@ -9978,7 +10130,7 @@ components: value: description: Value associated to the described entity items: - $ref: '#/components/schemas/Visualization_value_inner' + $ref: "#/components/schemas/Visualization_value_inner" nullable: true type: array title: Image @@ -10014,7 +10166,8 @@ components: title: Unit type: object StandardVariable: - description: "A standard variable, necessary to refer to all the variable using\ + description: + "A standard variable, necessary to refer to all the variable using\ \ the same nomenclature in a domain ontology. For example, a standard variable\ \ may be a SVO variable (http://www.geoscienceontology.org/geo-upper#Variable)" example: @@ -10046,7 +10199,8 @@ components: title: StandardVariable type: object DataTransformationSetup: - description: "Special type of data transformation where the inputs and parameters\ + description: + "Special type of data transformation where the inputs and parameters\ \ have some pre-selected values. For example, they may point to a particular\ \ dataset URL to be used in the transformation" example: @@ -10054,7 +10208,8 @@ components: id: some_id properties: hasDownloadInstructions: - description: "Instructions needed to download a software component. The\ + description: + "Instructions needed to download a software component. The\ \ difference with `hasDownloadURL` is that this property captures the\ \ human readable instructions required to download software. For example,\ \ sometimes an authentication is needed, users need to fill in a form,\ @@ -10076,7 +10231,8 @@ components: nullable: true type: array hasImplementationScriptLocation: - description: Property that points to the main runnable script for the current + description: + Property that points to the main runnable script for the current function items: type: string @@ -10101,23 +10257,25 @@ components: nullable: true type: array hasInstallationInstructions: - description: Instructions required to install this particular piece of software. + description: + Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. items: type: string nullable: true type: array compatibleVisualizationSoftware: - description: Property that links a software component to other useful software + description: + Property that links a software component to other useful software that canbe used to visualize its outputs items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Copyright holder for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -10127,20 +10285,22 @@ components: nullable: true type: array logo: - description: Property that links to the image used as logo for a software + description: + Property that links to the image used as logo for a software component items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Contact person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array tag: - description: "Tag used to annotate a version or a software configuration.\ + description: + "Tag used to annotate a version or a software configuration.\ \ This annotation is useful to show which version is the latest, or which\ \ version is deprecated. Supported tags are: \"latest\", \"deprecated\"" items: @@ -10160,41 +10320,45 @@ components: hasSampleExecution: description: Property pointing to a sample execution of a software configuration items: - $ref: '#/components/schemas/SampleExecution' + $ref: "#/components/schemas/SampleExecution" nullable: true type: array hasSampleResult: - description: Property designed to link a software configuration to a sample + description: + Property designed to link a software configuration to a sample resource resulting from its execution items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" nullable: true type: array author: description: The creator of a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array wasDerivedFromSetup: - description: Property that links a setup to a previous version of that setup. + description: + Property that links a setup to a previous version of that setup. This property is needed (for example) when creating snapshots of setups. items: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" nullable: true type: array hasConstraint: - description: "Constraint or rule associated to a software configuration.\ + description: + "Constraint or rule associated to a software configuration.\ \ For example: \"This model accepts only monthly data\", or \"all inputs\ \ of this model configuration must share the same location\". More structured\ \ restrictions, such as Jena rules or SWRL rules may also be captured\ \ with this property" items: - $ref: '#/components/schemas/Constraint' + $ref: "#/components/schemas/Constraint" nullable: true type: array hasBuildFile: - description: "A file (e.g., Dockerfile) with executable instructions indicating\ + description: + "A file (e.g., Dockerfile) with executable instructions indicating\ \ how a Software Image or a Software component is built" items: type: string @@ -10225,42 +10389,47 @@ components: nullable: true type: array hasSourceCode: - description: Property designed to link a software with its software source + description: + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasSetup: - description: Property used to define configurations with some fixed resources + description: + Property used to define configurations with some fixed resources and values. The rationale of this property is to allow predefined configurations items: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" nullable: true type: array hasExample: - description: An example explaining a scenario where the software component + description: + An example explaining a scenario where the software component was used in plain language. items: type: string nullable: true type: array publisher: - description: Publisher organization or person responsible for a software + description: + Publisher organization or person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasOutput: description: Property that expresses what are the outputs of a model items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array status: - description: "Data property to indicate the status of a configuration setups.\ + description: + "Data property to indicate the status of a configuration setups.\ \ For example, to indicate that a setup has been executed in a platform,\ \ that the setup should notbe shown to users (it's an auxiliary setup),\ \ etc." @@ -10277,11 +10446,12 @@ components: hasFunding: description: Property that links a software project to its funding information items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array hasComponentLocation: - description: "Location of the aggregation of all the files needed to execute\ + description: + "Location of the aggregation of all the files needed to execute\ \ the component. Usually a zip file including the run script and support\ \ scripts, including specification files" items: @@ -10289,17 +10459,19 @@ components: nullable: true type: array supportDetails: - description: "Property to link details, such as mailing lists in case a\ + description: + "Property to link details, such as mailing lists in case a\ \ contact person is not provided" items: type: string nullable: true type: array hasVersion: - description: Property designed to link a software component with its corresponding + description: + Property designed to link a software component with its corresponding versions items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -10323,15 +10495,17 @@ components: screenshot: description: Image illustrating a snapshot of the target software items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hadPrimarySource: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." items: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." type: object @@ -10346,7 +10520,7 @@ components: hasSoftwareImage: description: Function to link a function with its corresponding container items: - $ref: '#/components/schemas/SoftwareImage' + $ref: "#/components/schemas/SoftwareImage" maxItems: 1 nullable: true type: array @@ -10359,18 +10533,20 @@ components: contributor: description: Contributor to a software component items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasPurpose: - description: Objective or main functionality that can be achieved by running + description: + Objective or main functionality that can be achieved by running this software items: type: string nullable: true type: array hasExecutableInstructions: - description: "Instructions that indicate how a software component should\ + description: + "Instructions that indicate how a software component should\ \ be executed. The difference with `hasExecutionCommand` is that the execution\ \ instructions aim to be human-readable, and have explanations between\ \ the different commands and instructions" @@ -10381,7 +10557,7 @@ components: hasSampleVisualization: description: A typical sample visualization of the softwware outputs items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array memoryRequirements: @@ -10411,11 +10587,12 @@ components: adjustableParameter: description: Parameter that can be adjusted in a configuration setup items: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" nullable: true type: array hasUsageNotes: - description: "Property that describes the usage considerations of a particular\ + description: + "Property that describes the usage considerations of a particular\ \ software. These notes capture the rationale of for that software configuration,\ \ along with an explanation for sample inputs, things to consider when\ \ running the model with data, etc." @@ -10424,7 +10601,8 @@ components: nullable: true type: array hasSupportScriptLocation: - description: Property that links to the location of scripts that may be + description: + Property that links to the location of scripts that may be used from the main runnable script. items: type: string @@ -10443,7 +10621,8 @@ components: nullable: true type: array hasAssumption: - description: "Assumptions of a software, e.g. the solver being used for\ + description: + "Assumptions of a software, e.g. the solver being used for\ \ a particular model, the source of the data (e.g., all data must have\ \ a given resolution), etc." items: @@ -10453,7 +10632,7 @@ components: hasParameter: description: Property that indicates the parameters of a model configuration items: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" nullable: true type: array operatingSystems: @@ -10463,7 +10642,8 @@ components: nullable: true type: array hasExecutableNotebook: - description: "Property that links a software component with an executable\ + description: + "Property that links a software component with an executable\ \ notebook (e.g., Jupyter notebook) that illustrates how to use it in\ \ an executable manner." items: @@ -10471,25 +10651,28 @@ components: nullable: true type: array usefulForCalculatingIndex: - description: Property that indicates that a software component (or any of + description: + Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasInput: - description: Property that links a model configuration to the input types + description: + Property that links a model configuration to the input types expected by it. items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array title: DataTransformationSetup type: object ModelConfigurationSetup: - description: "Setup of a particular model, that may represent a calibration\ + description: + "Setup of a particular model, that may represent a calibration\ \ or a configuration with a set of values for a specific region." example: value: @@ -10516,7 +10699,7 @@ components: hasGrid: description: Grid information about the model items: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" nullable: true type: array hasImplementationScriptLocation: @@ -10544,10 +10727,11 @@ components: nullable: true type: array calibratedVariable: - description: Variable that was calibrated in this particular model configuration + description: + Variable that was calibrated in this particular model configuration calibration items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array hasInstallationInstructions: @@ -10559,28 +10743,30 @@ components: compatibleVisualizationSoftware: description: Description not available items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array calibrationMethod: - description: Calibration method used for a particular model configuration + description: + Calibration method used for a particular model configuration or setup items: type: string nullable: true type: array hasRegion: - description: Property linking a region to a model configuration/calibration. + description: + Property linking a region to a model configuration/calibration. This property implies that the described model configuration is prepared to execute in that target region items: - $ref: '#/components/schemas/Region' + $ref: "#/components/schemas/Region" nullable: true type: array hasFAQ: @@ -10592,13 +10778,13 @@ components: logo: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array tag: @@ -10612,7 +10798,8 @@ components: nullable: false type: string limitations: - description: Known restrictions (i.e. cases where the model is known not + description: + Known restrictions (i.e. cases where the model is known not to be reliable or shouldn't be used) items: type: string @@ -10627,31 +10814,31 @@ components: hasSampleExecution: description: Description not available items: - $ref: '#/components/schemas/SampleExecution' + $ref: "#/components/schemas/SampleExecution" nullable: true type: array hasSampleResult: description: Description not available items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" nullable: true type: array author: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array wasDerivedFromSetup: description: Description not available items: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" nullable: true type: array hasConstraint: description: Description not available items: - $ref: '#/components/schemas/Constraint' + $ref: "#/components/schemas/Constraint" nullable: true type: array hasBuildFile: @@ -10693,20 +10880,20 @@ components: hasSourceCode: description: Description not available items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasSetup: description: Description not available items: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" nullable: true type: array hasExplanationDiagram: description: Diagram used to explain the behavior of the model items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasExample: @@ -10716,7 +10903,8 @@ components: nullable: true type: array calibrationInterval: - description: Property that represents the temporal interval used to calibrate + description: + Property that represents the temporal interval used to calibrate a model items: type: string @@ -10725,17 +10913,18 @@ components: publisher: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasOutput: description: Description not available items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array runtimeEstimation: - description: An estimate of the time required to run example codes or other + description: + An estimate of the time required to run example codes or other known configurations items: type: string @@ -10744,7 +10933,7 @@ components: hasOutputTimeInterval: description: Time interval used in the model configuration items: - $ref: '#/components/schemas/TimeInterval' + $ref: "#/components/schemas/TimeInterval" nullable: true type: array status: @@ -10760,7 +10949,8 @@ components: nullable: true type: array parameterAssignmentMethod: - description: "Property that indicates how have the parameters assigned in\ + description: + "Property that indicates how have the parameters assigned in\ \ a model configuration (e.g., using an expert guess, by using calibration,\ \ etc.)" items: @@ -10770,7 +10960,7 @@ components: hasFunding: description: Description not available items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array hasComponentLocation: @@ -10780,10 +10970,11 @@ components: nullable: true type: array hasProcess: - description: Property that indicates which physical processes (if any) are + description: + Property that indicates which physical processes (if any) are associated with a model items: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" nullable: true type: array supportDetails: @@ -10795,7 +10986,7 @@ components: hasVersion: description: Description not available items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -10819,13 +11010,13 @@ components: screenshot: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasModelCategory: description: "Category associated with a model (e.g., Hydrology, etc.)" items: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" nullable: true type: array hadPrimarySource: @@ -10844,7 +11035,7 @@ components: hasSoftwareImage: description: Description not available items: - $ref: '#/components/schemas/SoftwareImage' + $ref: "#/components/schemas/SoftwareImage" maxItems: 1 nullable: true type: array @@ -10857,13 +11048,13 @@ components: contributor: description: Description not available items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasInputVariable: description: Variable that is used as input for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array hasModelResultTable: @@ -10873,11 +11064,12 @@ components: nullable: true type: array calibrationTargetVariable: - description: "Variable for which the model was calibrated for. For example,\ + description: + "Variable for which the model was calibrated for. For example,\ \ in a hydrology model one calibrate the predicted river width by varying\ \ hydrologic conductivity" items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array hasPurpose: @@ -10895,13 +11087,13 @@ components: hasSampleVisualization: description: Description not available items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array hasCausalDiagram: description: Diagram associated to a model configuration items: - $ref: '#/components/schemas/CausalDiagram' + $ref: "#/components/schemas/CausalDiagram" nullable: true type: array memoryRequirements: @@ -10929,7 +11121,8 @@ components: nullable: true type: array parameterization: - description: Were there any simplifications made to processes to make the + description: + Were there any simplifications made to processes to make the model more efficient items: type: string @@ -10938,7 +11131,7 @@ components: adjustableParameter: description: Description not available items: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" nullable: true type: array hasUsageNotes: @@ -10974,7 +11167,7 @@ components: hasParameter: description: Description not available items: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" nullable: true type: array operatingSystems: @@ -10990,7 +11183,8 @@ components: nullable: true type: array validUntil: - description: "Date until which the calibration of a model is valid. For\ + description: + "Date until which the calibration of a model is valid. For\ \ example, a trained model with data from 2005-2010 may only be valid\ \ for predictions until 2015." items: @@ -11001,31 +11195,32 @@ components: hasEquation: description: Equations used in the model items: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" nullable: true type: array usefulForCalculatingIndex: description: Description not available items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasInput: description: Description not available items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array hasOutputVariable: description: Variable that is used as output for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array title: ModelConfigurationSetup type: object Theory-GuidedModel: - description: A model guided by mathematical equations that attempt to represent + description: + A model guided by mathematical equations that attempt to represent one or more natural processes. example: value: @@ -11052,7 +11247,7 @@ components: hasGrid: description: Grid information about the model items: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" nullable: true type: array softwareRequirements: @@ -11082,13 +11277,13 @@ components: compatibleVisualizationSoftware: description: Description not available items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -11100,13 +11295,13 @@ components: logo: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array id: @@ -11114,7 +11309,8 @@ components: nullable: false type: string limitations: - description: Known restrictions (i.e. cases where the model is known not + description: + Known restrictions (i.e. cases where the model is known not to be reliable or shouldn't be used) items: type: string @@ -11129,7 +11325,7 @@ components: author: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasBuildFile: @@ -11165,14 +11361,14 @@ components: hasSourceCode: description: Description not available items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasExplanationDiagram: description: Diagram used to explain the behavior of the model items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasExample: @@ -11184,11 +11380,12 @@ components: publisher: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array runtimeEstimation: - description: An estimate of the time required to run example codes or other + description: + An estimate of the time required to run example codes or other known configurations items: type: string @@ -11203,14 +11400,15 @@ components: hasFunding: description: Description not available items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array hasProcess: - description: Property that indicates which physical processes (if any) are + description: + Property that indicates which physical processes (if any) are associated with a model items: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" nullable: true type: array supportDetails: @@ -11222,7 +11420,7 @@ components: hasVersion: description: Description not available items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -11246,13 +11444,13 @@ components: screenshot: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasModelCategory: description: "Category associated with a model (e.g., Hydrology, etc.)" items: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" nullable: true type: array hadPrimarySource: @@ -11277,13 +11475,13 @@ components: contributor: description: Description not available items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasInputVariable: description: Variable that is used as input for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array hasPurpose: @@ -11301,7 +11499,7 @@ components: hasSampleVisualization: description: Description not available items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array memoryRequirements: @@ -11329,7 +11527,8 @@ components: nullable: true type: array parameterization: - description: Were there any simplifications made to processes to make the + description: + Were there any simplifications made to processes to make the model more efficient items: type: string @@ -11374,19 +11573,19 @@ components: hasEquation: description: Equations used in the model items: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" nullable: true type: array usefulForCalculatingIndex: description: Description not available items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasOutputVariable: description: Variable that is used as output for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array title: Theory-GuidedModel @@ -11418,7 +11617,7 @@ components: hasGrid: description: Grid information about the model items: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" nullable: true type: array softwareRequirements: @@ -11448,13 +11647,13 @@ components: compatibleVisualizationSoftware: description: Description not available items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -11466,13 +11665,13 @@ components: logo: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array id: @@ -11480,7 +11679,8 @@ components: nullable: false type: string limitations: - description: Known restrictions (i.e. cases where the model is known not + description: + Known restrictions (i.e. cases where the model is known not to be reliable or shouldn't be used) items: type: string @@ -11495,7 +11695,7 @@ components: author: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasBuildFile: @@ -11531,14 +11731,14 @@ components: hasSourceCode: description: Description not available items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasExplanationDiagram: description: Diagram used to explain the behavior of the model items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasExample: @@ -11550,11 +11750,12 @@ components: publisher: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array runtimeEstimation: - description: An estimate of the time required to run example codes or other + description: + An estimate of the time required to run example codes or other known configurations items: type: string @@ -11569,14 +11770,15 @@ components: hasFunding: description: Description not available items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array hasProcess: - description: Property that indicates which physical processes (if any) are + description: + Property that indicates which physical processes (if any) are associated with a model items: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" nullable: true type: array supportDetails: @@ -11588,7 +11790,7 @@ components: hasVersion: description: Description not available items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -11612,20 +11814,21 @@ components: screenshot: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array usesModel: - description: Property that describes which models are used by a coupled + description: + Property that describes which models are used by a coupled model items: - $ref: '#/components/schemas/Model' + $ref: "#/components/schemas/Model" nullable: true type: array hasModelCategory: description: "Category associated with a model (e.g., Hydrology, etc.)" items: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" nullable: true type: array hadPrimarySource: @@ -11650,13 +11853,13 @@ components: contributor: description: Description not available items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasInputVariable: description: Variable that is used as input for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array hasPurpose: @@ -11674,7 +11877,7 @@ components: hasSampleVisualization: description: Description not available items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array memoryRequirements: @@ -11702,7 +11905,8 @@ components: nullable: true type: array parameterization: - description: Were there any simplifications made to processes to make the + description: + Were there any simplifications made to processes to make the model more efficient items: type: string @@ -11747,25 +11951,26 @@ components: hasEquation: description: Equations used in the model items: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" nullable: true type: array usefulForCalculatingIndex: description: Description not available items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasOutputVariable: description: Variable that is used as output for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array title: CoupledModel type: object CatalogIdentifier: - description: "Class to identify that a parameter is a catalog identifier. The\ + description: + "Class to identify that a parameter is a catalog identifier. The\ \ rationale for this type of parameter is that in some cases datasets may\ \ be downloaded in the software component itself, rather than exposed as an\ \ input" @@ -11776,13 +11981,13 @@ components: hasDefaultValue: description: Default accepted value of a variable presentation (or a parameter) items: - $ref: '#/components/schemas/Visualization_value_inner' + $ref: "#/components/schemas/Visualization_value_inner" nullable: true type: array hasMaximumAcceptedValue: description: Maximum accepted value of a variable presentation (or a parameter) items: - $ref: '#/components/schemas/CatalogIdentifier_hasMaximumAcceptedValue_inner' + $ref: "#/components/schemas/CatalogIdentifier_hasMaximumAcceptedValue_inner" nullable: true type: array description: @@ -11800,15 +12005,16 @@ components: hasFixedValue: description: Value of a parameter in a software setup. items: - $ref: '#/components/schemas/Visualization_value_inner' + $ref: "#/components/schemas/Visualization_value_inner" nullable: true type: array hasPresentation: - description: Property that links an instance of a dataset (or a dataset + description: + Property that links an instance of a dataset (or a dataset specification) to the presentation of a variable contained (or expected to be contained) on it. items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array label: @@ -11818,7 +12024,8 @@ components: nullable: true type: array recommendedIncrement: - description: "Value that represents how a parameter should be incremented\ + description: + "Value that represents how a parameter should be incremented\ \ on each iteration of a software component execution. This value is important\ \ when preparing execution ensembles automatically, e.g., simulating crop\ \ production varying the parameter \"fertilizer amount\" in increments\ @@ -11836,11 +12043,12 @@ components: hasMinimumAcceptedValue: description: Minimum accepted value of a variable presentation (or a parameter) items: - $ref: '#/components/schemas/CatalogIdentifier_hasMaximumAcceptedValue_inner' + $ref: "#/components/schemas/CatalogIdentifier_hasMaximumAcceptedValue_inner" nullable: true type: array hasAcceptedValues: - description: "Property that constraints which values are accepted for a\ + description: + "Property that constraints which values are accepted for a\ \ parameter. For example, the name of a crop can only be \"Maize\" or\ \ \"Sorghum\"" items: @@ -11848,23 +12056,25 @@ components: nullable: true type: array adjustsVariable: - description: "Property that links parameter with the variable they adjust.\ + description: + "Property that links parameter with the variable they adjust.\ \ This property can be used when parameters quantify variables without\ \ directly representing them. For example, a \"fertilizer percentage adjustment\"\ \ parameter can quantify a \"fertilizer price\" variable" items: - $ref: '#/components/schemas/Variable' + $ref: "#/components/schemas/Variable" maxItems: 1 nullable: true type: array relevantForIntervention: description: Description not available items: - $ref: '#/components/schemas/Intervention' + $ref: "#/components/schemas/Intervention" nullable: true type: array position: - description: Position of the parameter or input/output in the model configuration. + description: + Position of the parameter or input/output in the model configuration. This property is needed to know how to organize the I/O of the component on execution items: @@ -11877,15 +12087,17 @@ components: nullable: false type: string usesUnit: - description: Property used to link a variable presentation or time interval + description: + Property used to link a variable presentation or time interval to the unit they are represented in items: - $ref: '#/components/schemas/Unit' + $ref: "#/components/schemas/Unit" maxItems: 1 nullable: true type: array hasStepSize: - description: "Property that determines what are the increments (step size)\ + description: + "Property that determines what are the increments (step size)\ \ that are commonly used to vary a parameter. This is commonly used for\ \ automatically setting up software tests. For example, if I want to set\ \ up a model and try 30 reasonable values on a parameter, I may use the\ @@ -11925,7 +12137,7 @@ components: hasGrid: description: Grid information about the model items: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" nullable: true type: array softwareRequirements: @@ -11955,13 +12167,13 @@ components: compatibleVisualizationSoftware: description: Description not available items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -11973,13 +12185,13 @@ components: logo: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array id: @@ -11987,7 +12199,8 @@ components: nullable: false type: string limitations: - description: Known restrictions (i.e. cases where the model is known not + description: + Known restrictions (i.e. cases where the model is known not to be reliable or shouldn't be used) items: type: string @@ -12002,7 +12215,7 @@ components: author: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasBuildFile: @@ -12038,14 +12251,14 @@ components: hasSourceCode: description: Description not available items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasExplanationDiagram: description: Diagram used to explain the behavior of the model items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasExample: @@ -12057,11 +12270,12 @@ components: publisher: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array runtimeEstimation: - description: An estimate of the time required to run example codes or other + description: + An estimate of the time required to run example codes or other known configurations items: type: string @@ -12076,14 +12290,15 @@ components: hasFunding: description: Description not available items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array hasProcess: - description: Property that indicates which physical processes (if any) are + description: + Property that indicates which physical processes (if any) are associated with a model items: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" nullable: true type: array supportDetails: @@ -12095,7 +12310,7 @@ components: hasVersion: description: Description not available items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -12119,13 +12334,13 @@ components: screenshot: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasModelCategory: description: "Category associated with a model (e.g., Hydrology, etc.)" items: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" nullable: true type: array hadPrimarySource: @@ -12150,13 +12365,13 @@ components: contributor: description: Description not available items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasInputVariable: description: Variable that is used as input for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array hasPurpose: @@ -12174,7 +12389,7 @@ components: hasSampleVisualization: description: Description not available items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array memoryRequirements: @@ -12202,7 +12417,8 @@ components: nullable: true type: array parameterization: - description: Were there any simplifications made to processes to make the + description: + Were there any simplifications made to processes to make the model more efficient items: type: string @@ -12247,25 +12463,26 @@ components: hasEquation: description: Equations used in the model items: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" nullable: true type: array usefulForCalculatingIndex: description: Description not available items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasOutputVariable: description: Variable that is used as output for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array title: EmpiricalModel type: object ModelConfiguration: - description: A model configuration is a way of exposing a particular functionality + description: + A model configuration is a way of exposing a particular functionality of a model. example: value: @@ -12292,7 +12509,7 @@ components: hasGrid: description: Grid information about the model items: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" nullable: true type: array hasImplementationScriptLocation: @@ -12328,21 +12545,22 @@ components: compatibleVisualizationSoftware: description: Description not available items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasRegion: - description: Property linking a region to a model configuration/calibration. + description: + Property linking a region to a model configuration/calibration. This property implies that the described model configuration is prepared to execute in that target region items: - $ref: '#/components/schemas/Region' + $ref: "#/components/schemas/Region" nullable: true type: array hasFAQ: @@ -12354,13 +12572,13 @@ components: logo: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array tag: @@ -12374,7 +12592,8 @@ components: nullable: false type: string limitations: - description: Known restrictions (i.e. cases where the model is known not + description: + Known restrictions (i.e. cases where the model is known not to be reliable or shouldn't be used) items: type: string @@ -12389,25 +12608,25 @@ components: hasSampleExecution: description: Description not available items: - $ref: '#/components/schemas/SampleExecution' + $ref: "#/components/schemas/SampleExecution" nullable: true type: array hasSampleResult: description: Description not available items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" nullable: true type: array author: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasConstraint: description: Description not available items: - $ref: '#/components/schemas/Constraint' + $ref: "#/components/schemas/Constraint" nullable: true type: array hasBuildFile: @@ -12449,20 +12668,20 @@ components: hasSourceCode: description: Description not available items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasSetup: description: Description not available items: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" nullable: true type: array hasExplanationDiagram: description: Diagram used to explain the behavior of the model items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasExample: @@ -12474,17 +12693,18 @@ components: publisher: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasOutput: description: Description not available items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array runtimeEstimation: - description: An estimate of the time required to run example codes or other + description: + An estimate of the time required to run example codes or other known configurations items: type: string @@ -12493,7 +12713,7 @@ components: hasOutputTimeInterval: description: Time interval used in the model configuration items: - $ref: '#/components/schemas/TimeInterval' + $ref: "#/components/schemas/TimeInterval" nullable: true type: array doi: @@ -12505,7 +12725,7 @@ components: hasFunding: description: Description not available items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array hasComponentLocation: @@ -12515,10 +12735,11 @@ components: nullable: true type: array hasProcess: - description: Property that indicates which physical processes (if any) are + description: + Property that indicates which physical processes (if any) are associated with a model items: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" nullable: true type: array supportDetails: @@ -12530,7 +12751,7 @@ components: hasVersion: description: Description not available items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -12554,13 +12775,13 @@ components: screenshot: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasModelCategory: description: "Category associated with a model (e.g., Hydrology, etc.)" items: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" nullable: true type: array hadPrimarySource: @@ -12579,7 +12800,7 @@ components: hasSoftwareImage: description: Description not available items: - $ref: '#/components/schemas/SoftwareImage' + $ref: "#/components/schemas/SoftwareImage" maxItems: 1 nullable: true type: array @@ -12592,13 +12813,13 @@ components: contributor: description: Description not available items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasInputVariable: description: Variable that is used as input for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array hasModelResultTable: @@ -12622,13 +12843,13 @@ components: hasSampleVisualization: description: Description not available items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array hasCausalDiagram: description: Diagram associated to a model configuration items: - $ref: '#/components/schemas/CausalDiagram' + $ref: "#/components/schemas/CausalDiagram" nullable: true type: array memoryRequirements: @@ -12656,7 +12877,8 @@ components: nullable: true type: array parameterization: - description: Were there any simplifications made to processes to make the + description: + Were there any simplifications made to processes to make the model more efficient items: type: string @@ -12695,7 +12917,7 @@ components: hasParameter: description: Description not available items: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" nullable: true type: array operatingSystems: @@ -12713,25 +12935,25 @@ components: hasEquation: description: Equations used in the model items: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" nullable: true type: array usefulForCalculatingIndex: description: Description not available items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasInput: description: Description not available items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array hasOutputVariable: description: Variable that is used as output for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array title: ModelConfiguration @@ -12778,13 +13000,13 @@ components: hasDataTransformation: description: Description not available items: - $ref: '#/components/schemas/DataTransformation' + $ref: "#/components/schemas/DataTransformation" nullable: true type: array hasPresentation: description: Description not available items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array label: @@ -12802,7 +13024,7 @@ components: hasFixedResource: description: Description not available items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" nullable: true type: array hasCoordinateSystem: @@ -12821,11 +13043,12 @@ components: isTransformedFrom: description: Description not available items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array hasShape: - description: "Grids may be: rectangular, triangular, hexagonal, hybrid,\ + description: + "Grids may be: rectangular, triangular, hexagonal, hybrid,\ \ unstructured, block structure, etc." items: type: string @@ -12841,7 +13064,7 @@ components: hasDataTransformationSetup: description: Description not available items: - $ref: '#/components/schemas/DataTransformationSetup' + $ref: "#/components/schemas/DataTransformationSetup" nullable: true type: array position: @@ -12858,7 +13081,8 @@ components: title: SpatiallyDistributedGrid type: object ModelCategory: - description: "Class used to represent a category of a model (e.g., Hydrology,\ + description: + "Class used to represent a category of a model (e.g., Hydrology,\ \ Agriculture, etc.)" example: value: @@ -12873,7 +13097,7 @@ components: parentCategory: description: Indicates this subcategory parent category items: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" nullable: true type: array id: @@ -12931,7 +13155,8 @@ components: title: SampleExecution type: object TimeInterval: - description: "Time interval at which a model produces output. For example, a\ + description: + "Time interval at which a model produces output. For example, a\ \ model may produce outputs for every simulated day, hour, etc." example: value: @@ -12940,7 +13165,7 @@ components: intervalUnit: description: "Unit used in an interval (e.g., month)" items: - $ref: '#/components/schemas/Unit' + $ref: "#/components/schemas/Unit" nullable: true type: array description: @@ -12966,10 +13191,11 @@ components: nullable: true type: array intervalValue: - description: "Value used in the time interval of a model (e.g., 1 month,\ + description: + "Value used in the time interval of a model (e.g., 1 month,\ \ 5 days, 'harvest cycle')" items: - $ref: '#/components/schemas/TimeInterval_intervalValue_inner' + $ref: "#/components/schemas/TimeInterval_intervalValue_inner" nullable: true type: array title: TimeInterval @@ -12981,7 +13207,8 @@ components: id: some_id properties: hasDownloadInstructions: - description: "Instructions needed to download a software component. The\ + description: + "Instructions needed to download a software component. The\ \ difference with `hasDownloadURL` is that this property captures the\ \ human readable instructions required to download software. For example,\ \ sometimes an authentication is needed, users need to fill in a form,\ @@ -13003,7 +13230,8 @@ components: nullable: true type: array hasImplementationScriptLocation: - description: Property that points to the main runnable script for the current + description: + Property that points to the main runnable script for the current function items: type: string @@ -13028,23 +13256,25 @@ components: nullable: true type: array hasInstallationInstructions: - description: Instructions required to install this particular piece of software. + description: + Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. items: type: string nullable: true type: array compatibleVisualizationSoftware: - description: Property that links a software component to other useful software + description: + Property that links a software component to other useful software that canbe used to visualize its outputs items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Copyright holder for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -13054,20 +13284,22 @@ components: nullable: true type: array logo: - description: Property that links to the image used as logo for a software + description: + Property that links to the image used as logo for a software component items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Contact person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array tag: - description: "Tag used to annotate a version or a software configuration.\ + description: + "Tag used to annotate a version or a software configuration.\ \ This annotation is useful to show which version is the latest, or which\ \ version is deprecated. Supported tags are: \"latest\", \"deprecated\"" items: @@ -13087,41 +13319,45 @@ components: hasSampleExecution: description: Property pointing to a sample execution of a software configuration items: - $ref: '#/components/schemas/SampleExecution' + $ref: "#/components/schemas/SampleExecution" nullable: true type: array hasSampleResult: - description: Property designed to link a software configuration to a sample + description: + Property designed to link a software configuration to a sample resource resulting from its execution items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" nullable: true type: array author: description: The creator of a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array wasDerivedFromSetup: - description: Property that links a setup to a previous version of that setup. + description: + Property that links a setup to a previous version of that setup. This property is needed (for example) when creating snapshots of setups. items: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" nullable: true type: array hasConstraint: - description: "Constraint or rule associated to a software configuration.\ + description: + "Constraint or rule associated to a software configuration.\ \ For example: \"This model accepts only monthly data\", or \"all inputs\ \ of this model configuration must share the same location\". More structured\ \ restrictions, such as Jena rules or SWRL rules may also be captured\ \ with this property" items: - $ref: '#/components/schemas/Constraint' + $ref: "#/components/schemas/Constraint" nullable: true type: array hasBuildFile: - description: "A file (e.g., Dockerfile) with executable instructions indicating\ + description: + "A file (e.g., Dockerfile) with executable instructions indicating\ \ how a Software Image or a Software component is built" items: type: string @@ -13152,42 +13388,47 @@ components: nullable: true type: array hasSourceCode: - description: Property designed to link a software with its software source + description: + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasSetup: - description: Property used to define configurations with some fixed resources + description: + Property used to define configurations with some fixed resources and values. The rationale of this property is to allow predefined configurations items: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" nullable: true type: array hasExample: - description: An example explaining a scenario where the software component + description: + An example explaining a scenario where the software component was used in plain language. items: type: string nullable: true type: array publisher: - description: Publisher organization or person responsible for a software + description: + Publisher organization or person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasOutput: description: Property that expresses what are the outputs of a model items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array status: - description: "Data property to indicate the status of a configuration setups.\ + description: + "Data property to indicate the status of a configuration setups.\ \ For example, to indicate that a setup has been executed in a platform,\ \ that the setup should notbe shown to users (it's an auxiliary setup),\ \ etc." @@ -13204,11 +13445,12 @@ components: hasFunding: description: Property that links a software project to its funding information items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array hasComponentLocation: - description: "Location of the aggregation of all the files needed to execute\ + description: + "Location of the aggregation of all the files needed to execute\ \ the component. Usually a zip file including the run script and support\ \ scripts, including specification files" items: @@ -13216,17 +13458,19 @@ components: nullable: true type: array supportDetails: - description: "Property to link details, such as mailing lists in case a\ + description: + "Property to link details, such as mailing lists in case a\ \ contact person is not provided" items: type: string nullable: true type: array hasVersion: - description: Property designed to link a software component with its corresponding + description: + Property designed to link a software component with its corresponding versions items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -13250,15 +13494,17 @@ components: screenshot: description: Image illustrating a snapshot of the target software items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hadPrimarySource: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." items: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." type: object @@ -13273,7 +13519,7 @@ components: hasSoftwareImage: description: Function to link a function with its corresponding container items: - $ref: '#/components/schemas/SoftwareImage' + $ref: "#/components/schemas/SoftwareImage" maxItems: 1 nullable: true type: array @@ -13286,18 +13532,20 @@ components: contributor: description: Contributor to a software component items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasPurpose: - description: Objective or main functionality that can be achieved by running + description: + Objective or main functionality that can be achieved by running this software items: type: string nullable: true type: array hasExecutableInstructions: - description: "Instructions that indicate how a software component should\ + description: + "Instructions that indicate how a software component should\ \ be executed. The difference with `hasExecutionCommand` is that the execution\ \ instructions aim to be human-readable, and have explanations between\ \ the different commands and instructions" @@ -13308,7 +13556,7 @@ components: hasSampleVisualization: description: A typical sample visualization of the softwware outputs items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array memoryRequirements: @@ -13338,11 +13586,12 @@ components: adjustableParameter: description: Parameter that can be adjusted in a configuration setup items: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" nullable: true type: array hasUsageNotes: - description: "Property that describes the usage considerations of a particular\ + description: + "Property that describes the usage considerations of a particular\ \ software. These notes capture the rationale of for that software configuration,\ \ along with an explanation for sample inputs, things to consider when\ \ running the model with data, etc." @@ -13351,7 +13600,8 @@ components: nullable: true type: array hasSupportScriptLocation: - description: Property that links to the location of scripts that may be + description: + Property that links to the location of scripts that may be used from the main runnable script. items: type: string @@ -13370,7 +13620,8 @@ components: nullable: true type: array hasAssumption: - description: "Assumptions of a software, e.g. the solver being used for\ + description: + "Assumptions of a software, e.g. the solver being used for\ \ a particular model, the source of the data (e.g., all data must have\ \ a given resolution), etc." items: @@ -13380,7 +13631,7 @@ components: hasParameter: description: Property that indicates the parameters of a model configuration items: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" nullable: true type: array operatingSystems: @@ -13390,7 +13641,8 @@ components: nullable: true type: array hasExecutableNotebook: - description: "Property that links a software component with an executable\ + description: + "Property that links a software component with an executable\ \ notebook (e.g., Jupyter notebook) that illustrates how to use it in\ \ an executable manner." items: @@ -13398,19 +13650,21 @@ components: nullable: true type: array usefulForCalculatingIndex: - description: Property that indicates that a software component (or any of + description: + Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasInput: - description: Property that links a model configuration to the input types + description: + Property that links a model configuration to the input types expected by it. items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array title: ConfigurationSetup @@ -13422,7 +13676,8 @@ components: id: some_id properties: hasDimensionality: - description: Property to indicate dimensionality of the input or output + description: + Property to indicate dimensionality of the input or output of a dataset specification items: format: int32 @@ -13436,7 +13691,8 @@ components: nullable: true type: array pathLocation: - description: "Property that indicates the relative path of an input or output\ + description: + "Property that indicates the relative path of an input or output\ \ with respect to the folder structure of the executable. \n\nFor example,\ \ let's assume we have an input that has to exist in the folder `/datasets`\ \ or the executable will not work. This property ensures that this knowledge\ @@ -13463,18 +13719,20 @@ components: nullable: true type: array hasDataTransformation: - description: Property that associates an input/output with their corresponding + description: + Property that associates an input/output with their corresponding data transformation. items: - $ref: '#/components/schemas/DataTransformation' + $ref: "#/components/schemas/DataTransformation" nullable: true type: array hasPresentation: - description: Property that links an instance of a dataset (or a dataset + description: + Property that links an instance of a dataset (or a dataset specification) to the presentation of a variable contained (or expected to be contained) on it. items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array label: @@ -13490,32 +13748,36 @@ components: nullable: true type: array hasFixedResource: - description: "Property that links a parameter or an input to a fixed value.\ + description: + "Property that links a parameter or an input to a fixed value.\ \ For example, in a given configuration a parameter with the planting\ \ date for a model could be fixed to avoid the user changing it for that\ \ region." items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" nullable: true type: array isTransformedFrom: - description: "Property that links a dataset specification from a model configuration\ + description: + "Property that links a dataset specification from a model configuration\ \ or setup to the output from a target data transformation. This occurs\ \ when a data transformation produces several outputs, but only one of\ \ them is the one needed for a model" items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array hasDataTransformationSetup: - description: Property to link an input/output dataset to the specific data + description: + Property to link an input/output dataset to the specific data transformation (with URLs items: - $ref: '#/components/schemas/DataTransformationSetup' + $ref: "#/components/schemas/DataTransformationSetup" nullable: true type: array position: - description: Position of the parameter or input/output in the model configuration. + description: + Position of the parameter or input/output in the model configuration. This property is needed to know how to organize the I/O of the component on execution items: @@ -13554,7 +13816,7 @@ components: fundingSource: description: Link to the organization funding a software component items: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/Organization" nullable: true type: array type: @@ -13598,7 +13860,7 @@ components: hasGrid: description: Grid information about the model items: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" nullable: true type: array softwareRequirements: @@ -13628,13 +13890,13 @@ components: compatibleVisualizationSoftware: description: Description not available items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -13646,13 +13908,13 @@ components: logo: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array id: @@ -13660,7 +13922,8 @@ components: nullable: false type: string limitations: - description: Known restrictions (i.e. cases where the model is known not + description: + Known restrictions (i.e. cases where the model is known not to be reliable or shouldn't be used) items: type: string @@ -13675,7 +13938,7 @@ components: author: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasBuildFile: @@ -13711,14 +13974,14 @@ components: hasSourceCode: description: Description not available items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasExplanationDiagram: description: Diagram used to explain the behavior of the model items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasExample: @@ -13730,11 +13993,12 @@ components: publisher: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array runtimeEstimation: - description: An estimate of the time required to run example codes or other + description: + An estimate of the time required to run example codes or other known configurations items: type: string @@ -13749,14 +14013,15 @@ components: hasFunding: description: Description not available items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array hasProcess: - description: Property that indicates which physical processes (if any) are + description: + Property that indicates which physical processes (if any) are associated with a model items: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" nullable: true type: array supportDetails: @@ -13768,7 +14033,7 @@ components: hasVersion: description: Description not available items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -13792,13 +14057,13 @@ components: screenshot: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasModelCategory: description: "Category associated with a model (e.g., Hydrology, etc.)" items: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" nullable: true type: array hadPrimarySource: @@ -13823,13 +14088,13 @@ components: contributor: description: Description not available items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasInputVariable: description: Variable that is used as input for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array hasPurpose: @@ -13847,7 +14112,7 @@ components: hasSampleVisualization: description: Description not available items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array memoryRequirements: @@ -13875,7 +14140,8 @@ components: nullable: true type: array parameterization: - description: Were there any simplifications made to processes to make the + description: + Were there any simplifications made to processes to make the model more efficient items: type: string @@ -13920,25 +14186,26 @@ components: hasEquation: description: Equations used in the model items: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" nullable: true type: array usefulForCalculatingIndex: description: Description not available items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasOutputVariable: description: Variable that is used as output for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array title: HybridModel type: object Equation: - description: Information about the mathematical representation used in a model + description: + Information about the mathematical representation used in a model or model configuration example: value: @@ -13969,7 +14236,8 @@ components: title: Equation type: object CausalDiagram: - description: Diagram information with the processes and variables associated + description: + Diagram information with the processes and variables associated with a model configuration example: value: @@ -13978,7 +14246,7 @@ components: hasDiagramPart: description: Property that links a causal diagram with its constituent nodes items: - $ref: '#/components/schemas/CausalDiagram_hasDiagramPart_inner' + $ref: "#/components/schemas/CausalDiagram_hasDiagramPart_inner" nullable: true type: array description: @@ -14012,7 +14280,8 @@ components: id: some_id properties: hasDownloadInstructions: - description: "Instructions needed to download a software component. The\ + description: + "Instructions needed to download a software component. The\ \ difference with `hasDownloadURL` is that this property captures the\ \ human readable instructions required to download software. For example,\ \ sometimes an authentication is needed, users need to fill in a form,\ @@ -14034,7 +14303,8 @@ components: nullable: true type: array hasImplementationScriptLocation: - description: Property that points to the main runnable script for the current + description: + Property that points to the main runnable script for the current function items: type: string @@ -14059,23 +14329,25 @@ components: nullable: true type: array hasInstallationInstructions: - description: Instructions required to install this particular piece of software. + description: + Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. items: type: string nullable: true type: array compatibleVisualizationSoftware: - description: Property that links a software component to other useful software + description: + Property that links a software component to other useful software that canbe used to visualize its outputs items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Copyright holder for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -14085,20 +14357,22 @@ components: nullable: true type: array logo: - description: Property that links to the image used as logo for a software + description: + Property that links to the image used as logo for a software component items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Contact person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array tag: - description: "Tag used to annotate a version or a software configuration.\ + description: + "Tag used to annotate a version or a software configuration.\ \ This annotation is useful to show which version is the latest, or which\ \ version is deprecated. Supported tags are: \"latest\", \"deprecated\"" items: @@ -14118,34 +14392,37 @@ components: hasSampleExecution: description: Property pointing to a sample execution of a software configuration items: - $ref: '#/components/schemas/SampleExecution' + $ref: "#/components/schemas/SampleExecution" nullable: true type: array hasSampleResult: - description: Property designed to link a software configuration to a sample + description: + Property designed to link a software configuration to a sample resource resulting from its execution items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" nullable: true type: array author: description: The creator of a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasConstraint: - description: "Constraint or rule associated to a software configuration.\ + description: + "Constraint or rule associated to a software configuration.\ \ For example: \"This model accepts only monthly data\", or \"all inputs\ \ of this model configuration must share the same location\". More structured\ \ restrictions, such as Jena rules or SWRL rules may also be captured\ \ with this property" items: - $ref: '#/components/schemas/Constraint' + $ref: "#/components/schemas/Constraint" nullable: true type: array hasBuildFile: - description: "A file (e.g., Dockerfile) with executable instructions indicating\ + description: + "A file (e.g., Dockerfile) with executable instructions indicating\ \ how a Software Image or a Software component is built" items: type: string @@ -14176,38 +14453,42 @@ components: nullable: true type: array hasSourceCode: - description: Property designed to link a software with its software source + description: + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasSetup: - description: Property used to define configurations with some fixed resources + description: + Property used to define configurations with some fixed resources and values. The rationale of this property is to allow predefined configurations items: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" nullable: true type: array hasExample: - description: An example explaining a scenario where the software component + description: + An example explaining a scenario where the software component was used in plain language. items: type: string nullable: true type: array publisher: - description: Publisher organization or person responsible for a software + description: + Publisher organization or person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasOutput: description: Property that expresses what are the outputs of a model items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array doi: @@ -14219,11 +14500,12 @@ components: hasFunding: description: Property that links a software project to its funding information items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array hasComponentLocation: - description: "Location of the aggregation of all the files needed to execute\ + description: + "Location of the aggregation of all the files needed to execute\ \ the component. Usually a zip file including the run script and support\ \ scripts, including specification files" items: @@ -14231,17 +14513,19 @@ components: nullable: true type: array supportDetails: - description: "Property to link details, such as mailing lists in case a\ + description: + "Property to link details, such as mailing lists in case a\ \ contact person is not provided" items: type: string nullable: true type: array hasVersion: - description: Property designed to link a software component with its corresponding + description: + Property designed to link a software component with its corresponding versions items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -14265,15 +14549,17 @@ components: screenshot: description: Image illustrating a snapshot of the target software items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hadPrimarySource: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." items: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." type: object @@ -14288,7 +14574,7 @@ components: hasSoftwareImage: description: Function to link a function with its corresponding container items: - $ref: '#/components/schemas/SoftwareImage' + $ref: "#/components/schemas/SoftwareImage" maxItems: 1 nullable: true type: array @@ -14301,18 +14587,20 @@ components: contributor: description: Contributor to a software component items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasPurpose: - description: Objective or main functionality that can be achieved by running + description: + Objective or main functionality that can be achieved by running this software items: type: string nullable: true type: array hasExecutableInstructions: - description: "Instructions that indicate how a software component should\ + description: + "Instructions that indicate how a software component should\ \ be executed. The difference with `hasExecutionCommand` is that the execution\ \ instructions aim to be human-readable, and have explanations between\ \ the different commands and instructions" @@ -14323,7 +14611,7 @@ components: hasSampleVisualization: description: A typical sample visualization of the softwware outputs items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array memoryRequirements: @@ -14351,7 +14639,8 @@ components: nullable: true type: array hasUsageNotes: - description: "Property that describes the usage considerations of a particular\ + description: + "Property that describes the usage considerations of a particular\ \ software. These notes capture the rationale of for that software configuration,\ \ along with an explanation for sample inputs, things to consider when\ \ running the model with data, etc." @@ -14360,7 +14649,8 @@ components: nullable: true type: array hasSupportScriptLocation: - description: Property that links to the location of scripts that may be + description: + Property that links to the location of scripts that may be used from the main runnable script. items: type: string @@ -14379,7 +14669,8 @@ components: nullable: true type: array hasAssumption: - description: "Assumptions of a software, e.g. the solver being used for\ + description: + "Assumptions of a software, e.g. the solver being used for\ \ a particular model, the source of the data (e.g., all data must have\ \ a given resolution), etc." items: @@ -14389,7 +14680,7 @@ components: hasParameter: description: Property that indicates the parameters of a model configuration items: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" nullable: true type: array operatingSystems: @@ -14399,7 +14690,8 @@ components: nullable: true type: array hasExecutableNotebook: - description: "Property that links a software component with an executable\ + description: + "Property that links a software component with an executable\ \ notebook (e.g., Jupyter notebook) that illustrates how to use it in\ \ an executable manner." items: @@ -14407,42 +14699,47 @@ components: nullable: true type: array usefulForCalculatingIndex: - description: Property that indicates that a software component (or any of + description: + Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasInput: - description: Property that links a model configuration to the input types + description: + Property that links a model configuration to the input types expected by it. items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array title: SoftwareConfiguration type: object SampleCollection: - description: A collection of resources that are used as sample for running a + description: + A collection of resources that are used as sample for running a sfoware component multiple times example: value: id: some_id properties: dataCatalogIdentifier: - description: An identifier for resources with metadata entries in a data + description: + An identifier for resources with metadata entries in a data catalog items: type: string nullable: true type: array hasPart: - description: Property designed to reference the elements included in a sample + description: + Property designed to reference the elements included in a sample collection. items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" nullable: true type: array description: @@ -14470,13 +14767,14 @@ components: value: description: Value associated to the described entity items: - $ref: '#/components/schemas/Visualization_value_inner' + $ref: "#/components/schemas/Visualization_value_inner" nullable: true type: array title: SampleCollection type: object PointBasedGrid: - description: A grid that is based on a series if points (or a single point). + description: + A grid that is based on a series if points (or a single point). Typically associated with point-based models example: value: @@ -14518,13 +14816,13 @@ components: hasDataTransformation: description: Description not available items: - $ref: '#/components/schemas/DataTransformation' + $ref: "#/components/schemas/DataTransformation" nullable: true type: array hasPresentation: description: Description not available items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array label: @@ -14542,7 +14840,7 @@ components: hasFixedResource: description: Description not available items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" nullable: true type: array hasCoordinateSystem: @@ -14561,11 +14859,12 @@ components: isTransformedFrom: description: Description not available items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array hasShape: - description: "Grids may be: rectangular, triangular, hexagonal, hybrid,\ + description: + "Grids may be: rectangular, triangular, hexagonal, hybrid,\ \ unstructured, block structure, etc." items: type: string @@ -14581,7 +14880,7 @@ components: hasDataTransformationSetup: description: Description not available items: - $ref: '#/components/schemas/DataTransformationSetup' + $ref: "#/components/schemas/DataTransformationSetup" nullable: true type: array position: @@ -14676,7 +14975,8 @@ components: title: SpatialResolution type: object SoftwareVersion: - description: A software version is a specificf type of software that represents + description: + A software version is a specificf type of software that represents a particular set of functionalities. New functionalities and error fixes may occur between software versions example: @@ -14684,7 +14984,8 @@ components: id: some_id properties: hasDownloadInstructions: - description: "Instructions needed to download a software component. The\ + description: + "Instructions needed to download a software component. The\ \ difference with `hasDownloadURL` is that this property captures the\ \ human readable instructions required to download software. For example,\ \ sometimes an authentication is needed, users need to fill in a form,\ @@ -14724,23 +15025,25 @@ components: nullable: true type: array hasInstallationInstructions: - description: Instructions required to install this particular piece of software. + description: + Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. items: type: string nullable: true type: array compatibleVisualizationSoftware: - description: Property that links a software component to other useful software + description: + Property that links a software component to other useful software that canbe used to visualize its outputs items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Copyright holder for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -14750,20 +15053,22 @@ components: nullable: true type: array logo: - description: Property that links to the image used as logo for a software + description: + Property that links to the image used as logo for a software component items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Contact person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array tag: - description: "Tag used to annotate a version or a software configuration.\ + description: + "Tag used to annotate a version or a software configuration.\ \ This annotation is useful to show which version is the latest, or which\ \ version is deprecated. Supported tags are: \"latest\", \"deprecated\"" items: @@ -14781,21 +15086,23 @@ components: nullable: true type: array hasConfiguration: - description: "Property that links a model to one of its configurations.\ + description: + "Property that links a model to one of its configurations.\ \ A model may have multiple configurations, each of which is unique in\ \ terms of the inputs and outputs it uses." items: - $ref: '#/components/schemas/SoftwareConfiguration' + $ref: "#/components/schemas/SoftwareConfiguration" nullable: true type: array author: description: The creator of a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasBuildFile: - description: "A file (e.g., Dockerfile) with executable instructions indicating\ + description: + "A file (e.g., Dockerfile) with executable instructions indicating\ \ how a Software Image or a Software component is built" items: type: string @@ -14820,25 +15127,28 @@ components: nullable: true type: array hasSourceCode: - description: Property designed to link a software with its software source + description: + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasExample: - description: An example explaining a scenario where the software component + description: + An example explaining a scenario where the software component was used in plain language. items: type: string nullable: true type: array publisher: - description: Publisher organization or person responsible for a software + description: + Publisher organization or person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array doi: @@ -14850,21 +15160,23 @@ components: hasFunding: description: Property that links a software project to its funding information items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array supportDetails: - description: "Property to link details, such as mailing lists in case a\ + description: + "Property to link details, such as mailing lists in case a\ \ contact person is not provided" items: type: string nullable: true type: array hasVersion: - description: Property designed to link a software component with its corresponding + description: + Property designed to link a software component with its corresponding versions items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -14888,15 +15200,17 @@ components: screenshot: description: Image illustrating a snapshot of the target software items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hadPrimarySource: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." items: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." type: object @@ -14917,18 +15231,20 @@ components: contributor: description: Contributor to a software component items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasPurpose: - description: Objective or main functionality that can be achieved by running + description: + Objective or main functionality that can be achieved by running this software items: type: string nullable: true type: array hasExecutableInstructions: - description: "Instructions that indicate how a software component should\ + description: + "Instructions that indicate how a software component should\ \ be executed. The difference with `hasExecutionCommand` is that the execution\ \ instructions aim to be human-readable, and have explanations between\ \ the different commands and instructions" @@ -14939,7 +15255,7 @@ components: hasSampleVisualization: description: A typical sample visualization of the softwware outputs items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array memoryRequirements: @@ -14967,7 +15283,8 @@ components: nullable: true type: array hasUsageNotes: - description: "Property that describes the usage considerations of a particular\ + description: + "Property that describes the usage considerations of a particular\ \ software. These notes capture the rationale of for that software configuration,\ \ along with an explanation for sample inputs, things to consider when\ \ running the model with data, etc." @@ -14988,7 +15305,8 @@ components: nullable: true type: array hasAssumption: - description: "Assumptions of a software, e.g. the solver being used for\ + description: + "Assumptions of a software, e.g. the solver being used for\ \ a particular model, the source of the data (e.g., all data must have\ \ a given resolution), etc." items: @@ -15002,7 +15320,8 @@ components: nullable: true type: array hasExecutableNotebook: - description: "Property that links a software component with an executable\ + description: + "Property that links a software component with an executable\ \ notebook (e.g., Jupyter notebook) that illustrates how to use it in\ \ an executable manner." items: @@ -15010,12 +15329,13 @@ components: nullable: true type: array usefulForCalculatingIndex: - description: Property that indicates that a software component (or any of + description: + Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasVersionId: @@ -15027,14 +15347,16 @@ components: title: SoftwareVersion type: object SoftwareImage: - description: "An image that virtualizes the functionality of a given software.\ + description: + "An image that virtualizes the functionality of a given software.\ \ For example, a Docker container." example: value: id: some_id properties: hasDownloadInstructions: - description: "Instructions needed to download a software component. The\ + description: + "Instructions needed to download a software component. The\ \ difference with `hasDownloadURL` is that this property captures the\ \ human readable instructions required to download software. For example,\ \ sometimes an authentication is needed, users need to fill in a form,\ @@ -15074,23 +15396,25 @@ components: nullable: true type: array hasInstallationInstructions: - description: Instructions required to install this particular piece of software. + description: + Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. items: type: string nullable: true type: array compatibleVisualizationSoftware: - description: Property that links a software component to other useful software + description: + Property that links a software component to other useful software that canbe used to visualize its outputs items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Copyright holder for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -15100,16 +15424,17 @@ components: nullable: true type: array logo: - description: Property that links to the image used as logo for a software + description: + Property that links to the image used as logo for a software component items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Contact person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array id: @@ -15125,11 +15450,12 @@ components: author: description: The creator of a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasBuildFile: - description: "A file (e.g., Dockerfile) with executable instructions indicating\ + description: + "A file (e.g., Dockerfile) with executable instructions indicating\ \ how a Software Image or a Software component is built" items: type: string @@ -15160,25 +15486,28 @@ components: nullable: true type: array hasSourceCode: - description: Property designed to link a software with its software source + description: + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasExample: - description: An example explaining a scenario where the software component + description: + An example explaining a scenario where the software component was used in plain language. items: type: string nullable: true type: array publisher: - description: Publisher organization or person responsible for a software + description: + Publisher organization or person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array doi: @@ -15190,21 +15519,23 @@ components: hasFunding: description: Property that links a software project to its funding information items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array supportDetails: - description: "Property to link details, such as mailing lists in case a\ + description: + "Property to link details, such as mailing lists in case a\ \ contact person is not provided" items: type: string nullable: true type: array hasVersion: - description: Property designed to link a software component with its corresponding + description: + Property designed to link a software component with its corresponding versions items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -15228,15 +15559,17 @@ components: screenshot: description: Image illustrating a snapshot of the target software items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hadPrimarySource: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." items: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." type: object @@ -15257,25 +15590,28 @@ components: contributor: description: Contributor to a software component items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array availableInRegistry: - description: "Property that indicates in which registry the software image\ + description: + "Property that indicates in which registry the software image\ \ being described can be found. For example, https://hub.docker.com" items: type: string nullable: true type: array hasPurpose: - description: Objective or main functionality that can be achieved by running + description: + Objective or main functionality that can be achieved by running this software items: type: string nullable: true type: array hasExecutableInstructions: - description: "Instructions that indicate how a software component should\ + description: + "Instructions that indicate how a software component should\ \ be executed. The difference with `hasExecutionCommand` is that the execution\ \ instructions aim to be human-readable, and have explanations between\ \ the different commands and instructions" @@ -15286,7 +15622,7 @@ components: hasSampleVisualization: description: A typical sample visualization of the softwware outputs items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array memoryRequirements: @@ -15314,7 +15650,8 @@ components: nullable: true type: array hasUsageNotes: - description: "Property that describes the usage considerations of a particular\ + description: + "Property that describes the usage considerations of a particular\ \ software. These notes capture the rationale of for that software configuration,\ \ along with an explanation for sample inputs, things to consider when\ \ running the model with data, etc." @@ -15335,7 +15672,8 @@ components: nullable: true type: array hasAssumption: - description: "Assumptions of a software, e.g. the solver being used for\ + description: + "Assumptions of a software, e.g. the solver being used for\ \ a particular model, the source of the data (e.g., all data must have\ \ a given resolution), etc." items: @@ -15349,7 +15687,8 @@ components: nullable: true type: array hasExecutableNotebook: - description: "Property that links a software component with an executable\ + description: + "Property that links a software component with an executable\ \ notebook (e.g., Jupyter notebook) that illustrates how to use it in\ \ an executable manner." items: @@ -15357,12 +15696,13 @@ components: nullable: true type: array usefulForCalculatingIndex: - description: Property that indicates that a software component (or any of + description: + Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array title: SoftwareImage @@ -15374,7 +15714,8 @@ components: id: some_id properties: hasDownloadInstructions: - description: "Instructions needed to download a software component. The\ + description: + "Instructions needed to download a software component. The\ \ difference with `hasDownloadURL` is that this property captures the\ \ human readable instructions required to download software. For example,\ \ sometimes an authentication is needed, users need to fill in a form,\ @@ -15396,7 +15737,8 @@ components: nullable: true type: array hasImplementationScriptLocation: - description: Property that points to the main runnable script for the current + description: + Property that points to the main runnable script for the current function items: type: string @@ -15421,23 +15763,25 @@ components: nullable: true type: array hasInstallationInstructions: - description: Instructions required to install this particular piece of software. + description: + Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. items: type: string nullable: true type: array compatibleVisualizationSoftware: - description: Property that links a software component to other useful software + description: + Property that links a software component to other useful software that canbe used to visualize its outputs items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Copyright holder for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -15447,20 +15791,22 @@ components: nullable: true type: array logo: - description: Property that links to the image used as logo for a software + description: + Property that links to the image used as logo for a software component items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Contact person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array tag: - description: "Tag used to annotate a version or a software configuration.\ + description: + "Tag used to annotate a version or a software configuration.\ \ This annotation is useful to show which version is the latest, or which\ \ version is deprecated. Supported tags are: \"latest\", \"deprecated\"" items: @@ -15480,34 +15826,37 @@ components: hasSampleExecution: description: Property pointing to a sample execution of a software configuration items: - $ref: '#/components/schemas/SampleExecution' + $ref: "#/components/schemas/SampleExecution" nullable: true type: array hasSampleResult: - description: Property designed to link a software configuration to a sample + description: + Property designed to link a software configuration to a sample resource resulting from its execution items: - $ref: '#/components/schemas/SampleResource' + $ref: "#/components/schemas/SampleResource" nullable: true type: array author: description: The creator of a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasConstraint: - description: "Constraint or rule associated to a software configuration.\ + description: + "Constraint or rule associated to a software configuration.\ \ For example: \"This model accepts only monthly data\", or \"all inputs\ \ of this model configuration must share the same location\". More structured\ \ restrictions, such as Jena rules or SWRL rules may also be captured\ \ with this property" items: - $ref: '#/components/schemas/Constraint' + $ref: "#/components/schemas/Constraint" nullable: true type: array hasBuildFile: - description: "A file (e.g., Dockerfile) with executable instructions indicating\ + description: + "A file (e.g., Dockerfile) with executable instructions indicating\ \ how a Software Image or a Software component is built" items: type: string @@ -15538,38 +15887,42 @@ components: nullable: true type: array hasSourceCode: - description: Property designed to link a software with its software source + description: + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasSetup: - description: Property used to define configurations with some fixed resources + description: + Property used to define configurations with some fixed resources and values. The rationale of this property is to allow predefined configurations items: - $ref: '#/components/schemas/ConfigurationSetup' + $ref: "#/components/schemas/ConfigurationSetup" nullable: true type: array hasExample: - description: An example explaining a scenario where the software component + description: + An example explaining a scenario where the software component was used in plain language. items: type: string nullable: true type: array publisher: - description: Publisher organization or person responsible for a software + description: + Publisher organization or person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasOutput: description: Property that expresses what are the outputs of a model items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array doi: @@ -15581,11 +15934,12 @@ components: hasFunding: description: Property that links a software project to its funding information items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array hasComponentLocation: - description: "Location of the aggregation of all the files needed to execute\ + description: + "Location of the aggregation of all the files needed to execute\ \ the component. Usually a zip file including the run script and support\ \ scripts, including specification files" items: @@ -15593,17 +15947,19 @@ components: nullable: true type: array supportDetails: - description: "Property to link details, such as mailing lists in case a\ + description: + "Property to link details, such as mailing lists in case a\ \ contact person is not provided" items: type: string nullable: true type: array hasVersion: - description: Property designed to link a software component with its corresponding + description: + Property designed to link a software component with its corresponding versions items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -15627,15 +15983,17 @@ components: screenshot: description: Image illustrating a snapshot of the target software items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hadPrimarySource: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." items: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." type: object @@ -15650,7 +16008,7 @@ components: hasSoftwareImage: description: Function to link a function with its corresponding container items: - $ref: '#/components/schemas/SoftwareImage' + $ref: "#/components/schemas/SoftwareImage" maxItems: 1 nullable: true type: array @@ -15663,18 +16021,20 @@ components: contributor: description: Contributor to a software component items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasPurpose: - description: Objective or main functionality that can be achieved by running + description: + Objective or main functionality that can be achieved by running this software items: type: string nullable: true type: array hasExecutableInstructions: - description: "Instructions that indicate how a software component should\ + description: + "Instructions that indicate how a software component should\ \ be executed. The difference with `hasExecutionCommand` is that the execution\ \ instructions aim to be human-readable, and have explanations between\ \ the different commands and instructions" @@ -15685,7 +16045,7 @@ components: hasSampleVisualization: description: A typical sample visualization of the softwware outputs items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array memoryRequirements: @@ -15713,7 +16073,8 @@ components: nullable: true type: array hasUsageNotes: - description: "Property that describes the usage considerations of a particular\ + description: + "Property that describes the usage considerations of a particular\ \ software. These notes capture the rationale of for that software configuration,\ \ along with an explanation for sample inputs, things to consider when\ \ running the model with data, etc." @@ -15722,7 +16083,8 @@ components: nullable: true type: array hasSupportScriptLocation: - description: Property that links to the location of scripts that may be + description: + Property that links to the location of scripts that may be used from the main runnable script. items: type: string @@ -15741,7 +16103,8 @@ components: nullable: true type: array hasAssumption: - description: "Assumptions of a software, e.g. the solver being used for\ + description: + "Assumptions of a software, e.g. the solver being used for\ \ a particular model, the source of the data (e.g., all data must have\ \ a given resolution), etc." items: @@ -15751,7 +16114,7 @@ components: hasParameter: description: Property that indicates the parameters of a model configuration items: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" nullable: true type: array operatingSystems: @@ -15761,7 +16124,8 @@ components: nullable: true type: array hasExecutableNotebook: - description: "Property that links a software component with an executable\ + description: + "Property that links a software component with an executable\ \ notebook (e.g., Jupyter notebook) that illustrates how to use it in\ \ an executable manner." items: @@ -15769,25 +16133,28 @@ components: nullable: true type: array usefulForCalculatingIndex: - description: Property that indicates that a software component (or any of + description: + Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasInput: - description: Property that links a model configuration to the input types + description: + Property that links a model configuration to the input types expected by it. items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array title: DataTransformation type: object NumericalIndex: - description: A number (such as a ratio) derived from a series of observations + description: + A number (such as a ratio) derived from a series of observations and used as an indicator or measure (https://www.merriam-webster.com/dictionary/index) example: value: @@ -15796,7 +16163,7 @@ components: hasStandardVariable: description: the standard name of a variable items: - $ref: '#/components/schemas/StandardVariable' + $ref: "#/components/schemas/StandardVariable" maxItems: 1 nullable: true type: array @@ -15825,7 +16192,8 @@ components: title: NumericalIndex type: object Model: - description: "A mathematical description of a process (e.g., hydrological, agricultural,\ + description: + "A mathematical description of a process (e.g., hydrological, agricultural,\ \ social, etc.)" example: value: @@ -15852,7 +16220,7 @@ components: hasGrid: description: Grid information about the model items: - $ref: '#/components/schemas/Grid' + $ref: "#/components/schemas/Grid" nullable: true type: array softwareRequirements: @@ -15882,13 +16250,13 @@ components: compatibleVisualizationSoftware: description: Description not available items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -15900,13 +16268,13 @@ components: logo: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array id: @@ -15914,7 +16282,8 @@ components: nullable: false type: string limitations: - description: Known restrictions (i.e. cases where the model is known not + description: + Known restrictions (i.e. cases where the model is known not to be reliable or shouldn't be used) items: type: string @@ -15929,7 +16298,7 @@ components: author: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasBuildFile: @@ -15965,14 +16334,14 @@ components: hasSourceCode: description: Description not available items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasExplanationDiagram: description: Diagram used to explain the behavior of the model items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasExample: @@ -15984,11 +16353,12 @@ components: publisher: description: Description not available items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array runtimeEstimation: - description: An estimate of the time required to run example codes or other + description: + An estimate of the time required to run example codes or other known configurations items: type: string @@ -16003,14 +16373,15 @@ components: hasFunding: description: Description not available items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array hasProcess: - description: Property that indicates which physical processes (if any) are + description: + Property that indicates which physical processes (if any) are associated with a model items: - $ref: '#/components/schemas/Process' + $ref: "#/components/schemas/Process" nullable: true type: array supportDetails: @@ -16022,7 +16393,7 @@ components: hasVersion: description: Description not available items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -16046,13 +16417,13 @@ components: screenshot: description: Description not available items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasModelCategory: description: "Category associated with a model (e.g., Hydrology, etc.)" items: - $ref: '#/components/schemas/ModelCategory' + $ref: "#/components/schemas/ModelCategory" nullable: true type: array hadPrimarySource: @@ -16077,13 +16448,13 @@ components: contributor: description: Description not available items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array hasInputVariable: description: Variable that is used as input for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array hasPurpose: @@ -16101,7 +16472,7 @@ components: hasSampleVisualization: description: Description not available items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array memoryRequirements: @@ -16129,7 +16500,8 @@ components: nullable: true type: array parameterization: - description: Were there any simplifications made to processes to make the + description: + Were there any simplifications made to processes to make the model more efficient items: type: string @@ -16174,19 +16546,19 @@ components: hasEquation: description: Equations used in the model items: - $ref: '#/components/schemas/Equation' + $ref: "#/components/schemas/Equation" nullable: true type: array usefulForCalculatingIndex: description: Description not available items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array hasOutputVariable: description: Variable that is used as output for this model items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array title: Model @@ -16198,7 +16570,8 @@ components: id: some_id properties: dataCatalogIdentifier: - description: An identifier for resources with metadata entries in a data + description: + An identifier for resources with metadata entries in a data catalog items: type: string @@ -16229,7 +16602,7 @@ components: value: description: Value associated to the described entity items: - $ref: '#/components/schemas/Visualization_value_inner' + $ref: "#/components/schemas/Visualization_value_inner" nullable: true type: array title: SampleResource @@ -16243,13 +16616,13 @@ components: hasDefaultValue: description: Default accepted value of a variable presentation (or a parameter) items: - $ref: '#/components/schemas/Visualization_value_inner' + $ref: "#/components/schemas/Visualization_value_inner" nullable: true type: array hasMaximumAcceptedValue: description: Maximum accepted value of a variable presentation (or a parameter) items: - $ref: '#/components/schemas/CatalogIdentifier_hasMaximumAcceptedValue_inner' + $ref: "#/components/schemas/CatalogIdentifier_hasMaximumAcceptedValue_inner" nullable: true type: array description: @@ -16267,15 +16640,16 @@ components: hasFixedValue: description: Value of a parameter in a software setup. items: - $ref: '#/components/schemas/Visualization_value_inner' + $ref: "#/components/schemas/Visualization_value_inner" nullable: true type: array hasPresentation: - description: Property that links an instance of a dataset (or a dataset + description: + Property that links an instance of a dataset (or a dataset specification) to the presentation of a variable contained (or expected to be contained) on it. items: - $ref: '#/components/schemas/VariablePresentation' + $ref: "#/components/schemas/VariablePresentation" nullable: true type: array label: @@ -16285,7 +16659,8 @@ components: nullable: true type: array recommendedIncrement: - description: "Value that represents how a parameter should be incremented\ + description: + "Value that represents how a parameter should be incremented\ \ on each iteration of a software component execution. This value is important\ \ when preparing execution ensembles automatically, e.g., simulating crop\ \ production varying the parameter \"fertilizer amount\" in increments\ @@ -16303,11 +16678,12 @@ components: hasMinimumAcceptedValue: description: Minimum accepted value of a variable presentation (or a parameter) items: - $ref: '#/components/schemas/CatalogIdentifier_hasMaximumAcceptedValue_inner' + $ref: "#/components/schemas/CatalogIdentifier_hasMaximumAcceptedValue_inner" nullable: true type: array hasAcceptedValues: - description: "Property that constraints which values are accepted for a\ + description: + "Property that constraints which values are accepted for a\ \ parameter. For example, the name of a crop can only be \"Maize\" or\ \ \"Sorghum\"" items: @@ -16315,23 +16691,25 @@ components: nullable: true type: array adjustsVariable: - description: "Property that links parameter with the variable they adjust.\ + description: + "Property that links parameter with the variable they adjust.\ \ This property can be used when parameters quantify variables without\ \ directly representing them. For example, a \"fertilizer percentage adjustment\"\ \ parameter can quantify a \"fertilizer price\" variable" items: - $ref: '#/components/schemas/Variable' + $ref: "#/components/schemas/Variable" maxItems: 1 nullable: true type: array relevantForIntervention: description: Description not available items: - $ref: '#/components/schemas/Intervention' + $ref: "#/components/schemas/Intervention" nullable: true type: array position: - description: Position of the parameter or input/output in the model configuration. + description: + Position of the parameter or input/output in the model configuration. This property is needed to know how to organize the I/O of the component on execution items: @@ -16344,15 +16722,17 @@ components: nullable: false type: string usesUnit: - description: Property used to link a variable presentation or time interval + description: + Property used to link a variable presentation or time interval to the unit they are represented in items: - $ref: '#/components/schemas/Unit' + $ref: "#/components/schemas/Unit" maxItems: 1 nullable: true type: array hasStepSize: - description: "Property that determines what are the increments (step size)\ + description: + "Property that determines what are the increments (step size)\ \ that are commonly used to vary a parameter. This is commonly used for\ \ automatically setting up software tests. For example, if I want to set\ \ up a model and try 30 reasonable values on a parameter, I may use the\ @@ -16366,7 +16746,8 @@ components: title: Parameter type: object Region: - description: An area or division with some characteristics but not always fixed + description: + An area or division with some characteristics but not always fixed boundaries example: value: @@ -16375,13 +16756,13 @@ components: geo: description: Specific coordinates or shape associated with a region items: - $ref: '#/components/schemas/Region_geo_inner' + $ref: "#/components/schemas/Region_geo_inner" nullable: true type: array partOf: description: Indicates whether a region is part of another region items: - $ref: '#/components/schemas/Region' + $ref: "#/components/schemas/Region" nullable: true type: array description: @@ -16417,11 +16798,12 @@ components: hasDefaultValue: description: Default accepted value of a variable presentation (or a parameter) items: - $ref: '#/components/schemas/Visualization_value_inner' + $ref: "#/components/schemas/Visualization_value_inner" nullable: true type: array hasShortName: - description: "A short name (e.g., temperature) capturing the high-level\ + description: + "A short name (e.g., temperature) capturing the high-level\ \ concept of the variable" items: type: string @@ -16430,20 +16812,20 @@ components: hasMinimumAcceptedValue: description: Minimum accepted value of a variable presentation (or a parameter) items: - $ref: '#/components/schemas/CatalogIdentifier_hasMaximumAcceptedValue_inner' + $ref: "#/components/schemas/CatalogIdentifier_hasMaximumAcceptedValue_inner" nullable: true type: array hasStandardVariable: description: the standard name of a variable items: - $ref: '#/components/schemas/StandardVariable' + $ref: "#/components/schemas/StandardVariable" maxItems: 1 nullable: true type: array hasMaximumAcceptedValue: description: Maximum accepted value of a variable presentation (or a parameter) items: - $ref: '#/components/schemas/CatalogIdentifier_hasMaximumAcceptedValue_inner' + $ref: "#/components/schemas/CatalogIdentifier_hasMaximumAcceptedValue_inner" nullable: true type: array description: @@ -16453,10 +16835,11 @@ components: nullable: true type: array partOfDataset: - description: Associates a presentation with a dataset where the presentation + description: + Associates a presentation with a dataset where the presentation occurs items: - $ref: '#/components/schemas/DatasetSpecification' + $ref: "#/components/schemas/DatasetSpecification" nullable: true type: array id: @@ -16470,10 +16853,11 @@ components: nullable: true type: array usesUnit: - description: Property used to link a variable presentation or time interval + description: + Property used to link a variable presentation or time interval to the unit they are represented in items: - $ref: '#/components/schemas/Unit' + $ref: "#/components/schemas/Unit" maxItems: 1 nullable: true type: array @@ -16484,7 +16868,8 @@ components: nullable: true type: array hasLongName: - description: "Properties that relate the variable representation to its\ + description: + "Properties that relate the variable representation to its\ \ long name. The long name is useful for context (e.g., precipitation\ \ is less ambiguous than P) but not as precise as the standard name." items: @@ -16500,7 +16885,8 @@ components: id: some_id properties: hasDownloadInstructions: - description: "Instructions needed to download a software component. The\ + description: + "Instructions needed to download a software component. The\ \ difference with `hasDownloadURL` is that this property captures the\ \ human readable instructions required to download software. For example,\ \ sometimes an authentication is needed, users need to fill in a form,\ @@ -16512,7 +16898,7 @@ components: hasFunding: description: Property that links a software project to its funding information items: - $ref: '#/components/schemas/FundingInformation' + $ref: "#/components/schemas/FundingInformation" nullable: true type: array keywords: @@ -16528,7 +16914,8 @@ components: nullable: true type: array supportDetails: - description: "Property to link details, such as mailing lists in case a\ + description: + "Property to link details, such as mailing lists in case a\ \ contact person is not provided" items: type: string @@ -16541,10 +16928,11 @@ components: nullable: true type: array hasVersion: - description: Property designed to link a software component with its corresponding + description: + Property designed to link a software component with its corresponding versions items: - $ref: '#/components/schemas/SoftwareVersion' + $ref: "#/components/schemas/SoftwareVersion" nullable: true type: array hasTypicalDataSource: @@ -16574,7 +16962,7 @@ components: screenshot: description: Image illustrating a snapshot of the target software items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array type: @@ -16584,18 +16972,21 @@ components: nullable: true type: array hasInstallationInstructions: - description: Instructions required to install this particular piece of software. + description: + Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner. items: type: string nullable: true type: array hadPrimarySource: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." items: - description: "Property to identify the original source of the information\ + description: + "Property to identify the original source of the information\ \ of the annotated resource. It could be a web page, an organization,\ \ a person, some experiment notes, etc." type: object @@ -16616,20 +17007,21 @@ components: contributor: description: Contributor to a software component items: - $ref: '#/components/schemas/Person' + $ref: "#/components/schemas/Person" nullable: true type: array compatibleVisualizationSoftware: - description: Property that links a software component to other useful software + description: + Property that links a software component to other useful software that canbe used to visualize its outputs items: - $ref: '#/components/schemas/Software' + $ref: "#/components/schemas/Software" nullable: true type: array copyrightHolder: description: Copyright holder for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasFAQ: @@ -16639,20 +17031,22 @@ components: nullable: true type: array logo: - description: Property that links to the image used as logo for a software + description: + Property that links to the image used as logo for a software component items: - $ref: '#/components/schemas/Image' + $ref: "#/components/schemas/Image" nullable: true type: array hasContactPerson: description: Contact person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array hasPurpose: - description: Objective or main functionality that can be achieved by running + description: + Objective or main functionality that can be achieved by running this software items: type: string @@ -16663,7 +17057,8 @@ components: nullable: false type: string hasExecutableInstructions: - description: "Instructions that indicate how a software component should\ + description: + "Instructions that indicate how a software component should\ \ be executed. The difference with `hasExecutionCommand` is that the execution\ \ instructions aim to be human-readable, and have explanations between\ \ the different commands and instructions" @@ -16674,7 +17069,7 @@ components: hasSampleVisualization: description: A typical sample visualization of the softwware outputs items: - $ref: '#/components/schemas/Visualization' + $ref: "#/components/schemas/Visualization" nullable: true type: array identifier: @@ -16704,7 +17099,7 @@ components: author: description: The creator of a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array processorRequirements: @@ -16714,7 +17109,8 @@ components: nullable: true type: array hasUsageNotes: - description: "Property that describes the usage considerations of a particular\ + description: + "Property that describes the usage considerations of a particular\ \ software. These notes capture the rationale of for that software configuration,\ \ along with an explanation for sample inputs, things to consider when\ \ running the model with data, etc." @@ -16729,7 +17125,8 @@ components: nullable: true type: array hasBuildFile: - description: "A file (e.g., Dockerfile) with executable instructions indicating\ + description: + "A file (e.g., Dockerfile) with executable instructions indicating\ \ how a Software Image or a Software component is built" items: type: string @@ -16748,7 +17145,8 @@ components: nullable: true type: array hasAssumption: - description: "Assumptions of a software, e.g. the solver being used for\ + description: + "Assumptions of a software, e.g. the solver being used for\ \ a particular model, the source of the data (e.g., all data must have\ \ a given resolution), etc." items: @@ -16774,15 +17172,17 @@ components: nullable: true type: array hasSourceCode: - description: Property designed to link a software with its software source + description: + Property designed to link a software with its software source code (which may reside in a code repository such as GitHub) items: - $ref: '#/components/schemas/SourceCode' + $ref: "#/components/schemas/SourceCode" maxItems: 1 nullable: true type: array hasExecutableNotebook: - description: "Property that links a software component with an executable\ + description: + "Property that links a software component with an executable\ \ notebook (e.g., Jupyter notebook) that illustrates how to use it in\ \ an executable manner." items: @@ -16790,26 +17190,29 @@ components: nullable: true type: array hasExample: - description: An example explaining a scenario where the software component + description: + An example explaining a scenario where the software component was used in plain language. items: type: string nullable: true type: array publisher: - description: Publisher organization or person responsible for a software + description: + Publisher organization or person responsible for a software component items: - $ref: '#/components/schemas/Emulator_copyrightHolder_inner' + $ref: "#/components/schemas/Emulator_copyrightHolder_inner" nullable: true type: array usefulForCalculatingIndex: - description: Property that indicates that a software component (or any of + description: + Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component. items: - $ref: '#/components/schemas/NumericalIndex' + $ref: "#/components/schemas/NumericalIndex" nullable: true type: array doi: @@ -16870,46 +17273,46 @@ components: type: object Visualization_value_inner: anyOf: - - format: uri - type: string - - type: boolean - - format: date-time - type: string - - format: float - type: number - - format: int32 - type: integer - - type: string + - format: uri + type: string + - type: boolean + - format: date-time + type: string + - format: float + type: number + - format: int32 + type: integer + - type: string title: Visualization_value_inner Emulator_copyrightHolder_inner: anyOf: - - $ref: '#/components/schemas/Organization' - - $ref: '#/components/schemas/Person' + - $ref: "#/components/schemas/Organization" + - $ref: "#/components/schemas/Person" title: Emulator_copyrightHolder_inner CatalogIdentifier_hasMaximumAcceptedValue_inner: anyOf: - - format: date-time - type: string - - format: float - type: number - - format: int32 - type: integer + - format: date-time + type: string + - format: float + type: number + - format: int32 + type: integer title: CatalogIdentifier_hasMaximumAcceptedValue_inner TimeInterval_intervalValue_inner: anyOf: - - format: int32 - type: integer - - type: string + - format: int32 + type: integer + - type: string title: TimeInterval_intervalValue_inner CausalDiagram_hasDiagramPart_inner: anyOf: - - $ref: '#/components/schemas/VariablePresentation' - - $ref: '#/components/schemas/Process' + - $ref: "#/components/schemas/VariablePresentation" + - $ref: "#/components/schemas/Process" title: CausalDiagram_hasDiagramPart_inner Region_geo_inner: anyOf: - - $ref: '#/components/schemas/GeoCoordinates' - - $ref: '#/components/schemas/GeoShape' + - $ref: "#/components/schemas/GeoCoordinates" + - $ref: "#/components/schemas/GeoShape" title: Region_geo_inner securitySchemes: BearerAuth: