{ "openapi": "3.0.0", "info": { "version": "2.0rc1", "title": "OGC API - Processes", "description": "Example API Definition for OGC API - Processes", "contact": { "name": "Open Geospatial Consortium", "email": "info@ogc.org" }, "license": { "name": "OGC License", "url": "http://www.opengeospatial.org/legal/" } }, "servers": [ { "description": "Example Server 1 (GNOSIS, supporting Part 1: Core /Sync and Part 3: Workflows)", "url": "https://maps.gnosis.earth/ogcapi" } ], "paths": { "/": { "get": { "tags": [ "Landing Page" ], "operationId": "getLandingPage", "summary": "Retrieve the OGC API landing page for this service.", "parameters": [ { "$ref": "#/components/parameters/f-metadata" } ], "responses": { "200": { "$ref": "#/components/responses/LandingPage" }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/conformance": { "get": { "tags": [ "Conformance" ], "operationId": "getConformance", "summary": "Retrieve the set of OGC API conformance classes that are supported by this service.", "parameters": [ { "$ref": "#/components/parameters/f-metadata" } ], "responses": { "200": { "$ref": "#/components/responses/Conformance" }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/api": { "get": { "tags": [ "API" ], "operationId": "getAPI", "summary": "Retrieve this API definition.", "parameters": [ { "$ref": "#/components/parameters/f-metadata" } ], "responses": { "200": { "$ref": "#/components/responses/API" }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/api/processes-list": { "get": { "tags": [ "API" ], "operationId": "getAPIProcesses", "summary": "Retrieve the list of processes available from this API implementation & deployment.", "parameters": [ { "$ref": "#/components/parameters/f-metadata" } ], "responses": { "200": { "$ref": "#/components/responses/Enumeration" }, "404": { "$ref": "#/components/responses/NotFound" }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/processes": { "get": { "summary": "retrieve the list of available processes", "description": "The list of processes contains a summary of each process the OGC API - Processes offers, including the link to a more detailed description of the process.\n\nFor more information, see [Section 7.7]https://docs.ogc.org/is/18-062r2/18-062r2.html#sc_process_list).\n", "operationId": "getProcesses", "tags": [ "Processes" ], "responses": { "200": { "$ref": "#/components/responses/ProcessList" } } }, "post": { "summary": "deploy a process.", "description": "Deploys a process.\n\nFor more information, see [Section 6.3](http://docs.ogc.org/DRAFTS/20-044.html#_87a6983e-d060-458c-95ab-27e232e64822).\n", "operationId": "deploy", "tags": [ "DRU" ], "parameters": [ { "$ref": "#/components/parameters/w" } ], "requestBody": { "description": "An OGC Application Package used to deploy a new process.", "required": true, "content": { "application/ogcapppkg+json": { "schema": { "$ref": "#/components/schemas/ogcapppkg" } }, "application/cwl": { "schema": { "$ref": "#/components/schemas/CWL" } }, "application/cwl+json": { "schema": { "$ref": "#/components/schemas/CWL" } }, "application/cwl+yaml": { "schema": { "$ref": "#/components/schemas/CWL" } } } }, "responses": { "201": { "$ref": "#/components/responses/ProcessSummary" }, "400": { "$ref": "#/components/responses/Exception" }, "403": { "$ref": "#/components/responses/ImmutableProcess" }, "409": { "$ref": "#/components/responses/DuplicateProcess" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/processes/{processID}": { "get": { "summary": "retrieve a process description", "description": "The process description contains information about inputs and outputs and a link to the execution-endpoint for the process. The Core does not mandate the use of a specific process description to specify the interface of a process. That said, the Core requirements class makes the following recommendation:\n\nImplementations SHOULD consider supporting the OGC process description.\n\nFor more information, see [Section 7.8](https://docs.ogc.org/is/18-062r2/18-062r2.html#sc_process_description).\n", "operationId": "getProcessDescription", "tags": [ "Processes" ], "parameters": [ { "$ref": "#/components/parameters/processID-path" } ], "responses": { "200": { "$ref": "#/components/responses/ProcessDescription" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "summary": "replace a process.", "description": "Replaces a process.\n\nFor more information, see [Section 6.4](http://docs.ogc.org/DRAFTS/20-044.html#_18582f42-ebc6-4284-9333-c089068f62b6).\n", "operationId": "replace", "tags": [ "DRU" ], "parameters": [ { "$ref": "#/components/parameters/processID-path" } ], "requestBody": { "description": "An OGC Application Package used to deploy a new process.", "required": true, "content": { "application/ogcapppkg+json": { "schema": { "$ref": "#/components/schemas/ogcapppkg" } }, "application/cwl": { "schema": { "$ref": "#/components/schemas/CWL" } }, "application/cwl+json": { "schema": { "$ref": "#/components/schemas/CWL" } }, "application/cwl+yaml": { "schema": { "$ref": "#/components/schemas/CWL" } } } }, "responses": { "204": { "$ref": "#/components/responses/EmptyResponse" }, "400": { "$ref": "#/components/responses/Exception" }, "403": { "$ref": "#/components/responses/ImmutableProcess" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/DuplicateProcess" }, "500": { "$ref": "#/components/responses/ServerError" } } }, "delete": { "summary": "undeploy a process.", "description": "Undeploys a process.\n\nFor more information, see [Section 6.5](http://docs.ogc.org/DRAFTS/20-044.html#_16391f9e-538f-4a84-9710-72a6bab82842).\n", "operationId": "undeploy", "tags": [ "DRU" ], "parameters": [ { "$ref": "#/components/parameters/processID-path" } ], "responses": { "204": { "$ref": "#/components/responses/EmptyResponse" }, "403": { "$ref": "#/components/responses/ImmutableProcess" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/processes/{processID}/package": { "get": { "summary": "retrieve the formal description used to deploy a process", "description": "Access the formal description that can be used to deploy a process on an OGC API - Processes Server Instance.\n", "operationId": "getPackage", "tags": [ "DRU" ], "parameters": [ { "$ref": "#/components/parameters/processID-path" } ], "responses": { "200": { "description": "The formal used to deploy a process", "content": { "application/ogcapppkg+json": { "schema": { "$ref": "#/components/schemas/ogcapppkg" } }, "application/cwl": { "schema": { "$ref": "#/components/schemas/CWL" } }, "application/cwl+json": { "schema": { "$ref": "#/components/schemas/CWL" } }, "application/cwl+yaml": { "schema": { "$ref": "#/components/schemas/CWL" } } } }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/processes/{processID}/execution": { "post": { "summary": "execute a process.", "description": "Executes a process (this may result in the creation of a job resource e.g., for _asynchronous execution_).\n\nFor more information, see [Section 7.9](https://docs.ogc.org/is/18-062r2/18-062r2.html#sc_create_job).\n", "operationId": "execute", "tags": [ "Processes" ], "parameters": [ { "$ref": "#/components/parameters/processID-path" }, { "name": "response", "in": "query", "description": "For executing the process using the _Collection Output_ mechanism, where the\nclient is redirected (_303_ status) to a collection resource, from which one\nor more OGC API data access mechanism is available. Data access requests may\ntrigger processing on-demand for a given area, time and resolution of interest.", "required": false, "schema": { "type": "string", "enum": [ "collection" ] } }, { "in": "header", "description": "Indicates client preferences, including whether the client is capable of asynchronous processing.\nA `respond-async` preference indicates a preference for asynchronous processing.\nA `wait: s` preference indicates that the client prefers to wait up to x seconds to receive a reponse synchronously before the server falls back to asynchronous processing.", "name": "Prefer", "schema": { "type": "string" } } ], "requestBody": { "description": "An execution request specifying any inputs for the process to execute, and optionally to select specific outputs.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/execute-workflow" } } } }, "responses": { "200": { "$ref": "#/components/responses/ExecuteSync" }, "201": { "$ref": "#/components/responses/ExecuteAsync" }, "204": { "$ref": "#/components/responses/EmptyResponse" }, "303": { "description": "For _Collection Output_ execution, redirection to an OGC API landing page or collection.", "headers": { "Location": { "schema": { "type": "string" }, "description": "Location for redirection to an [OGC API collection description](https://github.com/opengeospatial/ogcapi-common/blob/master/collections/openapi/schemas/common-geodata/collectionDesc.yaml) (for `response=collection`) as described in\n[OGC API - Common - Part 2: Geospatial data](http://docs.ogc.org/DRAFTS/20-024.html#collection-description).\nThe collection redirected to must contain links to at least one data access mechanism (such as\n[_OGC API - Tiles_](https://docs.ogc.org/is/20-057/20-057.html),\n[_DGGS_](https://docs.ogc.org/is/21-038r1/21-038r1.html),\n[_Coverages_](http://docs.ogc.org/DRAFTS/19-087.html),\n[_Features_](https://docs.opengeospatial.org/is/17-069r4/17-069r4.html),\n[_EDR_](https://docs.ogc.org/is/19-086r5/19-086r5.html), or\n[_Maps_](https://docs.ogc.org/is/20-058/20-058.html)...) to retrieve output results, which may\ntrigger on-demand processing." } } }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/ServerError" } }, "callbacks": { "jobCompleted": { "{$request.body#/subscriber/successUri}": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/results" } } } }, "responses": { "200": { "description": "Results received successfully" } } } } } } } }, "/jobs": { "get": { "summary": "retrieve the list of jobs.", "description": "Lists available jobs.\n\nFor more information, see [Section 12](https://docs.ogc.org/is/18-062r2/18-062r2.html#Job_list).\n", "operationId": "getJobs", "tags": [ "Jobs" ], "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/processID-query" }, { "$ref": "#/components/parameters/status" }, { "$ref": "#/components/parameters/minDuration" }, { "$ref": "#/components/parameters/maxDuration" }, { "$ref": "#/components/parameters/type" }, { "$ref": "#/components/parameters/datetime" } ], "responses": { "200": { "$ref": "#/components/responses/JobList" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/jobs/{jobID}": { "get": { "summary": "retrieve the status of a job", "description": "Shows the status of a job.\n\n For more information, see [Section 7.10](https://docs.ogc.org/is/18-062r2/18-062r2.html#sc_retrieve_status_info).\n", "operationId": "getStatus", "tags": [ "Jobs" ], "parameters": [ { "$ref": "#/components/parameters/jobID" } ], "responses": { "200": { "$ref": "#/components/responses/Status" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } }, "delete": { "summary": "cancel a job execution, remove a finished job", "description": "Cancel a job execution and remove it from the jobs list.\n\nFor more information, see [Section 14]https://docs.ogc.org/is/18-062r2/18-062r2.html#Dismiss).\n", "operationId": "dismiss", "tags": [ "Jobs" ], "parameters": [ { "$ref": "#/components/parameters/jobID" } ], "responses": { "200": { "$ref": "#/components/responses/Status" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/jobs/{jobID}/results": { "get": { "summary": "retrieve the result(s) of a job", "description": "Lists available results of a job. In case of a failure, lists exceptions instead.\n\nFor more information, see [Section 7.11](https://docs.ogc.org/is/18-062r2/18-062r2.html#sc_retrieve_job_results).\n", "operationId": "getResult", "tags": [ "Jobs" ], "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/prefer-header-return" } ], "responses": { "200": { "$ref": "#/components/responses/Results" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/jobs/{jobID}/results/{outputID}": { "get": { "summary": "retrieve a specific resulting output of a job", "description": "Retrieve a specific resulting output for a job.\n\nFor more information, see [Section 7.14](https://docs.ogc.org/is/18-062r3/18-062r3.html#sc_retrieve_job_results_one).\n", "operationId": "getOutput", "tags": [ "Jobs" ], "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/outputID" }, { "$ref": "#/components/parameters/prefer-header-return" } ], "responses": { "200": { "$ref": "#/components/responses/Output" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/jobs/{jobID}/results/{outputID}/{N}": { "get": { "summary": "retrieve a single value from an output of a job allowing multiple values", "description": "Retrieve a single value from an output of a job allowing multiple values (maxOccurs > 1)\n\nFor more information, see [Section 7.14](https://docs.ogc.org/is/18-062r3/18-062r3.html#sc_retrieve_job_results_one).\n", "operationId": "getOutputValue", "tags": [ "Jobs" ], "parameters": [ { "$ref": "#/components/parameters/jobID" }, { "$ref": "#/components/parameters/outputID" }, { "$ref": "#/components/parameters/N" } ], "responses": { "200": { "$ref": "#/components/responses/Output" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/ServerError" } } } } }, "components": { "schemas": { "confClasses": { "type": "object", "required": [ "conformsTo" ], "properties": { "conformsTo": { "type": "array", "items": { "type": "string", "example": "http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core" } } } }, "link": { "type": "object", "required": [ "href" ], "properties": { "href": { "type": "string" }, "rel": { "type": "string", "example": "service" }, "type": { "type": "string", "example": "application/json" }, "hreflang": { "type": "string", "example": "en" }, "title": { "type": "string" } } }, "landingPage": { "type": "object", "required": [ "links" ], "properties": { "title": { "type": "string", "example": "Example processing server" }, "description": { "type": "string", "example": "Example server implementing the OGC API - Processes 1.0 Standard" }, "attribution": { "type": "string", "title": "attribution for the Processes API", "description": "The `attribution` should be short and intended for presentation to a user, for example, in a corner of a map. Parts of the text can be links to other resources if additional information is needed. The string can include HTML markup." }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/link" } } } }, "exception": { "title": "Exception Schema", "description": "JSON schema for exceptions based on RFC 7807", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "instance": { "type": "string" } }, "additionalProperties": true }, "collections": { "type": "object", "required": [ "links", "collections" ], "properties": { "links": { "type": "array", "title": "Links to resource in the collections", "description": "Links to this or other resources provided by the collections.", "items": { "$ref": "#/components/schemas/link" } }, "numberMatched": { "$ref": "#/components/schemas/numberMatched" }, "numberReturned": { "$ref": "#/components/schemas/numberReturned" }, "collections": { "type": "array", "title": "Collections descriptions", "description": "Descriptions of each collection in this API.", "items": { "$ref": "#/components/schemas/collectionDesc" } } } }, "collectionDesc": { "allOf": [ { "type": "object", "required": [ "id", "links" ], "properties": { "id": { "type": "string", "title": "Identifier of the resource", "description": "Identifier of the collection, for example, used in URI path parameters.", "minLength": 1, "example": "dem" }, "title": { "type": "string", "title": "Title of the collection", "description": "A short, human-readable summary of the collection.", "example": "Digital Elevation Model" }, "description": { "type": "string", "title": "Description of the collection", "description": "A human-readable explanation about data in the collection.", "example": "A Digital Elevation Model." }, "attribution": { "type": "string", "title": "Attribution for the collection", "description": "Attribution for the collection, providing a way to identify the source of the geographic information, which can contain markup text whose format may be indicated in the `attributionMediaType` property. That format can be either plain text (`text/plain`), HTML (`text/html`) or https://commonmark.org/[CommonMark] (`text/markdown`).\nIf the 'attributionMediaType' indicates something other than `text/plain`, the `attribution` element string should be interpreted by a markup parser selected based on that media type to be presented to the user\n(e.g., `text/markdown` will be parsed by a library supporting CommonMark). By allowing markup, the attribution string can import images (e.g., organization logos) and format the text (e.g., the name of the organization in italics)." }, "attributionMediaType": { "title": "Media type of the attribution", "description": "Media type for the markup language of the attribution: It can be either plain text (`text/plain`), HTML (`text/html`) or https://commonmark.org/[CommonMark] (`text/markdown`).", "enum": [ "text/plain", "text/html", "text/markdown" ] }, "accessConstraints": { "title": "Access Constraints of the collection", "description": "Restrictions on the availability of the collection that the user needs to be aware of before using or redistributing the data:\n\n* unclassified: Available for general disclosure\n* restricted: Not for general disclosure\n* confidential: Available for someone who can be entrusted with information\n* secret: Kept or meant to be kept private, unknown, or hidden from all but a select group of people\n* topSecret: Of the highest secrecy", "enum": [ "unclassified", "restricted", "confidential", "secret", "topSecret" ] }, "publisher": { "type": "string", "title": "Responsible party publishing the collection", "description": "Organization or individual responsible for making the data available" }, "contacts": { "type": "array", "title": "A list of contacts", "description": "A list of contacts qualified by their role(s) in association to the collection.", "minItems": 1, "items": { "type": "object", "title": "Contact information", "description": "Identification of, and means of communication with, person responsible\nfor the resource.", "anyOf": [ { "required": [ "name" ] }, { "required": [ "organization" ] } ], "properties": { "identifier": { "type": "string", "title": "Identifier of the contact", "description": "A value uniquely identifying a contact." }, "name": { "type": "string", "title": "name of the contact person", "description": "The name of the responsible person." }, "position": { "type": "string", "title": "position in the organization", "description": "The name of the role or position of the responsible person taken\nfrom the organization's formal organizational hierarchy or chart." }, "organization": { "type": "string", "title": "Name of the organization", "description": "Organization/affiliation of the contact." }, "logo": { "title": "Logo of the contact", "description": "Link to a graphic identifying a contact. The link relation should be `icon`\nand the media type should be an image media type.", "allOf": [ { "$ref": "#/components/schemas/link" }, { "type": "object", "required": [ "rel", "type" ], "properties": { "rel": { "enum": [ "icon" ] } } } ] }, "phones": { "type": "array", "title": "Telephone numbers", "description": "Telephone numbers at which contact can be made.", "items": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "title": "Phone number.", "description": "The value is the phone number itself.", "pattern": "^\\+[1-9]{1}[0-9]{3,14}$", "example": "+14165550142" }, "roles": { "title": "Type of phone number.", "description": "The type of phone number (e.g. home, work, fax, etc.).", "$ref": "#/components/schemas/collectionDesc/allOf/0/properties/contacts/items/properties/roles" } } } }, "emails": { "type": "array", "title": "Email addresses", "description": "Email addresses at which contact can be made.", "items": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "title": "Email address", "description": "The value is the email itself.", "format": "email" }, "roles": { "title": "Type of email", "description": "The type of email (e.g. home, work, etc.).", "$ref": "#/components/schemas/collectionDesc/allOf/0/properties/contacts/items/properties/roles" } } } }, "addresses": { "type": "array", "title": "Postal addresses", "description": "Physical locations at which contact can be made.", "items": { "type": "object", "properties": { "deliveryPoint": { "type": "array", "title": "Details of the address", "description": "Address lines for the location (e.g. street name and door number).", "items": { "type": "string" } }, "city": { "type": "string", "title": "City", "description": "City for the location." }, "administrativeArea": { "type": "string", "title": "State of province", "description": "State or province of the location." }, "postalCode": { "type": "string", "title": "Postal code", "description": "ZIP or other postal code." }, "country": { "type": "string", "title": "Country", "description": "Country of the physical address. ISO 3166-1 is recommended." }, "roles": { "title": "Type of postal address", "description": "The type of postal address (e.g. office, home, etc.).", "$ref": "#/components/schemas/collectionDesc/allOf/0/properties/contacts/items/properties/roles" } } } }, "links": { "type": "array", "title": "Links about the contact", "description": "On-line information about the contact.", "items": { "allOf": [ { "$ref": "#/components/schemas/link" }, { "type": "object", "required": [ "type" ] } ] } }, "hoursOfService": { "type": "string", "title": "Hours of service", "description": "Time period when the contact can be contacted.", "example": "Hours: Mo-Fr 10am-7pm Sa 10am-22pm Su 10am-21pm" }, "contactInstructions": { "type": "string", "title": "Contact instructions", "description": "Supplemental instructions on how or when to contact can be made." }, "roles": { "title": "Types of contact person", "description": "The set of named duties, job functions and/or permissions associated with this contact. (e.g. developer, administrator, etc.).", "type": "array", "minItems": 1, "items": { "type": "string" } } } } }, "license": { "type": "string", "title": "License associated to the collection", "description": "The legal provisions under which the data of this collection is made available." }, "rights": { "type": "string", "title": "Rights over the collection", "description": "A statement that concerns all rights not addressed by the license such as a copyright statement." }, "formats": { "title": "Formats for distributing the collection", "description": "A list of formats in which the data of this collection is distributed", "type": "array", "items": { "type": "object", "anyOf": [ { "required": [ "name" ] }, { "required": [ "mediaType" ] } ], "properties": { "name": { "title": "Name of the format", "description": "Name of the format.", "type": "string" }, "mediaType": { "title": "Media type of the format", "description": "Media type of the format.", "type": "string" } } } }, "keywords": { "type": "array", "title": "Keywords representing aspects of the collection", "description": "The topic or topics of the resource. Typically represented using free-form keywords, tags, key phrases, or classification codes.", "items": { "type": "string" } }, "themes": { "type": "array", "title": "Themes represented by the resource", "description": "A knowledge organization system used to classify the resource.", "minItems": 1, "items": { "type": "object", "required": [ "concepts", "scheme" ], "properties": { "concepts": { "type": "array", "title": "List of concepts in the vocabulary", "description": "One or more entity/concept identifiers from this knowledge system. it is recommended that a resolvable URI be used for each entity/concept identifier.", "minItems": 1, "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "title": "Identifier for the concept", "description": "Identifier for the concept in the knowledge system.", "minLength": 1 }, "title": { "type": "string", "title": "Title of the concept", "description": "A human readable title for the concept." }, "description": { "type": "string", "title": "Description of the concept", "description": "A human readable description for the concept." }, "url": { "type": "string", "format": "uri", "title": "URI of the concept", "description": "A URI providing further description of the concept. It is called \"definition\" in STA." } } } }, "scheme": { "type": "string", "title": "Identifier of the vocabulary", "description": "An identifier for the knowledge organization system used to classify the resource. It is recommended that the identifier be a resolvable URI. The list of schemes used in a searchable catalog can be determined by inspecting the server's OpenAPI document or, if the server implements CQL2, by exposing a queryable (e.g. named `scheme`) and enumerating the list of schemes in the queryable's schema definition." } } } }, "resourceLanguages": { "type": "array", "title": "The list of languages of the collection", "description": "The list of languages in which the data of this collection is available.", "items": { "type": "object", "title": "Resource language", "description": "The language used for textual values in this resource.", "required": [ "code" ], "properties": { "code": { "type": "string", "title": "Code", "description": "The language tag as per RFC-5646.", "example": "el" }, "name": { "type": "string", "minLength": 1, "title": "Original name", "description": "The untranslated name of the language.", "example": "Ελληνικά" }, "alternate": { "type": "string", "title": "Translated name", "description": "The name of the language in another well-understood language, usually English.", "example": "Greek" }, "dir": { "type": "string", "title": "Direction of the text", "description": "The direction for text in this language. The default, `ltr` (left-to-right), represents the most common situation. However, care should be taken to set the value of `dir` appropriately if the language direction is not `ltr`. Other values supported are `rtl` (right-to-left), `ttb` (top-to-bottom), and `btt` (bottom-to-top).", "enum": [ "ltr", "rtl", "ttb", "btt" ], "default": "ltr" } } } }, "links": { "type": "array", "title": "Links relevant to this collection", "description": "Links to this or other resources related to this collection.", "example": [ { "href": "http://data.example.org/collections/dem?f=json", "rel": "self", "type": "application/json", "title": "Digital Elevation Model" }, { "href": "http://data.example.org/collections/dem?f=html", "rel": "alternate", "type": "application/json", "title": "Digital Elevation Model" }, { "href": "http://data.example.org/collections/dem/coverage", "rel": "coverage", "type": "image/tiff; application=geotiff", "title": "Digital Elevation Model" }, { "href": "http://data.example.org/collections/dem/coverage/domainset", "rel": "domainset", "type": "application/json", "title": "Digital Elevation Model" }, { "href": "http://data.example.org/collections/dem/coverage/rangetype", "rel": "rangetype", "type": "application/json", "title": "Digital Elevation Model" }, { "href": "http://data.example.org/collections/dem/coverage/metadata", "rel": "metadata", "type": "application/json", "title": "Digital Elevation Model" } ], "items": { "$ref": "#/components/schemas/link" } }, "itemType": { "title": "Type of the items in the collection", "description": "Indicator about the type of the items in the collection if the collection has an accessible `/collections/{collectionId}/items` endpoint (e.g., `feature` or `record`).", "type": "string", "default": "feature" }, "dataType": { "title": "Nature of the data in the collection", "description": "Nature of the data in the collection. For example, this could be set to `map`, `vector` or `coverage`. It is not an indication of the available data access mechanism, but a hint regarding the internal representation of the data.", "$ref": "#/components/schemas/dataType" }, "featureTypes": { "title": "Feature type(s) present in the collection", "description": "The list of feature (or coverage) type(s) which are present inside the collection. This is useful for associating the relevant portrayal rules of a style.", "type": "string" }, "parent": { "title": "Identifier of a parent collection (if this collection is part of a hierarchy)", "description": "If this collection is part of a hierarchy, this property allows to identify another collection within the same dataset as its parent (by setting `parent` to the `id` of that collection), enabling clients to construct a hierarchy.", "type": "string" }, "geoDataClasses": { "title": "Class of data in the collection", "description": "One or more classes of geospatial data, identified by a URI, which implies compatibility with a particular schema (fields/properties, as defined in OGC API - Common - Part 3: Schemas) for one or more collections, each with particular semantic definitions and data types. This is useful for example to determine compatibility with styles or processes, or to identify a particular collection within a dataset based on semantics.", "type": "array", "items": { "type": "string", "format": "uri" } }, "defaultFields": { "title": "List of fields returned by default", "description": "A sorted list of field names. For a Features data access mechanism, it is the list of returnable properties included by default and complementing the geometry of the features. For a Coverage data access mechanism, they are names of fields whose values are included by default. Note that an API may provide a mechanism (e.g., a query parameter called `properties` or `exclude-properties`) to override this default list in customized responses.", "type": "array", "items": { "type": "string" }, "minItems": 1 }, "crs": { "title": "List of coordinate reference systems supported in the collection", "description": "The list of coordinate reference systems supported by the API; if present, the list should include the default coordinate reference system (usually listed first). Each item should be a URI to a registered CRS if one is available, or a full description of the CRS otherwise using e.g., a WKT2CRS string, or a PROJJSON, or CRS JSON object.", "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "default": [ "http://www.opengis.net/def/crs/OGC/1.3/CRS84" ], "example": [ "http://www.opengis.net/def/crs/OGC/1.3/CRS84", "http://www.opengis.net/def/crs/EPSG/0/4326" ] }, "storageCrs": { "title": "Storage or native CRS of the data in the collection", "description": "The native coordinate reference system (i.e., the most efficient CRS in which to request the data, possibly how the data is stored on the server); this is the default output coordinate reference system for Maps and Coverages. This should be a URI to a registered CRS if one is available, or a full description of the CRS otherwise using e.g., a WKT2CRS string, or a PROJJSON, or CRS JSON object.", "anyOf": [ { "type": "string" }, { "type": "object" } ], "default": "http://www.opengis.net/def/crs/OGC/1.3/CRS84", "example": "http://www.opengis.net/def/crs/OGC/1.3/CRS84" }, "epoch": { "title": "Epoch of the data in the collection", "description": "Epoch of the native (storage) Coordinate Reference System (CRS)", "type": "number", "example": 2021.33 }, "geometryDimension": { "title": "Number of spatial dimensions of the primary geometry for the data", "description": "Number of spatial dimensions of the primary geometry of individual elements of the data: 0 for points, 1 for curves, 2 for surfaces, 3 for solids and unspecified when mixed or unknown. Not to be confused with the dimensions of the domain which are defined by the extent element.", "type": "integer", "minimum": 0, "maximum": 3 }, "minScaleDenominator": { "title": "Minimum scale denominator for the collection", "description": "Minimum scale denominator for usage of the collection.", "type": "number" }, "maxScaleDenominator": { "title": "Maximum scale denominator for the collection", "description": "Maximum scale denominator for usage of the collection.", "type": "number" }, "minCellSize": { "title": "Minimum cell size for the collection", "description": "Minimum cell size for usage of the collection.", "type": "number" }, "maxCellSize": { "title": "Maximum cell size for the collection", "description": "Maximum cell size for usage of the collection.", "type": "number" }, "created": { "title": "Timestamp when the collection was first produced", "description": "Timestamp indicating when the data in the collection was first produced.", "type": "string", "format": "date-time" }, "updated": { "title": "Timestamp of the last change/revision to the collection", "description": "Timestamp of the last change/revision to the data in the collection.", "type": "string", "format": "date-time" } } }, { "type": "object", "properties": { "extent": { "$ref": "#/components/schemas/extent" } } } ] }, "extent": { "title": "Extent with (optional) Uniform Additional Dimensions Schema", "description": "The extent of the data in the collection.\nThis extent schema includes optional additional dimensions, but will still validate for objects not conforming to UAD.\nOGC API - Common - Part 2 \"Collections\" requirements class specifies only the definition of the spatial and temporal extents.\nThe \"Uniform Additional Dimensions\" requirements class specifies a generic schema for describing any additional dimension, such as thermal or pressure ranges.", "allOf": [ { "type": "object", "properties": { "spatial": { "title": "Spatial extent", "description": "The spatial extent of the data in the collection.", "type": "object", "properties": { "bbox": { "title": "Bounding box in the 'crs' coordinates", "description": "One or more bounding boxes that describe the spatial extent of the dataset.\n\nThe first bounding box describes the overall spatial\nextent of the data. All subsequent bounding boxes describe\nmore precise bounding boxes, e.g., to identify clusters of data.\nClients only interested in the overall spatial extent will\nonly need to access the first item in each array.", "type": "array", "minItems": 1, "items": { "description": "Each bounding box is provided as four or six numbers, depending on\nwhether the coordinate reference system includes a vertical axis\n(height or depth):\n\n* Lower left corner, coordinate axis 1\n* Lower left corner, coordinate axis 2\n* Minimum value, coordinate axis 3 (optional)\n* Upper right corner, coordinate axis 1\n* Upper right corner, coordinate axis 2\n* Maximum value, coordinate axis 3 (optional)\n\nIf the value consists of four numbers, the coordinate reference system is\nWGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84)\nunless a different coordinate reference system is specified in `crs` property.\n\nIf the value consists of six numbers, the coordinate reference system is WGS 84\nlongitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h)\nunless a different coordinate reference system is specified in `crs` property.\n\nFor WGS 84 longitude/latitude the values are in most cases the sequence of\nminimum longitude, minimum latitude, maximum longitude and maximum latitude.\nHowever, in cases where the box spans the antimeridian the first value\n(west-most box edge) is larger than the third value (east-most box edge).\n\nIf the vertical axis is included, the third and the sixth number are\nthe bottom and the top of the 3-dimensional bounding box.\n\nIf a feature has multiple spatial geometry properties, it is the decision of the\nserver whether only a single spatial geometry property is used to determine\nthe extent or all relevant geometries.", "type": "array", "oneOf": [ { "minItems": 4, "maxItems": 4 }, { "minItems": 6, "maxItems": 6 } ], "items": { "type": "number" }, "example": [ -180, -90, 180, 90 ] } }, "storageCrsBbox": { "title": "Bounding box in the storage CRS", "description": "One or more bounding boxes that describe the spatial extent of the dataset in the storage (native) CRS (`storageCrs` property).\n\nThe first bounding box describes the overall spatial\nextent of the data. All subsequent bounding boxes describe\nmore precise bounding boxes, e.g., to identify clusters of data.\nClients only interested in the overall spatial extent will\nonly need to access the first item in each array.", "type": "array", "minItems": 1, "items": { "description": "Each bounding box is provided as four or six numbers, depending on\nwhether the coordinate reference system includes a vertical axis\n(height or depth):\n\n* Lower left corner, coordinate axis 1\n* Lower left corner, coordinate axis 2\n* Minimum value, coordinate axis 3 (optional)\n* Upper right corner, coordinate axis 1\n* Upper right corner, coordinate axis 2\n* Maximum value, coordinate axis 3 (optional)", "type": "array", "oneOf": [ { "minItems": 4, "maxItems": 4 }, { "minItems": 6, "maxItems": 6 } ], "items": { "type": "number" }, "example": [ -180, -90, 180, 90 ] } }, "crs": { "title": "Coordinate reference system", "description": "Coordinate reference system of the coordinates of the `bbox` property.\nThe default reference system is WGS 84 longitude/latitude.\nWGS 84 longitude/latitude/ellipsoidal height for coordinates with height.\nFor data not referenced to Earth, another CRS may be specified.\nThis should be a URI to a registered CRS if one is available, or a full description of the CRS otherwise using e.g., a WKT2CRS string, or a PROJJSON, or CRS JSON object.", "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "http://www.opengis.net/def/crs/OGC/1.3/CRS84", "http://www.opengis.net/def/crs/OGC/0/CRS84h" ] }, { "type": "object" } ], "default": "http://www.opengis.net/def/crs/OGC/1.3/CRS84" }, "grid": { "title": "Grid description", "description": "Provides information about the limited availability of data within the collection organized\nas a grid (regular or irregular) along each spatial dimension.", "type": "array", "minItems": 2, "maxItems": 3, "items": { "$ref": "#/components/schemas/extent-UAD/allOf/0/additionalProperties/properties/grid" } } } }, "temporal": { "title": "Temporal extent", "description": "The temporal extent of the data in the collection.", "type": "object", "properties": { "interval": { "title": "Temporal intervals", "description": "One or more time intervals that describe the temporal extent of the dataset.\n\nThe first time interval describes the overall\ntemporal extent of the data. All subsequent time intervals describe\nmore precise time intervals, e.g., to identify clusters of data.\nClients only interested in the overall extent will only need\nto access the first item in each array.", "type": "array", "minItems": 1, "items": { "description": "Begin and end times of the time interval. The timestamps are in the\ntemporal coordinate reference system specified in `trs`. By default\nthis is the Gregorian calendar, expressed using RFC 3339 section 5.6.\nNote that these times may be specified using time zone offsets to UTC time other than zero.\n\nThe value `null` for start or end time is supported and indicates a half-bounded time interval.", "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "string", "format": "date-time", "nullable": true, "example": "2011-11-11T12:22:11Z" } } }, "trs": { "title": "Temporal Coordinate Reference System", "description": "Coordinate reference system of the coordinates in the temporal extent\n(property `interval`). The default reference system is the Gregorian calendar.\nFor data for which the Gregorian calendar is not suitable, such as geological time scale, another temporal reference system may be used.\nThis should be a URI to a registered TRS if one is available, or a full description of the TRS otherwise using e.g., a WKT2CRS string, or a PROJJSON, or CRS JSON object.", "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian" ] }, { "type": "object" } ], "default": "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian" }, "grid": { "$ref": "#/components/schemas/extent-UAD/allOf/0/additionalProperties/properties/grid" } } } } }, { "anyOf": [ { "type": "object", "description": "General object extension point" }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/extent-UAD/allOf/0/additionalProperties" } } ] } ] }, "extent-UAD": { "title": "Extent conforming to Uniform Additional Dimensions Schema", "description": "The extent of the data in the collection.\nThis extent schema requires that if any dimension beyond spatial and temporal are specified, they conform to the Uniform Additional Dimensions schema.\nIn addition to the spatial and temporal extents defined in the \"Collections\" requirements class of OGC API - Common - Part 2,\nthe \"Uniform Additional Dimensions\" requirements class specifies a generic schema for describing any additional dimension, such as thermal or pressure ranges.", "allOf": [ { "type": "object", "properties": { "spatial": { "$ref": "#/components/schemas/extent/allOf/0/properties/spatial" }, "temporal": { "$ref": "#/components/schemas/extent/allOf/0/properties/temporal" } }, "additionalProperties": { "title": "Extent of any additional dimensions", "description": "The domain intervals for any additional dimensions of the extent (envelope) beyond those described in temporal and spatial.", "type": "object", "oneOf": [ { "required": [ "interval", "definition" ] }, { "required": [ "interval", "trs" ] }, { "required": [ "interval", "vrs" ] } ], "properties": { "interval": { "title": "Interval of the extent of this dimension", "description": "One or more intervals that describe the extent for this dimension of the dataset.\nThe value `null` is supported and indicates an unbounded or half-bounded interval.\nThe first interval describes the overall extent of the data for this dimension.\nAll subsequent intervals describe more precise intervals, e.g., to identify clusters of data.\nClients only interested in the overall extent will only need\nto access the first item (a pair of lower and upper bound values).", "type": "array", "minItems": 1, "items": { "description": "Lower and upper bound values of the interval. The values\nare in the coordinate reference system specified in `crs`, `trs` or `vrs`.", "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "type": "string", "nullable": true, "example": "2011-11-11T12:22:11Z" }, { "type": "number", "example": 32.7 } ] } } }, "trs": { "title": "Temporal Coordinate Reference System", "description": "Temporal Coordinate Reference System (e.g. as defined by Features for 'temporal'). This should be a URI to a registered TRS if one is available, or a full description of the TRS otherwise using e.g., a WKT2CRS string, or a PROJJSON, or CRS JSON object.", "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "vrs": { "title": "Vertical Coordinate Reference System", "description": "Vertical Coordinate Reference System (e.g. as defined in EDR for 'vertical'). This should be a URI to a registered VRS if one is available, or a full description of the VRS otherwise using e.g., a WKT2CRS string, or a PROJJSON, or CRS JSON object.", "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "grid": { "type": "object", "title": "Grid.", "description": "Provides information about the limited availability of data within the collection organized as a grid (regular or irregular) along the dimension.", "allOf": [ { "type": "object", "required": [ "cellsCount" ], "properties": { "cellsCount": { "title": "Cell count", "description": "Number of samples available along the dimension for data organized as a regular or irregular grid.", "type": "integer", "example": 50 } } }, { "oneOf": [ { "type": "object", "title": "Regular grid", "description": "Regular grid with samples spaced at equal intervals.", "required": [ "resolution", "firstCoordinate" ], "properties": { "resolution": { "title": "Resolution", "description": "Resolution of regularly gridded data along the dimension in the collection.", "oneOf": [ { "type": "string", "nullable": true, "example": "PT1H" }, { "type": "number", "example": 0.0006866455078 } ] }, "availableResolutions": { "title": "Available resolutions", "description": "List of resolutions made available by the API. If not specified, there are no limit other than the limits indicated in `minCellSize` and `maxCellSize` of the collection description (though the API might still allow requesting data beyond these).", "type": "array", "items": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "number" } ] }, "example": [ "P1H", "P1D", "P1M" ] }, "firstCoordinate": { "title": "First coordinate", "description": "First coordinate where a regular grid begins, with subsequent coordinates adding `resolution` unit at each step.", "oneOf": [ { "type": "string", "nullable": true }, { "type": "number" } ], "example": -180 }, "relativeBounds": { "title": "Relative bounds", "description": "Distance in units from coordinate to the lower and upper bounds of each cell for regular grids, describing the geometry of the cells.", "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "number" } ] }, "example": [ -0.5, 0.5 ] } } }, { "type": "object", "title": "Irregular grid.", "description": "Irregular grid with samples spaced at different intervals.", "required": [ "coordinates" ], "properties": { "coordinates": { "title": "Coordinates of the irregular cells", "description": "List of coordinates along the dimension for which data organized as an irregular grid in the collection is available.\n(e.g., 2, 10, 80, 100).", "type": "array", "minItems": 1, "items": { "oneOf": [ { "type": "string", "nullable": true, "example": "2020-11-12T12:15:00Z" }, { "type": "number", "example": 12.3 } ] }, "example": [ 2, 10, 80, 100 ] }, "boundsCoordinates": { "title": "Bounds coordinates", "description": "For irregular grids, an ordered list of the coordinates in absolute units of the lower and upper bounds of the dimension for each cell.", "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "number" } ] } }, "example": [ [ -180, -179 ], [ -179, -178 ] ] } } } ] } ] }, "definition": { "type": "string", "format": "uri", "title": "Observed property definition", "description": "A URI for the definition of the measured or observed property corresponding to this dimension." }, "unit": { "type": "string", "title": "Units of measurement", "description": "The unit of measure in which the interval and/or grid values are expressed." }, "unitLang": { "type": "string", "default": "UCUM", "title": "Units of measurement vocabulary", "description": "The language (or vocabulary) in which the unit is expressed (defaults to \"UCUM\" if not specified)." }, "variableType": { "title": "Variable type", "description": "The type of variable which may inform correct interpretation and interpolation methods.", "type": "string", "enum": [ "continuous", "numericalOrdinal", "numericalNominal", "categoricalOrdinal", "categoricalNominal" ] } } } } ] }, "crs": { "title": "CRS", "oneOf": [ { "description": "Simplification of the object into a url if the other properties are not present", "type": "string" }, { "type": "object", "oneOf": [ { "required": [ "uri" ], "properties": { "uri": { "description": "Reference to one coordinate reference system (CRS)", "type": "string", "format": "uri" } } }, { "required": [ "wkt" ], "properties": { "wkt": { "allOf": [ { "description": "An object defining the CRS using the JSON encoding for Well-known text representation of coordinate reference systems 2.0" }, { "type": "object" } ] } } }, { "required": [ "referenceSystem" ], "properties": { "referenceSystem": { "description": "A reference system data structure as defined in the MD_ReferenceSystem of the ISO 19115", "type": "object" } } } ] } ] }, "dataType": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "map", "vector", "coverage" ] } ] }, "timeStamp": { "title": "Time stamp", "description": "This property indicates the time and date when the response was generated using RFC 3339 notation.", "type": "string", "format": "date-time", "example": "2017-08-17T08:05:32Z" }, "numberReturned": { "title": "The number of elements in the response", "description": "A server may omit this information, if the information about the number of elements is not known or difficult to compute. If the value is provided, the value shall be identical to the number of elements in the response.", "type": "integer", "minimum": 0, "example": 10 }, "numberMatched": { "title": "The number of elements in the response", "description": "The number of elements in the response that match the selection parameters like `bbox`.", "type": "integer", "minimum": 0, "example": 127 }, "CWL": { "oneOf": [ { "$ref": "#/components/schemas/CWLAtomic" }, { "$ref": "#/components/schemas/CWLGraph" }, { "$ref": "#/components/schemas/CWLWorkflow" } ] }, "cwltool_CUDARequirement": { "type": "object", "title": "cwltool:CUDARequirement", "properties": { "class": { "type": "string", "enum": [ "cwltool:CUDARequirement" ] }, "cudaVersionMin": { "type": "string", "title": "CUDA version minimum", "description": "The minimum CUDA version required to run the software. This corresponds to a CUDA SDK release.\n\nWhen run in a container, the container image should provide the CUDA runtime,\nand the host driver is injected into the container. In this case, because CUDA drivers\nare backwards compatible, it is possible to use an older SDK with a newer driver across major versions.\n\nSee https://docs.nvidia.com/deploy/cuda-compatibility/ for details.\n", "example": "11.4", "pattern": "^\\d+\\.\\d+$" }, "cudaComputeCapability": { "oneOf": [ { "type": "string", "title": "CUDA compute capability", "description": "The compute capability supported by the GPU hardware.", "pattern": "^\\d+\\.\\d+$" }, { "type": "array", "title": "CUDAComputeCapabilityArray", "items": { "type": "string", "title": "CUDA compute capability", "description": "The compute capability supported by the GPU hardware.", "pattern": "^\\d+\\.\\d+$" }, "minItems": 1 } ], "title": "CUDA compute capability", "description": "The compute capability supported by the GPU hardware.\n\n* If this is a single value, it defines only the minimum compute capability.\n GPUs with higher capability are also accepted.\n* If it is an array value, then only select GPUs with compute capabilities that explicitly\n appear in the array.\n See https://docs.nvidia.com/deploy/cuda-compatibility/#faq and\n https://docs.nvidia.com/cuda/cuda-c-best-practices-guide/index.html#cuda-compute-capability\n for details.\n" }, "cudaDeviceCountMin": { "type": "integer", "title": "CUDA device count minimum", "description": "The minimum amount of devices required.", "default": 1, "example": 1, "minimum": 1 }, "cudaDeviceCountMax": { "type": "integer", "title": "CUDA device count maximum", "description": "The maximum amount of devices required.", "default": 1, "example": 8, "minimum": 1 } }, "required": [ "cudaVersionMin", "cudaComputeCapability" ], "additionalProperties": false }, "CWLAtomic": { "allOf": [ { "$ref": "#/components/schemas/CWLVersion" }, { "$ref": "#/components/schemas/CWLMetadata" }, { "$ref": "#/components/schemas/CWLDocumentation" }, { "$ref": "#/components/schemas/CWLAtomicBase" } ] }, "CWLAtomicNested": { "description": "Same as 'CWLAtomic', but 'cwlVersion' not repeated (only at root).", "allOf": [ { "$ref": "#/components/schemas/CWLMetadata" }, { "$ref": "#/components/schemas/CWLDocumentation" }, { "$ref": "#/components/schemas/CWLAtomicBase" } ] }, "CWLGraph": { "title": "CWLGraph", "allOf": [ { "$ref": "#/components/schemas/CWLVersion" }, { "$ref": "#/components/schemas/CWLMetadata" }, { "$ref": "#/components/schemas/CWLDocumentation" }, { "type": "object", "properties": { "$graph": { "type": "array", "title": "CWLGraphList", "description": "Graph definition that defines *exactly one* CWL application package represented as list. Multiple definitions simultaneously deployed is NOT supported currently.", "items": { "allOf": [ { "$ref": "#/components/schemas/CWLMetadata" }, { "$ref": "#/components/schemas/CWLDocumentation" }, { "type": "object", "title": "CWLGraphItem", "properties": { "class": { "type": "string", "title": "Class", "description": "CWL class specification. This is used to differentiate between single Application Package (AP)definitions and Workflow that chains multiple packages.", "enum": [ "CommandLineTool", "ExpressionTool", "Workflow" ] }, "id": { "$ref": "#/components/schemas/CWLAtomicBase/properties/id" }, "intent": { "$ref": "#/components/schemas/CWLAtomicBase/properties/intent" }, "requirements": { "$ref": "#/components/schemas/CWLRequirements" }, "hints": { "$ref": "#/components/schemas/CWLHints" }, "baseCommand": { "$ref": "#/components/schemas/CWLCommand" }, "arguments": { "$ref": "#/components/schemas/CWLArguments" }, "inputs": { "$ref": "#/components/schemas/CWLInputsDefinition" }, "outputs": { "$ref": "#/components/schemas/CWLOutputsDefinition" }, "scatter": { "$ref": "#/components/schemas/CWLAtomicBase/properties/scatter" }, "scatterMethod": { "$ref": "#/components/schemas/CWLAtomicBase/properties/scatterMethod" } }, "required": [ "class", "id", "inputs", "outputs" ] } ] }, "maxItems": 1, "minItems": 1 } }, "required": [ "$graph" ] } ] }, "CWLWorkflow": { "allOf": [ { "$ref": "#/components/schemas/CWLVersion" }, { "$ref": "#/components/schemas/CWLMetadata" }, { "$ref": "#/components/schemas/CWLDocumentation" }, { "$ref": "#/components/schemas/CWLWorkflowClass" }, { "$ref": "#/components/schemas/CWLWorkflowBase" } ] }, "CWLWorkflowClass": { "type": "object", "properties": { "class": { "type": "string", "enum": [ "Workflow" ] } } }, "CWLWorkflowBase": { "type": "object", "properties": { "steps": { "$ref": "#/components/schemas/CWLWorkflowSteps" }, "inputs": { "$ref": "#/components/schemas/CWLInputsDefinition" }, "outputs": { "$ref": "#/components/schemas/CWLOutputsDefinition" }, "requirements": { "description": "Technically a different subset, but lots of redefinitions to be done.", "$ref": "#/components/schemas/CWLRequirements" }, "hints": { "description": "Technically a different subset, but lots of redefinitions to be done.", "$ref": "#/components/schemas/CWLHints" } } }, "CWLWorkflowSteps": { "oneOf": [ { "$ref": "#/components/schemas/CWLWorkflowStepMap" }, { "$ref": "#/components/schemas/CWLWorkflowStepList" } ] }, "CWLInputsDefinition": { "oneOf": [ { "$ref": "#/components/schemas/CWLInputList" }, { "description": "Avoid 'oneOf' conflict of generic mapping key strings as input identifier matching against '$import'.", "allOf": [ { "$ref": "#/components/schemas/CWLInputMap" }, { "not": { "$ref": "#/components/schemas/CWLImport" } } ] }, { "$ref": "#/components/schemas/CWLImport" } ], "title": "CWLInputsDefinition", "description": "All inputs available to the Application Package." }, "CWLOutputsDefinition": { "oneOf": [ { "$ref": "#/components/schemas/CWLOutputList" }, { "description": "Avoid 'oneOf' conflict of generic mapping key strings as output identifier matching against '$import'.", "allOf": [ { "$ref": "#/components/schemas/CWLOutputMap" }, { "not": { "$ref": "#/components/schemas/CWLImport" } } ] }, { "$ref": "#/components/schemas/CWLImport" } ], "title": "CWLOutputsDefinition", "description": "All outputs produced by the Application Package." }, "CWLWorkflowStepMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CWLWorkflowStepObject" } }, "CWLWorkflowStepList": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CWLWorkflowStepId" }, { "$ref": "#/components/schemas/CWLWorkflowStepObject" } ] } }, "CWLInputList": { "type": "array", "title": "CWLInputList", "description": "Package inputs defined as items.", "items": { "$ref": "#/components/schemas/CWLInputItem" } }, "CWLInputMap": { "type": "object", "title": "CWLInputMap", "description": "Package inputs defined as mapping.", "additionalProperties": { "oneOf": [ { "$ref": "#/components/schemas/CWLType" }, { "title": "CWLInputObject (CWL type definition with parameters).", "allOf": [ { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CWLType" }, "inputBinding": { "$ref": "#/components/schemas/InputBinding" } }, "required": [ "type" ], "additionalProperties": {} }, { "$ref": "#/components/schemas/CWLDefaultTypedConditional" }, { "$ref": "#/components/schemas/CWLDocumentation" } ] }, { "$ref": "#/components/schemas/CWLInputStdIn" }, { "$ref": "#/components/schemas/CWLImport" } ] } }, "ResourceQuantityOrFractional": { "title": "An item quantity that can also represent a proportion of use by resources.", "description": "Technically should be minimum=1, but fractional for scheduling algorithms are allowed.\nThere is no way to distinguish between float/long simultaneously in JSON schema (multi-match oneOf).\nTherefore, only validate that it is greater than zero.\n", "type": "number", "exclusiveMinimum": true, "minimum": 0, "default": 1 }, "CWLExpression": { "type": "string", "title": "CWLExpression", "description": "When combined with 'InlineJavascriptRequirement', this field allows runtime parameter references\n(see also: https://www.commonwl.org/v1.2/CommandLineTool.html#Expression).\nWhenever this option is applicable for a parameter, any other 'normal' string should not be specified.\nFor JSON schema validation, there is no easy way to distinguish them unless using complicated string patterns.\n" }, "InitialWorkDirListing": { "title": "InitialWorkDirListing", "oneOf": [ { "$ref": "#/components/schemas/CWLExpression" }, { "type": "array", "title": "InitialWorkDirListingItems", "items": { "oneOf": [ { "nullable": true, "enum": [ null ] }, { "$ref": "#/components/schemas/CWLExpression" }, { "$ref": "#/components/schemas/DirectoryListingDirent" }, { "$ref": "#/components/schemas/DirectoryListingFileOrDirectory" }, { "type": "array", "items": { "$ref": "#/components/schemas/DirectoryListingFileOrDirectory" } } ] } } ] }, "CWLRequirementsMap": { "title": "CWLRequirementsMap", "type": "object", "properties": { "cwltool:CUDARequirement": { "$ref": "#/components/schemas/cwltool_CUDARequirement" }, "DockerRequirement": { "$ref": "#/components/schemas/DockerRequirement" }, "SoftwareRequirement": { "$ref": "#/components/schemas/SoftwareRequirement" }, "ShellCommandRequirement": { "$ref": "#/components/schemas/ShellCommandRequirement" }, "EnvVarRequirement": { "$ref": "#/components/schemas/EnvVarRequirement" }, "SchemaDefRequirement": { "$ref": "#/components/schemas/SchemaDefRequirement" }, "InitialWorkDirRequirement": { "$ref": "#/components/schemas/InitialWorkDirRequirement" }, "InlineJavascriptRequirement": { "$ref": "#/components/schemas/InlineJavascriptRequirement" }, "InplaceUpdateRequirement": { "$ref": "#/components/schemas/InplaceUpdateRequirement" }, "LoadListingRequirement": { "$ref": "#/components/schemas/LoadListingRequirement" }, "NetworkAccess": { "allOf": [ { "description": "Not 'NetworkAccessRequirement'" }, { "$ref": "#/components/schemas/NetworkAccessRequirement" } ] }, "ResourceRequirement": { "$ref": "#/components/schemas/ResourceRequirement" }, "ScatterFeatureRequirement": { "$ref": "#/components/schemas/ScatterFeatureRequirement" }, "ToolTimeLimit": { "allOf": [ { "description": "Not 'ToolTimeLimitRequirement'" }, { "$ref": "#/components/schemas/ToolTimeLimitRequirement" } ] }, "WorkReuse": { "allOf": [ { "description": "Not 'WorkReuseRequirement'" }, { "$ref": "#/components/schemas/WorkReuseRequirement" } ] }, "MultipleInputFeatureRequirement": { "$ref": "#/components/schemas/MultipleInputFeatureRequirement" }, "StepInputExpressionRequirement": { "$ref": "#/components/schemas/StepInputExpressionRequirement" }, "SubworkflowFeatureRequirement": { "$ref": "#/components/schemas/SubworkflowFeatureRequirement" } }, "additionalProperties": false }, "CWLRequirements": { "title": "CWLRequirements", "description": "Explicit requirement to execute the application package.", "oneOf": [ { "$ref": "#/components/schemas/CWLRequirementsMap" }, { "$ref": "#/components/schemas/CWLRequirementsList" } ] }, "CWLCommand": { "oneOf": [ { "type": "string", "title": "String command." }, { "type": "array", "title": "Command Parts", "items": { "type": "string", "title": "cmd" }, "additionalProperties": false } ], "title": "CWLCommand", "description": "Command called in the docker image or on shell according to requirements\nand hints specifications. Can be omitted if already defined in the docker\nimage.\n" }, "InputBinding": { "type": "object", "title": "Input Binding", "description": "Defines how to specify the input for the command.", "properties": { "prefix": { "type": "string" }, "position": { "oneOf": [ { "type": "integer" }, { "$ref": "#/components/schemas/CWLExpression" } ] }, "valueFrom": { "$ref": "#/components/schemas/CWLExpression" }, "itemSeparator": { "type": "string" }, "shellQuote": { "type": "boolean" } }, "additionalProperties": false }, "CWLInputItem": { "title": "Input", "description": "Input specification. Note that multiple formats are supported and\nnot all specification variants or parameters are presented here. Please refer\nto official CWL documentation for more details (https://www.commonwl.org).\n", "allOf": [ { "type": "object", "properties": { "type": { "oneOf": [ { "$ref": "#/components/schemas/CWLType" }, { "$ref": "#/components/schemas/CWLInputStdIn" } ] }, "inputBinding": { "$ref": "#/components/schemas/InputBinding" }, "id": { "description": "Identifier of the CWL input.", "$ref": "#/components/schemas/CWLAtomicBase/properties/id" } }, "required": [ "type", "id" ], "additionalProperties": {} }, { "$ref": "#/components/schemas/CWLDefaultTypedConditional" }, { "$ref": "#/components/schemas/CWLDocumentation" } ] }, "DirectoryListingDirent": { "description": "Called 'Dirent' in documentation.", "type": "object", "title": "DirectoryListingDirent", "properties": { "entry": { "$ref": "#/components/schemas/CWLExpression" }, "entryname": { "$ref": "#/components/schemas/CWLExpression" }, "writable": { "type": "boolean" } }, "required": [ "entry" ], "additionalProperties": false }, "DirectoryListingFileOrDirectory": { "type": "object", "properties": { "class": { "type": "string", "enum": [ "File", "Directory" ] }, "location": { "type": "string" }, "checksum": { "description": "Minimal pattern check to know which hash algorithm to apply,\nbut don't check too harshly for the rest (length, allowed characters, etc.).\n", "type": "string", "pattern": "^[a-z0-9\\-]+\\$[\\w\\-.]+$" }, "size": { "type": "integer", "minimum": 0 } }, "required": [ "class", "location" ], "additionalProperties": false }, "SoftwareRequirement": { "type": "object", "properties": { "class": { "type": "string", "enum": [ "SoftwareRequirement" ] }, "packages": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SoftwarePackage" } }, { "type": "object", "description": "Mapping of 'package' name to its specifications.", "additionalProperties": { "oneOf": [ { "$ref": "#/components/schemas/SoftwarePackageSpecs" }, { "$ref": "#/components/schemas/SoftwarePackage" } ] } } ] } }, "required": [ "packages" ], "additionalProperties": false }, "DockerRequirement": { "type": "object", "title": "DockerRequirement", "properties": { "class": { "type": "string", "enum": [ "DockerRequirement" ] }, "dockerPull": { "type": "string", "title": "Docker pull reference", "description": "Reference package that will be retrieved and executed by CWL.", "example": "docker-registry.host.com/namespace/image:1.2.3" }, "dockerImport": { "type": "string" }, "dockerLoad": { "type": "string" }, "dockerFile": { "type": "string" }, "dockerImageId": { "type": "string" }, "dockerOutputDirectory": { "type": "string" } }, "oneOf": [ { "required": [ "dockerPull" ] }, { "required": [ "dockerImport" ] }, { "required": [ "dockerLoad" ] }, { "required": [ "dockerFile" ] } ], "additionalProperties": false }, "ShellCommandRequirement": { "type": "object", "properties": { "class": { "type": "string", "enum": [ "ShellCommandRequirement" ] } }, "additionalProperties": false }, "EnvVarRequirement": { "type": "object", "properties": { "class": { "type": "string", "enum": [ "EnvVarRequirement" ] }, "envDef": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentDef" } }, { "type": "object", "description": "Mapping of 'envName' to environment value or definition.", "additionalProperties": { "oneOf": [ { "description": "The 'envValue' specified directly", "$ref": "#/components/schemas/CWLExpression" }, { "$ref": "#/components/schemas/EnvironmentDef" } ] } } ] } }, "required": [ "envDef" ], "additionalProperties": false }, "SchemaDefRequirement": { "type": "object", "properties": { "class": { "type": "string", "enum": [ "SchemaDefRequirement" ] }, "types": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CWLTypeEnum" }, { "$ref": "#/components/schemas/CWLTypeRecordSchema" }, { "$ref": "#/components/schemas/CWLTypeRecordArray" }, { "$ref": "#/components/schemas/CWLImport" } ] } } }, "required": [ "types" ], "additionalProperties": false }, "InitialWorkDirRequirement": { "type": "object", "title": "InitialWorkDirRequirement", "properties": { "class": { "type": "string", "enum": [ "InitialWorkDirRequirement" ] }, "listing": { "$ref": "#/components/schemas/InitialWorkDirListing" } }, "required": [ "listing" ], "additionalProperties": false }, "InlineJavascriptRequirement": { "type": "object", "title": "InlineJavascriptRequirement", "description": "Indicates that the workflow platform must support inline Javascript expressions.\n\nIf this requirement is not present, the workflow platform must not perform expression interpolation\n(see also: https://www.commonwl.org/v1.2/CommandLineTool.html#InlineJavascriptRequirement).\n", "properties": { "class": { "type": "string", "enum": [ "InlineJavascriptRequirement" ] }, "expressionLib": { "type": "array", "title": "InlineJavascriptLibraries", "description": "Additional code fragments that will also be inserted before executing the expression code.\nAllows for function definitions that may be called from CWL expressions.\n", "items": { "title": "exp_lib", "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "$include": { "type": "string" } }, "required": [ "$include" ], "additionalProperties": false } ] } } }, "required": [ "expressionLib" ], "additionalProperties": false }, "InplaceUpdateRequirement": { "type": "object", "title": "InplaceUpdateRequirement", "description": "If 'inplaceUpdate' is true, then an implementation supporting this feature may permit tools to directly\nupdate files with 'writable: true' in 'InitialWorkDirRequirement'. That is, as an optimization,\nfiles may be destructively modified in place as opposed to copied and updated\n(see also: https://www.commonwl.org/v1.2/CommandLineTool.html#InplaceUpdateRequirement).\n", "properties": { "class": { "type": "string", "enum": [ "InplaceUpdateRequirement" ] }, "inplaceUpdate": { "type": "boolean", "title": "inplaceUpdate" } }, "required": [ "inplaceUpdate" ], "additionalProperties": false }, "LoadListingRequirement": { "type": "object", "title": "LoadListingRequirement", "description": "Specify the desired behavior for loading the listing field of a 'Directory' object for use by expressions\n(see also: https://www.commonwl.org/v1.2/CommandLineTool.html#LoadListingRequirement).\n", "properties": { "class": { "type": "string", "enum": [ "LoadListingRequirement" ] }, "loadListing": { "type": "string", "title": "LoadListingEnum", "enum": [ "no_listing", "shallow_listing", "deep_listing" ] } }, "required": [ "loadListing" ], "additionalProperties": false }, "NetworkAccessRequirement": { "type": "object", "title": "NetworkAccessRequirement", "properties": { "class": { "type": "string", "description": "Not 'NetworkAccessRequirement'", "enum": [ "NetworkAccess" ] }, "networkAccess": { "$ref": "#/components/schemas/NetworkAccess" } }, "required": [ "networkAccess" ], "additionalProperties": false }, "ResourceRequirement": { "type": "object", "title": "ResourceRequirement", "description": "Specify basic hardware resource requirements\n(see also: https://www.commonwl.org/v1.2/CommandLineTool.html#ResourceRequirement).\n", "properties": { "class": { "type": "string", "enum": [ "ResourceRequirement" ] }, "coresMin": { "oneOf": [ { "$ref": "#/components/schemas/ResourceQuantityOrFractional" }, { "$ref": "#/components/schemas/CWLExpression" } ], "title": "ResourceCoresMinimum (Minimum reserved number of CPU cores).", "description": "Minimum reserved number of CPU cores.\n\nMay be a fractional value to indicate to a scheduling algorithm that one core can be allocated to\nmultiple jobs. For example, a value of 0.25 indicates that up to 4 jobs\nmay run in parallel on 1 core. A value of 1.25 means that up to 3 jobs\ncan run on a 4 core system (4/1.25 ~ 3).\n\nProcesses can only share a core allocation if the sum of each of their 'ramMax', 'tmpdirMax', and\n'outdirMax' requests also do not exceed the capacity of the node.\n\nProcesses sharing a core must have the same level of isolation (typically a container\nor VM) that they would normally have.\n\nThe reported number of CPU cores reserved for the process, which is available to expressions\non the 'CommandLineTool' as 'runtime.cores', must be a non-zero integer, and may be calculated by\nrounding up the cores request to the next whole number.\n\nScheduling systems may allocate fractional CPU resources by setting quotas or scheduling weights.\nScheduling systems that do not support fractional CPUs may round up the request to the next whole number.\n", "default": 1 }, "coresMax": { "oneOf": [ { "$ref": "#/components/schemas/ResourceQuantityOrFractional" }, { "$ref": "#/components/schemas/CWLExpression" } ], "title": "ResourceCoresMaximum (Maximum reserved number of CPU cores).", "description": "Maximum reserved number of CPU cores.\nSee 'coresMin' for discussion about fractional CPU requests.\n" }, "ramMin": { "oneOf": [ { "$ref": "#/components/schemas/ResourceQuantityOrFractional" }, { "$ref": "#/components/schemas/CWLExpression" } ], "title": "ResourceRAMMinimum (Minimum reserved RAM in mebibytes).", "description": "Minimum reserved RAM in mebibytes (2**20).\n\nMay be a fractional value. If so, the actual RAM request must be rounded up\nto the next whole number.\n\nThe reported amount of RAM reserved for the process, which is available to\nexpressions on the 'CommandLineTool' as 'runtime.ram', must be a non-zero integer.\n", "default": 256 }, "ramMax": { "oneOf": [ { "$ref": "#/components/schemas/ResourceQuantityOrFractional" }, { "$ref": "#/components/schemas/CWLExpression" } ], "title": "ResourceRAMMaximum (Maximum reserved RAM in mebibytes).", "description": "Maximum reserved RAM in mebibytes (2**20).\nSee 'ramMin' for discussion about fractional RAM requests.\n" }, "tmpdirMin": { "oneOf": [ { "$ref": "#/components/schemas/ResourceQuantityOrFractional" }, { "$ref": "#/components/schemas/CWLExpression" } ], "title": "ResourceTmpDirMinimum (Minimum reserved filesystem based storage for the designated temporary) directory in mebibytes.", "description": "Minimum reserved filesystem based storage for the designated temporary\ndirectory in mebibytes (2**20).\n\nMay be a fractional value. If so, the actual storage request must be rounded\nup to the next whole number.\n\nThe reported amount of storage reserved for the process, which is available\nto expressions on the 'CommandLineTool' as 'runtime.tmpdirSize', must be a non-zero integer.\n", "default": 1024 }, "tmpdirMax": { "oneOf": [ { "$ref": "#/components/schemas/ResourceQuantityOrFractional" }, { "$ref": "#/components/schemas/CWLExpression" } ], "title": "ResourceTmpDirMaximum (Maximum reserved filesystem based storage for the designated temporary directory in mebibytes).", "description": "Maximum reserved filesystem based storage for the designated temporary directory in mebibytes (2**20).\nSee 'tmpdirMin' for discussion about fractional storage requests.\n" }, "outdirMin": { "oneOf": [ { "$ref": "#/components/schemas/ResourceQuantityOrFractional" }, { "$ref": "#/components/schemas/CWLExpression" } ], "title": "ResourceOutDirMinimum (Minimum reserved filesystem based storage for the designated output directory in mebibytes).", "description": "Minimum reserved filesystem based storage for the designated output\ndirectory in mebibytes (2**20).\n\nMay be a fractional value. If so, the actual storage request must be rounded\nup to the next whole number.\n\nThe reported amount of storage reserved for the process, which is available\nto expressions on the 'CommandLineTool' as 'runtime.outdirSize', must be a non-zero integer.\n", "default": 1024 }, "outdirMax": { "oneOf": [ { "$ref": "#/components/schemas/ResourceQuantityOrFractional" }, { "$ref": "#/components/schemas/CWLExpression" } ], "title": "ResourceOutDirMaximum (Maximum reserved filesystem based storage for the designated output directory in mebibytes).", "description": "Maximum reserved filesystem based storage for the designated output\ndirectory in mebibytes (2**20).\nSee 'outdirMin' for discussion about fractional storage requests.\n", "default": 1 } }, "additionalProperties": false }, "ScatterFeatureRequirement": { "type": "object", "title": "ScatterFeatureRequirement", "description": "A 'scatter' operation specifies that the associated Workflow step should execute separately over a list of\ninput elements. Each job making up a scatter operation is independent and may be executed concurrently\n(see also: https://www.commonwl.org/v1.2/Workflow.html#WorkflowStep).\nFields 'scatter' and 'scatterMethod' at the root of a 'WorkflowStep', not within the requirement.\n", "properties": { "class": { "type": "string", "description": "CWL requirement class specification.", "enum": [ "ScatterFeatureRequirement" ] } }, "additionalProperties": false }, "WorkReuseRequirement": { "type": "object", "title": "WorkReuseRequirement", "description": "For implementations that support reusing output from past work\n(on the assumption that same code and same input produce same results),\ncontrol whether to enable or disable the reuse behavior for a particular tool\nor step (to accommodate situations where that assumption is incorrect).\nA reused step is not executed but instead returns the same output as the original execution.\nIf 'WorkReuse' is not specified, correct tools should assume it is enabled by default.\n", "properties": { "class": { "type": "string", "description": "Not 'WorkReuseRequirement'.", "enum": [ "WorkReuse" ] }, "enableReuse": { "oneOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/CWLExpression" } ], "title": "EnableReuseValue", "description": "Indicates if reuse is enabled for this tool.\n\nCan be an expression when combined with 'InlineJavascriptRequirement'\n(see also: https://www.commonwl.org/v1.2/CommandLineTool.html#Expression).\n" } }, "required": [ "enableReuse" ], "additionalProperties": false }, "ToolTimeLimitRequirement": { "type": "object", "title": "ToolTimeLimitRequirement", "description": "Set an upper limit on the execution time of a CommandLineTool.\n\nA CommandLineTool whose execution duration exceeds the time limit may be preemptively\nterminated and considered failed. May also be used by batch systems to make scheduling decisions.\n\nThe execution duration excludes external operations, such as staging of files,\npulling a docker image etc., and only counts wall-time for the execution of the command line itself.\n", "properties": { "class": { "type": "string", "description": "not 'ToolTimeLimitRequirement'", "enum": [ "ToolTimeLimit" ] }, "timelimit": { "oneOf": [ { "type": "number", "minimum": 0 }, { "$ref": "#/components/schemas/CWLExpression" } ], "title": "TimeLimitValue", "description": "The time limit, in seconds.\n\nA time limit of zero means no time limit.\nNegative time limits are an error.\n" } }, "required": [ "timelimit" ], "additionalProperties": false }, "MultipleInputFeatureRequirement": { "type": "object", "title": "MultipleInputFeatureRequirement", "description": "Indicates that the 'Workflow' must support multiple inbound data links listed in the 'source'\nfield of 'WorkflowStepInput'.\n", "properties": { "class": { "type": "string", "description": "CWL requirement class specification.", "enum": [ "MultipleInputFeatureRequirement" ] } }, "additionalProperties": false }, "StepInputExpressionRequirement": { "type": "object", "title": "StepInputExpressionRequirement", "description": "Indicates that the 'Workflow' must support the 'valueFrom' field of 'WorkflowStepInput'.", "properties": { "class": { "type": "string", "description": "CWL requirement class specification.", "enum": [ "StepInputExpressionRequirement" ] } }, "additionalProperties": false }, "SubworkflowFeatureRequirement": { "type": "object", "title": "SubworkflowFeatureRequirement", "description": "Indicates that the 'Workflow' must support nested workflows in the 'run' field of 'WorkflowStep'.", "properties": { "class": { "type": "string", "description": "CWL requirement class specification.", "enum": [ "SubworkflowFeatureRequirement" ] } }, "additionalProperties": false }, "CWLHints": { "oneOf": [ { "$ref": "#/components/schemas/CWLHintsMap" }, { "$ref": "#/components/schemas/CWLHintsList" } ], "title": "CWLHints", "description": "Non-failing additional hints that can help resolve extra requirements." }, "CWLWorkflowStepDefinition": { "type": "object", "properties": { "in": { "$ref": "#/components/schemas/CWLWorkflowStepIn" }, "run": { "$ref": "#/components/schemas/CWLWorkflowStepRun" }, "when": { "$ref": "#/components/schemas/CWLWorkflowStepOut" }, "out": { "description": "Mapping of Workflow step inputs to nested CWL tool definitions inputs or outputs.", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CWLAtomicBase/properties/id" }, { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/CWLAtomicBase/properties/id" } }, "required": [ "id" ], "additionalProperties": false } ] } } }, "required": [ "in", "run", "out" ] }, "CWLWorkflowStepScatter": { "type": "object", "properties": { "scatter": { "oneOf": [ { "$ref": "#/components/schemas/CWLAtomicBase/properties/id/anyOf/1" }, { "type": "array", "title": "IdentifierArray", "items": { "$ref": "#/components/schemas/CWLAtomicBase/properties/id/anyOf/1" }, "minItems": 1 } ], "title": "Scatter", "description": "The scatter field specifies one or more input parameters which will be scattered.\n\nAn input parameter may be listed more than once. The declared type of each\ninput parameter implicitly becomes an array of items of the input parameter type.\nIf a parameter is listed more than once, it becomes a nested array. As a result,\nupstream parameters which are connected to scattered parameters must be arrays.\n\nAll output parameter types are also implicitly wrapped in arrays. Each job\nin the scatter results in an entry in the output array.\n\nIf any scattered parameter runtime value is an empty array, all outputs are\nset to empty arrays and no work is done for the step, according to applicable scattering rules.\n" }, "scatterMethod": { "type": "string", "title": "scatterMethod", "description": "If 'scatter' declares more than one input parameter, 'scatterMethod'\ndescribes how to decompose the input into a discrete set of jobs.\n\n- dotproduct: specifies that each of the input arrays are aligned and\n one element taken from each array to construct each job. It is an\n error if all input arrays are not the same length.\n\n- nested_crossproduct: specifies the Cartesian product of the inputs, producing\n a job for every combination of the scattered inputs. The output must be nested\n arrays for each level of scattering, in the order that the input arrays\n are listed in the 'scatter' field.\n\n- flat_crossproduct: specifies the Cartesian product of the inputs, producing a\n job for every combination of the scattered inputs. The output arrays must be\n flattened to a single level, but otherwise listed in the order that the input\n arrays are listed in the 'scatter' field.\n", "default": "dotproduct", "enum": [ "dotproduct", "nested_crossproduct", "flat_crossproduct" ] } } }, "CWLWorkflowStepId": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/CWLAtomicBase/properties/id" } }, "required": [ "id" ] }, "CWLHintsMap": { "title": "CWLHintsMap", "anyOf": [ { "$ref": "#/components/schemas/CWLRequirementsMap" }, { "type": "object", "properties": { "BuiltinRequirement": { "type": "object", "title": "BuiltinRequirement", "description": "Hint indicating that the Application Package corresponds to a\nbuiltin process of this instance. (note: can only be an 'hint'\nas it is unofficial CWL specification).\n", "properties": { "class": { "type": "string", "enum": [ "BuiltinRequirement" ] }, "process": { "description": "Builtin process identifier.", "$ref": "#/components/schemas/CWLAtomicBase/properties/id/anyOf/1" } }, "required": [ "process", "class" ], "additionalProperties": false }, "OGCAPIRequirement": { "type": "object", "title": "OGCAPIRequirement", "description": "Hint indicating that the Application Package corresponds to an\nOGC API - Processes provider that should be remotely executed and monitored\nby this instance. (note: can only be an 'hint' as it is unofficial CWL specification).\n", "properties": { "class": { "type": "string", "enum": [ "OGCAPIRequirement" ] }, "process": { "description": "Process location.", "$ref": "#/components/schemas/SoftwarePackage/properties/specs/items" } }, "required": [ "process" ], "additionalProperties": false }, "WPS1Requirement": { "type": "object", "title": "WPS1Requirement", "description": "Hint indicating that the Application Package corresponds to a\nWPS-1 provider process that should be remotely executed and monitored by this\ninstance. (note: can only be an ''hint'' as it is unofficial CWL specification).\n", "properties": { "class": { "type": "string", "enum": [ "WPS1Requirement" ] }, "process": { "description": "Process identifier of the remote WPS provider.", "$ref": "#/components/schemas/CWLAtomicBase/properties/id/anyOf/1" }, "provider": { "description": "WPS provider endpoint.", "$ref": "#/components/schemas/SoftwarePackage/properties/specs/items" } }, "required": [ "process", "provider" ], "additionalProperties": false } }, "additionalProperties": { "type": "object", "description": "Generic schema to allow alternative CWL requirements/hints not explicitly defined in schemas.", "properties": { "class": { "type": "string", "title": "Requirement Class Identifier", "description": "CWL requirement class specification.", "example": "UnknownRequirement", "not": { "enum": [ "cwltool:CUDARequirement", "DockerRequirement", "SoftwareRequirement", "ShellCommandRequirement", "EnvVarRequirement", "SchemaDefRequirement", "InitialWorkDirRequirement", "InlineJavascriptRequirement", "InplaceUpdateRequirement", "LoadListingRequirement", "NetworkAccess", "ResourceRequirement", "ScatterFeatureRequirement", "ToolTimeLimit", "WorkReuse", "MultipleInputFeatureRequirement", "StepInputExpressionRequirement", "SubworkflowFeatureRequirement" ] } } } } } ] }, "CWLHintsList": { "type": "array", "title": "CWLHintsList", "items": { "oneOf": [ { "allOf": [ { "description": "When using the list representation, 'class' is required to indicate which one is being represented.\nWhen using the mapping representation, 'class' is optional since it's the key, but it must match by name.\n", "required": [ "class" ] }, { "title": "CWLHintsItem", "description": "For any new items added, ensure they are added under 'class' of 'UnknownRequirement' as well.\nOtherwise, insufficiently restrictive classes could cause multiple matches, failing the 'oneOf' condition.\n", "oneOf": [ { "$ref": "#/components/schemas/CWLRequirementsItem" }, { "oneOf": [ { "$ref": "#/components/schemas/CWLHintsMap/anyOf/1/properties/BuiltinRequirement" }, { "$ref": "#/components/schemas/CWLHintsMap/anyOf/1/properties/OGCAPIRequirement" }, { "$ref": "#/components/schemas/CWLHintsMap/anyOf/1/properties/WPS1Requirement" }, { "$ref": "#/components/schemas/CWLHintsMap/anyOf/1/additionalProperties" } ] } ] } ] }, { "$ref": "#/components/schemas/CWLImport" } ] } }, "CWLWorkflowStepIn": { "description": "Mapping of Workflow step inputs to nested CWL tool definitions inputs or outputs.", "oneOf": [ { "$ref": "#/components/schemas/CWLWorkflowStepInMap" }, { "$ref": "#/components/schemas/CWLWorkflowStepInList" } ] }, "CWLWorkflowStepRun": { "description": "Nested CWL definition to run as Workflow step.", "oneOf": [ { "description": "File or URL reference to a CWL tool definition.", "type": "string" }, { "description": "Nested CWL tool definition for the step.", "$ref": "#/components/schemas/CWLAtomicNested" }, { "description": "Nested CWL Workflow definition for the step.", "allOf": [ { "$ref": "#/components/schemas/CWLMetadata" }, { "$ref": "#/components/schemas/CWLDocumentation" }, { "$ref": "#/components/schemas/CWLWorkflowClass" }, { "$ref": "#/components/schemas/CWLWorkflowBase" } ] } ] }, "CWLWorkflowStepWhen": { "$ref": "#/components/schemas/CWLWorkflowStepOut" }, "CWLWorkflowStepOut": { "description": "Condition to execute a step that must evaluate to a boolean-like value.", "type": "string", "title": "CWLExpression" }, "CWLWorkflowStepInMap": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } }, { "allOf": [ { "$ref": "#/components/schemas/CWLWorkflowStepInputBase" }, { "$ref": "#/components/schemas/CWLWorkflowStepInputDefault" } ] } ] } }, "CWLWorkflowStepInList": { "type": "array", "items": { "$ref": "#/components/schemas/CWLWorkflowStepInItem" } }, "CWLWorkflowStepInItem": { "allOf": [ { "$ref": "#/components/schemas/CWLWorkflowStepInputId" }, { "$ref": "#/components/schemas/CWLWorkflowStepInputBase" }, { "$ref": "#/components/schemas/CWLWorkflowStepInputDefault" } ] }, "CWLWorkflowStepInputId": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/CWLAtomicBase/properties/id" } }, "required": [ "id" ] }, "CWLWorkflowStepInputBase": { "type": "object", "properties": { "source": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "linkMerge": { "type": "string", "enum": [ "merge_nested", "merge_flattened" ] }, "valueFrom": { "$ref": "#/components/schemas/CWLExpression" } } }, "CWLWorkflowStepInputDefault": { "description": "CWL 'type' is not specified at this level for step inputs\n(it is provided by the mapped input of the nested tool instead).\nTherefore, cannot validate against 'CWLDefaultTypedConditional'.\n", "type": "object", "properties": { "default": { "$ref": "#/components/schemas/CWLDefault" } } }, "NetworkAccess": { "title": "NetworkAccess", "description": "Indicate whether a process requires outgoing IPv4/IPv6 network access.", "example": true, "oneOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/CWLExpression" } ] }, "EnvironmentDef": { "type": "object", "properties": { "envName": { "type": "string", "minLength": 1 }, "envValue": { "$ref": "#/components/schemas/CWLExpression" } }, "required": [ "envName", "envValue" ], "additionalProperties": false }, "CWLType": { "oneOf": [ { "$ref": "#/components/schemas/CWLTypeBase" }, { "$ref": "#/components/schemas/CWLTypeList" } ], "title": "CWL Type" }, "CWLOutputObject": { "allOf": [ { "$ref": "#/components/schemas/CWLDocumentation" }, { "type": "object", "title": "CWLOutputObject (CWL type definition with parameters).", "properties": { "type": { "$ref": "#/components/schemas/CWLType" }, "outputBinding": { "$ref": "#/components/schemas/CWLOutputItem/properties/outputBinding" } }, "required": [ "type" ] } ] }, "CWLOutputStdOut": { "oneOf": [ { "$ref": "#/components/schemas/CWLOutputStdOutDefinition" }, { "$ref": "#/components/schemas/CWLOutputStdOutObjectType" } ] }, "CWLOutputStdErr": { "oneOf": [ { "$ref": "#/components/schemas/CWLOutputStdErrDefinition" }, { "$ref": "#/components/schemas/CWLOutputStdErrObjectType" } ] }, "CWLTypeEnum": { "type": "object", "title": "CWLTypeEnum (CWL type as enum of values).", "properties": { "type": { "type": "string", "title": "type", "example": "enum", "enum": [ "enum" ] }, "symbols": { "type": "array", "title": "CWLTypeSymbols (Allowed values composing the enum).", "items": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "title": "CWLTypeSymbolValues" } } }, "required": [ "type", "symbols" ] }, "CWLTypeRecordSchema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "record" ] }, "fields": { "$ref": "#/components/schemas/CWLTypeRecordFields" }, "name": { "type": "string" } }, "required": [ "type" ] }, "CWLTypeRecordArray": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "array" ] }, "items": { "$ref": "#/components/schemas/CWLType" } }, "required": [ "type", "items" ] }, "CWLDefaultTypedConditional": { "description": "Validate that the 'default' value, if specified, is of same type as the CWL 'type'.\nThis avoids over-accepting anything that does not match the intended type.\nHowever, validation limits itself to data literals and arrays.\nNested type and multi-type definitions will validate against 'Any'.\n", "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "null" ] }, "default": { "nullable": true, "enum": [ null ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "string?" ] }, "default": { "type": "string", "nullable": true } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "boolean", "boolean?" ] }, "default": { "type": "boolean", "nullable": true } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "int", "int?", "long", "long?", "float", "float?", "double", "double?", "integer", "integer?" ] }, "default": { "type": "number", "nullable": true } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "File", "File?", "Directory", "Directory?" ] }, "default": { "oneOf": [ { "$ref": "#/components/schemas/CWLDefaultLocation" }, { "nullable": true, "enum": [ null ] } ] } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "pattern": "^[a-zA-Z]+\\\\[\\\\]$" }, "default": { "type": "array", "items": { "$ref": "#/components/schemas/AnyType" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "array" ] }, "items": { "$ref": "#/components/schemas/AnyType" }, "default": { "type": "array", "items": { "$ref": "#/components/schemas/AnyType" } } }, "required": [ "type", "items" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "enum", "enum?" ] }, "symbols": { "type": "array", "items": { "type": "string" } }, "default": { "type": "string", "nullable": true } }, "required": [ "type", "symbols" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Any", "Any?" ] }, "default": { "$ref": "#/components/schemas/AnyType" } }, "required": [ "type" ] } ] }, "CWLTypeBase": { "oneOf": [ { "$ref": "#/components/schemas/CWLTypeDefinition" }, { "$ref": "#/components/schemas/CWLTypeArray" }, { "$ref": "#/components/schemas/CWLTypeEnum" }, { "$ref": "#/components/schemas/CWLTypeRecordRef" }, { "$ref": "#/components/schemas/CWLTypeRecordSchema" } ], "title": "CWLTypeBase" }, "CWLTypeList": { "type": "array", "title": "CWLTypeList (Combination of allowed CWL types).", "items": { "$ref": "#/components/schemas/CWLTypeBase" } }, "AnyType": { "oneOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object" } ] }, "CWLTypeDefinition": { "type": "string", "title": "CWL type string definition", "description": "Note that 'Any' is equivalent to any of the non-null types.\nTherefore, a nullable 'Any' explicitly specified by 'Any?' or its array-nullable form 'Any[]?' are not equivalent.\nField type definition.\n", "enum": [ "null", "Any", "Any?", "Any[]", "Any[]?", "Directory", "Directory?", "Directory[]", "Directory[]?", "File", "File?", "File[]", "File[]?", "boolean", "boolean?", "boolean[]", "boolean[]?", "double", "double?", "double[]", "double[]?", "enum?", "enum[]", "enum[]?", "float", "float?", "float[]", "float[]?", "int", "int?", "int[]", "int[]?", "integer", "integer?", "integer[]", "integer[]?", "long", "long?", "long[]", "long[]?", "string", "string?", "string[]", "string[]?" ] }, "CWLTypeArray": { "type": "object", "title": "CWLTypeArray (CWL type as list of items).", "properties": { "type": { "type": "string", "title": "type", "example": "array", "enum": [ "array" ] }, "items": { "$ref": "#/components/schemas/CWLType" } }, "required": [ "type", "items" ] }, "CWLTypeRecordRef": { "description": "An IRI with minimally a '{Record}' identifier to look for a schema definition locally or remotely.\n\nThe identifier resolution is performed accordingly to the specified reference and as described in\nhttps://www.commonwl.org/v1.2/SchemaSalad.html#Identifier_resolution.\nAvoid 'oneOf' conflict of valid strings between this CWL record reference and the generic CWL types.\n", "allOf": [ { "not": { "$ref": "#/components/schemas/CWLTypeDefinition" } }, { "not": { "$ref": "#/components/schemas/CWLInputStdInDefinition" } }, { "not": { "$ref": "#/components/schemas/CWLOutputStdOutDefinition" } }, { "not": { "$ref": "#/components/schemas/CWLOutputStdErrDefinition" } }, { "type": "string", "format": "url", "pattern": "^(((?:http|ftp)s?:\\/\\/)?(?!.*\\/\\/.*$)(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?\\.)+(?:[A-Za-z]{2,6}\\.?|[A-Za-z0-9-]{2,}\\.?)|localhost|\\[[a-f0-9:]+\\]|\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3})(?::\\d+)?(?:\\/?|[\\/?]\\S+))?(?:[A-Za-z0-9\\w\\-.\\/]+)?\\#?[A-Za-z0-9\\w\\-.]+$" } ] }, "CWLTypeRecordFieldsMap": { "type": "object", "additionalProperties": { "oneOf": [ { "$ref": "#/components/schemas/CWLType" }, { "$ref": "#/components/schemas/CWLTypeRecordFieldDef" } ] } }, "CWLTypeRecordFieldsList": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/CWLTypeRecordFieldDef" }, { "required": [ "name" ] } ] } }, "CWLTypeRecordFieldDefBase": { "type": "object", "properties": { "name": { "description": "Required if list item. Otherwise, optional since it is the mapping key.\nThis requirement is defined in 'CWLTypeRecordFieldsItem' to allow reuse of this schema.\n", "type": "string" }, "type": { "$ref": "#/components/schemas/CWLType" } }, "required": [ "type" ] }, "CWLFileOnlyParametersConditional": { "description": "Explicitly disallow these parameters when non-File type is detected.\nOtherwise, validate their schema definitions according to what is permitted.\nParameters that are only valid when 'type' or 'items' evaluates to 'File'.\n", "type": "object", "anyOf": [ { "$ref": "#/components/schemas/CWLFileOnlyParameters" }, { "not": { "properties": { "secondaryFiles": {}, "streamable": {}, "format": {}, "loadContents": {} } } } ] }, "CWLDirectoryOnlyParametersConditional": { "description": "Explicitly disallow these parameters when non-Directory type is detected.\nOtherwise, validate their schema definitions according to what is permitted.\nParameters that are only valid when 'type' or 'items' evaluates to 'Directory'.\n", "type": "object", "oneOf": [ { "type": "object", "properties": { "loadListing": { "$ref": "#/components/schemas/LoadListingRequirement/properties/loadListing" } } }, { "not": { "properties": { "loadListing": {} } } } ] }, "CWLFileOnlyParameters": { "type": "object", "properties": { "secondaryFiles": { "$ref": "#/components/schemas/CWLTypeRecordSecondaryFiles" }, "streamable": { "type": "boolean" }, "format": { "oneOf": [ { "$ref": "#/components/schemas/CWLExpression" }, { "type": "array", "items": { "$ref": "#/components/schemas/CWLExpression" } } ] }, "loadContents": { "type": "boolean" } } }, "CWLTypeRecordSecondaryFiles": { "oneOf": [ { "description": "Either an expression or the regex pattern directly.", "$ref": "#/components/schemas/CWLExpression" }, { "$ref": "#/components/schemas/CWLTypeRecordSecondaryFileSchema" }, { "type": "array", "items": { "description": "Either an expression or the regex pattern directly.", "$ref": "#/components/schemas/CWLExpression" } }, { "type": "array", "items": { "$ref": "#/components/schemas/CWLTypeRecordSecondaryFileSchema" } } ] }, "CWLTypeRecordSecondaryFileSchema": { "type": "object", "properties": { "pattern": { "description": "Either an expression or the regex pattern directly.", "$ref": "#/components/schemas/CWLExpression" }, "required": { "oneOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/CWLExpression" } ] } }, "required": [ "pattern" ], "additionalProperties": false }, "CWLRequirementsList": { "type": "array", "title": "CWLRequirementsList", "items": { "oneOf": [ { "allOf": [ { "description": "When using the list representation, 'class' is required to indicate which one is being represented.\nWhen using the mapping representation, 'class' is optional since it's the key, but it must match by name.\n", "required": [ "class" ] }, { "$ref": "#/components/schemas/CWLRequirementsItem" } ] }, { "$ref": "#/components/schemas/CWLImport" } ] } }, "CWLRequirementsItem": { "title": "CWLRequirementsItem", "description": "For any new items added, ensure they are added under 'class' of 'UnknownRequirement' as well.\nOtherwise, insufficiently restrictive classes could cause multiple matches, failing the 'oneOf' condition.\n", "oneOf": [ { "$ref": "#/components/schemas/cwltool_CUDARequirement" }, { "$ref": "#/components/schemas/DockerRequirement" }, { "$ref": "#/components/schemas/SoftwareRequirement" }, { "$ref": "#/components/schemas/ShellCommandRequirement" }, { "$ref": "#/components/schemas/EnvVarRequirement" }, { "$ref": "#/components/schemas/SchemaDefRequirement" }, { "$ref": "#/components/schemas/InitialWorkDirRequirement" }, { "$ref": "#/components/schemas/InlineJavascriptRequirement" }, { "$ref": "#/components/schemas/InplaceUpdateRequirement" }, { "$ref": "#/components/schemas/LoadListingRequirement" }, { "$ref": "#/components/schemas/NetworkAccessRequirement" }, { "$ref": "#/components/schemas/ResourceRequirement" }, { "$ref": "#/components/schemas/ScatterFeatureRequirement" }, { "$ref": "#/components/schemas/ToolTimeLimitRequirement" }, { "$ref": "#/components/schemas/WorkReuseRequirement" }, { "$ref": "#/components/schemas/MultipleInputFeatureRequirement" }, { "$ref": "#/components/schemas/StepInputExpressionRequirement" }, { "$ref": "#/components/schemas/SubworkflowFeatureRequirement" } ] }, "CWLOutputStdOutDefinition": { "description": "Indicates that the data pushed to the standard output stream by the command will be redirected to this CWL output.\nCan be defined for only one output. If combined with 'stdout' at the root of the CWL document, that definition\nwill indicate the desired name of the output file where the output stream will be written to. A random name will\nbe applied for the file of this output unless otherwise specified.\n", "type": "string", "enum": [ "stdout" ] }, "CWLOutputStdOutObjectType": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CWLOutputStdOutDefinition" } }, "required": [ "type" ] }, "CWLOutputStdErrDefinition": { "description": "Indicates that the data pushed to the standard error stream by the command will be redirected to this CWL output.\nCan be defined for only one output. If combined with 'stderr' at the root of the CWL document, that definition\nwill indicate the desired name of the output file where the error stream will be written to. A random name will\nbe applied for the file of this output unless otherwise specified.\n", "type": "string", "enum": [ "stderr" ] }, "CWLOutputStdErrObjectType": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CWLOutputStdErrDefinition" } }, "required": [ "type" ] }, "CWLTypeRecordFieldDef": { "allOf": [ { "$ref": "#/components/schemas/CWLTypeRecordFieldDefBase" }, { "$ref": "#/components/schemas/CWLFileOnlyParametersConditional" }, { "$ref": "#/components/schemas/CWLDirectoryOnlyParametersConditional" } ] }, "CWLDefault": { "title": "CWLDefault", "description": "Default value of input if not provided for task execution.", "oneOf": [ { "$ref": "#/components/schemas/AnyLiteralType" }, { "$ref": "#/components/schemas/AnyLiteralList" }, { "$ref": "#/components/schemas/CWLDefaultLocation" }, { "$ref": "#/components/schemas/CWLDefaultObject" }, { "type": "array", "items": { "$ref": "#/components/schemas/CWLDefaultObject" } } ] }, "AnyLiteralType": { "oneOf": [ { "type": "number" }, { "type": "boolean" }, { "type": "string" } ] }, "AnyLiteralList": { "type": "array", "title": "AnyLiteralList", "items": { "$ref": "#/components/schemas/AnyLiteralType" } }, "CWLDefaultLocation": { "type": "object", "properties": { "class": { "type": "string", "enum": [ "File", "Directory" ] }, "path": { "type": "string" }, "location": { "type": "string" }, "basename": { "type": "string" }, "nameroot": { "type": "string" } }, "required": [ "class" ], "oneOf": [ { "required": [ "path" ] }, { "required": [ "location" ] } ], "additionalProperties": false }, "CWLDefaultObject": { "type": "object", "not": { "description": "Avoid false-positive match of default File or Directory location definition.", "properties": { "class": { "type": "string", "enum": [ "File", "Directory" ] } } } }, "CWLTypeRecordFields": { "oneOf": [ { "$ref": "#/components/schemas/CWLTypeRecordFieldsMap" }, { "$ref": "#/components/schemas/CWLTypeRecordFieldsList" } ] }, "CWLImport": { "title": "CWLImport", "description": "The schema validation of the CWL will not itself perform the '$import' to resolve and validate its contents.\nTherefore, the complete schema will not be validated entirely, and could still be partially malformed.\nTo ensure proper and exhaustive validation of a CWL definition with this schema, all '$import' directives\nshould be resolved and extended beforehand.\nRepresents an '$import' directive that should point toward another compatible CWL file to import where specified.\nThe contents of the imported file should be relevant contextually where it is being imported.\n", "type": "object", "properties": { "$import": { "type": "string" } }, "required": [ "$import" ], "additionalProperties": false }, "CWLVersion": { "type": "object", "properties": { "cwlVersion": { "type": "string", "title": "cwlVersion", "description": "CWL version of the described application package.", "pattern": "^v\\d+(\\.\\d+(\\.\\d+)*)*$" } }, "required": [ "cwlVersion" ] }, "CWLMetadata": { "type": "object", "properties": { "s:keywords": { "title": "KeywordList", "type": "array", "description": "Keywords applied to the process for search and categorization purposes.", "items": { "type": "string", "title": "keyword", "minLength": 1 } }, "version": { "type": "string", "title": "version", "description": "Version of the process.", "example": "1.2.3", "pattern": "^\\d+(\\.\\d+(\\.\\d+(\\.[A-Za-z0-9\\-_]+)*)*)*$" } } }, "CWLDocumentation": { "type": "object", "properties": { "label": { "type": "string" }, "doc": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "CWLAtomicBase": { "type": "object", "title": "CWL atomic definition", "description": "Direct CWL definition instead of the graph representation.", "properties": { "id": { "anyOf": [ { "type": "string", "title": "UUID", "description": "Unique identifier.", "format": "uuid", "pattern": "^[a-f0-9]{8}(?:-?[a-f0-9]{4}){3}-?[a-f0-9]{12}$" }, { "description": "Identifier with text pattern that can allow additional non-ASCII characters depending on regex implementation.\nThe identifier allows a '#' or a relative 'sub/part#ref' prefix, to support references to other definitions\nin the CWL document, such as when using 'SchemaDefRequirement'.\n\nJSON spec regex does not include '\\w' in its default subset to allow all word-like unicode characters\n(see reference: https://json-schema.org/understanding-json-schema/reference/regular_expressions.html).\n\nSince support is implementation specific, add both the ASCII-only and '\\w' representation simultaneously\nand let the parser reading this document apply whichever is more relevant or supported\n(see discussion: https://github.com/common-workflow-language/cwl-v1.2/pull/256#discussion_r1234037814).\n", "pattern": "^([A-Za-z0-9\\w]+(/[A-Za-z0-9\\w]+)*)?[#.]?[A-Za-z0-9\\w]+(?:[-_.][A-Za-z0-9\\w]+)*$", "type": "string", "title": "Generic identifier name pattern." } ], "title": "CWLIdentifier", "description": "Reference to the process identifier." }, "class": { "type": "string", "title": "Class", "description": "CWL class specification. This is used to differentiate between single Application Package (AP)definitions and Workflow that chains multiple packages.", "enum": [ "CommandLineTool", "ExpressionTool" ] }, "intent": { "type": "array", "title": "CWLIntent", "items": { "type": "string", "title": "item", "description": "Identifier URL to a concept for the type of computational operation accomplished by this process\n(see example operations: http://edamontology.org/operation_0004).\n", "format": "url", "pattern": "^((?:http|ftp)s?://)?(?!.*//.*$)(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?\\.)+(?:[A-Za-z]{2,6}\\.?|[A-Za-z0-9-]{2,}\\.?)|localhost|\\[[a-f0-9:]+\\]|\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3})(?::\\d+)?(?:/?|[/?]\\S+)$" } }, "requirements": { "$ref": "#/components/schemas/CWLRequirements" }, "hints": { "$ref": "#/components/schemas/CWLHints" }, "baseCommand": { "$ref": "#/components/schemas/CWLCommand" }, "arguments": { "$ref": "#/components/schemas/CWLArguments" }, "inputs": { "$ref": "#/components/schemas/CWLInputsDefinition" }, "outputs": { "$ref": "#/components/schemas/CWLOutputsDefinition" }, "stdin": { "description": "Source of the input stream.\nTypically, an expression referring to an existing file name or an input of the CWL document.\n", "$ref": "#/components/schemas/CWLExpression" }, "stdout": { "description": "Destination of the output stream.\nTypically, an expression referring to a desired file name or provided by a CWL input reference.\n", "$ref": "#/components/schemas/CWLExpression" }, "stderr": { "description": "Destination of the error stream.\nTypically, an expression referring to a desired file name or provided by a CWL input reference.\n", "$ref": "#/components/schemas/CWLExpression" }, "scatter": { "oneOf": [ { "$ref": "#/components/schemas/CWLAtomicBase/properties/id" }, { "type": "array", "title": "CWLScatterMulti", "items": { "$ref": "#/components/schemas/CWLAtomicBase/properties/id" } } ], "title": "CWLScatter", "description": "One or more input identifier of an application step within a Workflow\nwere an array-based input to that Workflow should be scattered across multiple\ninstances of the step application.\n" }, "scatterMethod": { "type": "string", "title": "scatterMethod", "description": "Describes how to decompose the scattered input into a discrete\nset of jobs. When 'dotproduct', specifies that each of the input arrays\nare aligned and one element taken from each array to construct each job.\nIt is an error if all input arrays are of different length. When 'nested_crossproduct',\nspecifies the Cartesian product of the inputs, producing a job for every\ncombination of the scattered inputs. The output must be nested arrays\nfor each level of scattering, in the order that the input arrays are listed\nin the scatter field. When 'flat_crossproduct', specifies the Cartesian\nproduct of the inputs, producing a job for every combination of the scattered\ninputs. The output arrays must be flattened to a single level, but otherwise\nlisted in the order that the input arrays are listed in the scatter field.\n", "enum": [ "dotproduct", "nested_crossproduct", "flat_crossproduct" ] } }, "required": [ "class", "inputs", "outputs" ] }, "CWLOutputList": { "type": "array", "title": "CWLOutputList", "description": "Package outputs defined as items.", "items": { "$ref": "#/components/schemas/CWLOutputItem" } }, "CWLOutputMap": { "type": "object", "title": "CWLOutputMap", "description": "Package outputs defined as mapping.", "additionalProperties": { "oneOf": [ { "$ref": "#/components/schemas/CWLType" }, { "$ref": "#/components/schemas/CWLOutputObject" }, { "$ref": "#/components/schemas/CWLOutputStdOut" }, { "$ref": "#/components/schemas/CWLOutputStdErr" }, { "$ref": "#/components/schemas/CWLImport" } ] } }, "CWLOutputItem": { "type": "object", "title": "CWLOutputItem", "description": "Output specification. Note that multiple formats are supported\nand not all specification variants or parameters are presented here. Please\nrefer to official CWL documentation for more details (https://www.commonwl.org).\n", "properties": { "type": { "oneOf": [ { "$ref": "#/components/schemas/CWLType" }, { "$ref": "#/components/schemas/CWLOutputStdOut" }, { "$ref": "#/components/schemas/CWLOutputStdErr" } ] }, "outputBinding": { "type": "object", "title": "OutputBinding", "description": "Defines how to retrieve the output result from the command.", "properties": { "glob": { "description": "Glob pattern to find the output on disk or mounted docker volume.", "oneOf": [ { "$ref": "#/components/schemas/CWLExpression" }, { "type": "array", "items": { "$ref": "#/components/schemas/CWLExpression" } } ] } } }, "id": { "description": "Identifier of the CWL output.", "$ref": "#/components/schemas/CWLAtomicBase/properties/id" } }, "required": [ "type", "id" ] }, "CWLWorkflowStepObject": { "allOf": [ { "$ref": "#/components/schemas/CWLWorkflowStepDefinition" }, { "$ref": "#/components/schemas/CWLWorkflowStepScatter" } ] }, "CWLInputStdInDefinition": { "description": "Indicates that the value passed to this CWL input will be redirected to the standard input stream of the command.\nCan be defined for only one input and must not be combined with 'stdin' at the root of the CWL document.\n", "type": "string", "enum": [ "stdin" ] }, "CWLInputStdInObjectType": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CWLInputStdInDefinition" } }, "required": [ "type" ] }, "CWLInputStdIn": { "oneOf": [ { "$ref": "#/components/schemas/CWLInputStdInDefinition" }, { "$ref": "#/components/schemas/CWLInputStdInObjectType" } ] }, "CWLArguments": { "type": "array", "title": "CWLArguments", "description": "Base arguments passed to the command.", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/InputBinding" } ] } }, "SoftwarePackage": { "type": "object", "properties": { "package": { "type": "string" }, "version": { "type": "array", "items": { "type": "string" } }, "specs": { "type": "array", "items": { "type": "string", "format": "url", "pattern": "^((?:http|ftp)s?:\\/\\/)?(?!.*\\/\\/.*$)(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?\\.)+(?:[A-Za-z]{2,6}\\.?|[A-Za-z0-9-]{2,}\\.?)|localhost|\\[[a-f0-9:]+\\]|\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3})(?::\\d+)?(?:\\/?|[/?]\\S+)$" } } }, "required": [ "package" ], "additionalProperties": false }, "SoftwarePackageSpecs": { "type": "array", "items": { "type": "string" } }, "CQL2": { "oneOf": [ { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "and", "or" ] }, "args": { "type": "array", "minItems": 2, "items": { "$ref": "#/components/schemas/CQL2" } } } }, { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "not" ] }, "args": { "type": "array", "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/CQL2" } } } }, { "oneOf": [ { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "=", "<>", "<", ">", "<=", ">=" ] }, "args": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/0" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/1" }, { "type": "boolean" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/4/oneOf/0" }, { "$ref": "#/components/schemas/CQL2/oneOf/6" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/6" } ] } } } }, { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "like" ] }, "args": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/0" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/6" }, { "$ref": "#/components/schemas/CQL2/oneOf/6" }, { "oneOf": [ { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "casei" ] }, "args": { "type": "array", "items": { "$ref": "#/components/schemas/CQL2/oneOf/2/oneOf/1/properties/args/items/oneOf/3" }, "minItems": 1, "maxItems": 1 } } }, { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "accenti" ] }, "args": { "type": "array", "items": { "$ref": "#/components/schemas/CQL2/oneOf/2/oneOf/1/properties/args/items/oneOf/3" }, "minItems": 1, "maxItems": 1 } } }, { "type": "string" } ] } ] } } } }, { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "between" ] }, "args": { "type": "array", "minItems": 3, "maxItems": 3, "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/1" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/6" }, { "$ref": "#/components/schemas/CQL2/oneOf/6" } ] } } } }, { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "in" ] }, "args": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/2/oneOf/0/properties/args/items" }, { "type": "array", "items": { "$ref": "#/components/schemas/CQL2/oneOf/2/oneOf/0/properties/args/items" } } ] } } } }, { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "isNull" ] }, "args": { "type": "array", "minItems": 1, "maxItems": 1, "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/0" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/1" }, { "$ref": "#/components/schemas/CQL2" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/3" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/4" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/6" } ] } } } } ] }, { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "s_contains", "s_crosses", "s_disjoint", "s_equals", "s_intersects", "s_overlaps", "s_touches", "s_within" ] }, "args": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/3" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/6" }, { "$ref": "#/components/schemas/CQL2/oneOf/6" } ] } } } }, { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "t_after", "t_before", "t_contains", "t_disjoint", "t_during", "t_equals", "t_finishedBy", "t_finishes", "t_intersects", "t_meets", "t_metBy", "t_overlappedBy", "t_overlaps", "t_startedBy", "t_starts" ] }, "args": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/4" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/6" }, { "$ref": "#/components/schemas/CQL2/oneOf/6" } ] } } } }, { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "a_containedBy", "a_contains", "a_equals", "a_overlaps" ] }, "args": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/5" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/6" }, { "$ref": "#/components/schemas/CQL2/oneOf/6" } ] } } } }, { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "not": { "enum": [ "and", "or", "not", "=", "<>", "<", ">", "<=", ">=", "like", "between", "in", "isNull", "casei", "accenti", "s_contains", "s_crosses", "s_disjoint", "s_equals", "s_intersects", "s_overlaps", "s_touches", "s_within", "t_after", "t_before", "t_contains", "t_disjoint", "t_during", "t_equals", "t_finishedBy", "t_finishes", "t_intersects", "t_meets", "t_metBy", "t_overlappedBy", "t_overlaps", "t_startedBy", "t_starts", "a_containedBy", "a_contains", "a_equals", "a_overlaps", "+", "-", "*", "/", "^", "%", "div" ] } }, "args": { "type": "array", "items": { "oneOf": [ { "oneOf": [ { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "casei" ] }, "args": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/0" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/6" }, { "$ref": "#/components/schemas/CQL2/oneOf/6" } ] }, "minItems": 1, "maxItems": 1 } } }, { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "accenti" ] }, "args": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/0" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/6" }, { "$ref": "#/components/schemas/CQL2/oneOf/6" } ] }, "minItems": 1, "maxItems": 1 } } }, { "type": "string" } ] }, { "oneOf": [ { "type": "object", "required": [ "op", "args" ], "properties": { "op": { "type": "string", "enum": [ "+", "-", "*", "/", "^", "%", "div" ] }, "args": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/1/oneOf/0" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/6" }, { "$ref": "#/components/schemas/CQL2/oneOf/6" }, { "type": "number" } ] } } } }, { "type": "number" } ] }, { "$ref": "#/components/schemas/CQL2" }, { "oneOf": [ { "oneOf": [ { "title": "GeoJSON Point", "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "type": "array", "minItems": 2, "items": { "type": "number" } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } }, { "title": "GeoJSON LineString", "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "LineString" ] }, "coordinates": { "type": "array", "minItems": 2, "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } }, { "title": "GeoJSON Polygon", "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "Polygon" ] }, "coordinates": { "type": "array", "items": { "type": "array", "minItems": 4, "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } }, { "title": "GeoJSON MultiPoint", "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "MultiPoint" ] }, "coordinates": { "type": "array", "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } }, { "title": "GeoJSON MultiLineString", "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "MultiLineString" ] }, "coordinates": { "type": "array", "items": { "type": "array", "minItems": 2, "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } }, { "title": "GeoJSON MultiPolygon", "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "MultiPolygon" ] }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "minItems": 4, "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } } } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } }, { "title": "GeoJSON GeometryCollection", "type": "object", "required": [ "type", "geometries" ], "properties": { "type": { "type": "string", "enum": [ "GeometryCollection" ] }, "geometries": { "type": "array", "minItems": 2, "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/3/oneOf/0/oneOf/0" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/3/oneOf/0/oneOf/1" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/3/oneOf/0/oneOf/2" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/3/oneOf/0/oneOf/3" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/3/oneOf/0/oneOf/4" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/3/oneOf/0/oneOf/5" } ] } } } } ] }, { "type": "object", "required": [ "bbox" ], "properties": { "bbox": { "type": "array", "oneOf": [ { "minItems": 4, "maxItems": 4 }, { "minItems": 6, "maxItems": 6 } ], "items": { "type": "number" } } } } ] }, { "oneOf": [ { "oneOf": [ { "type": "object", "required": [ "date" ], "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } }, { "type": "object", "required": [ "timestamp" ], "properties": { "timestamp": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?Z$" } } } ] }, { "type": "object", "required": [ "interval" ], "properties": { "interval": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/4/oneOf/0/oneOf/0/properties/date" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/4/oneOf/0/oneOf/1/properties/timestamp" } ] }, { "type": "string", "enum": [ ".." ] }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/6" }, { "$ref": "#/components/schemas/CQL2/oneOf/6" } ] } } } } ] }, { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/0" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/1" }, { "$ref": "#/components/schemas/CQL2" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/3" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/4" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/5" }, { "$ref": "#/components/schemas/CQL2/oneOf/6/properties/args/items/oneOf/6" } ] } }, { "type": "object", "required": [ "property" ], "properties": { "property": { "type": "string" } } } ] } } } }, { "type": "boolean" } ] }, "enumeration": { "type": "object", "required": [ "type", "enum" ], "properties": { "type": { "type": "string", "enum": [ "enum" ] }, "enum": { "type": "array", "items": { "type": "string" } } } }, "processes-list": { "type": "string", "enum": [ "RenderMap", "ElevationContours", "OSMERE" ] }, "processSummary": { "allOf": [ { "$ref": "#/components/schemas/descriptionType" }, { "type": "object", "required": [ "id", "version" ], "properties": { "id": { "type": "string" }, "version": { "type": "string" }, "jobControlOptions": { "type": "array", "items": { "$ref": "#/components/schemas/jobControlOptions" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/inlineOrRefValue/oneOf/2" } } } } ] }, "process": { "allOf": [ { "$ref": "#/components/schemas/processSummary" }, { "type": "object", "properties": { "inputs": { "additionalProperties": { "$ref": "#/components/schemas/inputDescription" } }, "outputs": { "additionalProperties": { "$ref": "#/components/schemas/outputDescription" } } } } ] }, "processList": { "type": "object", "required": [ "processes", "links" ], "properties": { "processes": { "type": "array", "items": { "$ref": "#/components/schemas/processSummary" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/inlineOrRefValue/oneOf/2" } } } }, "jobList": { "type": "object", "required": [ "jobs", "links" ], "properties": { "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/statusInfo" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/inlineOrRefValue/oneOf/2" } } } }, "bbox-processes": { "type": "object", "required": [ "bbox" ], "properties": { "bbox": { "type": "array", "oneOf": [ { "minItems": 4, "maxItems": 4 }, { "minItems": 6, "maxItems": 6 } ], "items": { "type": "number" } }, "crs": { "anyOf": [ { "type": "string", "format": "uri", "enum": [ "http://www.opengis.net/def/crs/OGC/1.3/CRS84", "http://www.opengis.net/def/crs/OGC/0/CRS84h" ], "default": "http://www.opengis.net/def/crs/OGC/1.3/CRS84" }, { "type": "string", "format": "uri", "default": "http://www.opengis.net/def/crs/OGC/1.3/CRS84" } ] } } }, "descriptionType": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "keywords": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "array", "items": { "$ref": "#/components/schemas/metadata" } } } }, "binaryValue": { "type": "string" }, "execute-workflow": { "allOf": [ { "type": "object", "properties": { "process": { "type": "string", "format": "uri-reference", "description": "The URI to the description of the process that should be executed.\nFor the top-level process, when the execution request is POSTed to `{root}/processes/{processId}/execution`, this should be an absolute URI,\nand the server should ignore this `process` key since the URI of the request already identifies the process to execute, and a client\nis not required to resolve and replace the URI if passing a nested process block as part of a larger workflow executing a nested process.\nIf a relative URI reference is used, the Base URI is defined as the URI of the description\n(`{root}/processes/{processId}`) of the receiving process, with this receiving process object understood as the\nEncapsulating Entity as per [RFC 3986 Section 5.1.2](https://datatracker.ietf.org/doc/html/rfc3986#section-5.1.2).\nIn the case of a nested process on the same OGC API root as the receiving process, using a simple process ID as the relative URI reference\nwould resolve to a process available at `{root}/processes/{processID}`, where `{root}` represents the landing page of the receiving process.\nFor example, if a top-level process at https://example.com/processes/buffer receives a nested processs `{ \"process\": \"clip\" }`,\nthat clip process is resolved as https://example.com/processes/clip." }, "inputs": { "additionalProperties": { "$ref": "#/components/schemas/values-workflows" } }, "outputs": { "additionalProperties": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/format" }, "$output": { "type": "string" } } } }, "subscriber": { "$ref": "#/components/schemas/subscriber" } } }, { "$ref": "#/components/schemas/fieldsModifiers" }, { "example": { "inputs": { "data": [ { "collection": "https://example.com/collections/sentinel2-l2a", "aliases": { "evi": "2.5 * (B08 / 10000 - B04 / 10000) / (1 + B08 / 10000 + 6 * B04 / 10000 + -7.5 * B02 / 10000)" }, "properties": [ "evi" ] } ] } } } ] }, "inputParameterized": { "allOf": [ { "type": "object", "required": [ "$input" ], "properties": { "$input": { "type": "string" } } }, { "$ref": "#/components/schemas/fieldsModifiers" } ] }, "format": { "type": "object", "properties": { "mediaType": { "type": "string" }, "encoding": { "type": "string" }, "schema": { "oneOf": [ { "type": "string", "format": "url" }, { "type": "object" } ] } } }, "schemaAndOccurrences": { "type": "object", "required": [ "schema" ], "properties": { "schema": { "$ref": "#/components/schemas/schema" }, "minOccurs": { "type": "integer", "default": 1 }, "maxOccurs": { "oneOf": [ { "type": "integer", "default": 1 }, { "type": "string", "enum": [ "unbounded" ] } ] } } }, "inputDescription": { "allOf": [ { "$ref": "#/components/schemas/descriptionType" }, { "$ref": "#/components/schemas/dataClasses" }, { "$ref": "#/components/schemas/dataAccessAPIs" }, { "type": "object", "properties": { "executionUnitRequirements": { "type": "object", "properties": { "remote-access": { "type": "boolean" }, "staging": { "type": "string", "enum": [ "local-file", "remote-access" ] } } } } }, { "$ref": "#/components/schemas/schemaAndOccurrences" }, { "type": "object", "properties": { "valuePassing": { "type": "array", "items": { "type": "string", "enum": [ "byValue", "byReference" ] }, "default": [ "byValue", "byReference" ] } } } ] }, "value": { "anyOf": [ { "$ref": "#/components/schemas/valueNoObject" }, { "type": "object" } ] }, "collectionValue": { "allOf": [ { "$ref": "#/components/schemas/format" }, { "type": "object", "required": [ "collection" ], "properties": { "collection": { "description": "The URI of the OGC API collection that should be accessed to provide\ninput values from the corresponding process input. The server\noffering this collection is referred to as the \"value source server\".", "anyOf": [ { "type": "string", "description": "Collection identifier for a collection available at `{root}/collections/{collectionID}`, where `{root}` represents the landing page\nof the process using the collection as an input (for the top-level process, that is the landing page of the process execution endpoint\nto which the execution request is posted), or the landing page of the document being retrieved in the case of an output.\nIf the `collection` string includes a `/`, it must be interpreted as a URI reference rather than as a collection ID." }, { "type": "string", "description": "The URI of an OGC API collection.\nIf a relative URI reference is used, the Base URI is defined as such:\n- For a Collection value received as input to a process, the Base URI is defined as the URI of the description\n (`{root}/processes/{processId}`) of that process, with the receiving process object understood as the Encapsulating Entity as per\n [RFC 3986 Section 5.1.2](https://datatracker.ietf.org/doc/html/rfc3986#section-5.1.2).\n- For a Collection Output value, the Base URI is defined from the Retrieval URI as as per\n [RFC 3986 Section 5.1.3](https://datatracker.ietf.org/doc/html/rfc3986#section-5.1.3),\n for example, `/jobs/{jobId}/results`, `/jobs/{jobId}/results/{outputID}` or `/jobs/{jobId}/results/{outputID}/{N}` depending on the\n resource being retrieved.\nIf a collection string does not contain any `/`, it must not be interpreted as a URI reference, and must instead be resolved as a\ncollection identifier. For example, `countries` would resolve to `{root}/collections/countries` rather than `{root}/processes/countries`.", "format": "uri-reference" } ] }, "bbox": { "description": "Only resources that have a geometry that intersects the bounding box\nare selected. The bounding box is provided as four or six numbers,\ndepending on whether the coordinate reference system includes a\nvertical axis (height or depth):\n\n* Lower left corner, coordinate axis 1\n* Lower left corner, coordinate axis 2\n* Minimum value, coordinate axis 3 (optional)\n* Upper right corner, coordinate axis 1\n* Upper right corner, coordinate axis 2\n* Maximum value, coordinate axis 3 (optional)\n\nIf the value consists of four numbers, the coordinate reference\nsystem is WGS84 longitude/latitude\n (http://www.opengis.net/def/crs/OGC/1.3/CRS84)\nunless a different coordinate reference system is specified in the\nparameter `bboxCrs`.\n\nIf the value consists of six numbers, the coordinate reference system\nis WGS84 (http://www.opengis.net/def/crs/OGC/0/CRS84h) longitude/\nlatitude/ ellipsoidal height unless a different coordinate reference\nsystem is specified in the parameter `bboxCrs`.\n\nFor WGS84 longitude/latitude the values are in most cases the sequence\nof minimum longitude, minimum latitude, maximum longitude and maximum\nlatitude. However, in cases where the box spans the antimeridian the\nfirst value (west-most box edge) is larger than the third value\n(east-most box edge).\n\nIf the vertical axis is included, the third and the sixth number are\nthe bottom and the top of the 3-dimensional bounding box.\n\nIf a resource has multiple spatial geometry properties, it is the\ndecision of the server whether only a single spatial geometry property\nis used to determine the extent or all relevant geometries.", "type": "array", "oneOf": [ { "minItems": 4, "maxItems": 4 }, { "minItems": 6, "maxItems": 6 } ], "items": { "type": "number" } }, "bboxCrs": { "description": "Asserts the CRS used for the coordinate values of the `bbox`\nparameter. The default is WGS 84 or WGS84h depending on whether\nellipsoidal height is included or not:\n * WGS 84 longitude/latitude [4 numbers]\n (http://www.opengis.net/def/crs/OGC/1.3/CRS84)\n * WGS 84h longitude/latitude/ellipsoidal height [6 numbers]\n (http://www.opengis.net/def/crs/OGC/0/CRS84h_", "type": "string", "format": "uri" }, "geometry": { "description": "Only resources that have a geometry that intersects the geometry\nspecified using the `geometry` parameter are selected. The value of\nthe `geometry` parameter can be specified using WKT or GeoJSON.\nIf a resource has multiple spatial geometry properties, it is the\ndecision of the server whether only a single spatial geometry property\nis used to determine the extent or all relevant geometries.", "oneOf": [ { "type": "string" }, { "oneOf": [ { "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "type": "array", "minItems": 2, "items": { "type": "number" } } } }, { "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "MultiPoint" ] }, "coordinates": { "type": "array", "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } } } }, { "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "LineString" ] }, "coordinates": { "type": "array", "minItems": 2, "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } } } }, { "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "MultiLineString" ] }, "coordinates": { "type": "array", "items": { "type": "array", "minItems": 2, "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } } } } }, { "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "Polygon" ] }, "coordinates": { "type": "array", "items": { "type": "array", "minItems": 4, "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } } } } }, { "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "MultiPolygon" ] }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "minItems": 4, "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } } } } } }, { "type": "object", "required": [ "type", "geometries" ], "properties": { "type": { "type": "string", "enum": [ "GeometryCollection" ] }, "geometries": { "type": "array", "items": { "$ref": "#/components/schemas/collectionValue/allOf/1/properties/geometry/oneOf/1" } } } } ] } ] }, "geometryCrs": { "description": "Asserts the CRS used for the coordinate values of the `geometry`\nparameter. The default is WGS 84 or WGS84h depending on whether\nellipsoidal height is included or not:\n * WGS 84 longitude/latitude [4 numbers]\n (http://www.opengis.net/def/crs/OGC/1.3/CRS84)\n * WGS 84h longitude/latitude/ellipsoidal height [6 numbers]\n (http://www.opengis.net/def/crs/OGC/0/CRS84h_", "type": "string" }, "datetime": { "description": "Either a date-time or an interval, half-bounded or bounded. Date and\ntime expressions adhere to RFC 3339. Half-bounded intervals are\nexpressed using double-dots.\n\nExamples:\n * A date-time:\n \"2018-02-12T23:20:50Z\"\n * A bounded interval:\n \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n * Half-bounded intervals:\n \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n\nOnly resources that have a temporal property that intersects the\nvalue of `datetime` are selected.\n\nIf a resource has multiple temporal properties, it is the decision of\nthe server whether only a single temporal property is used to\ndetermine the extent or all relevant temporal properties.", "type": "string" }, "limit": { "description": "The optional limit parameter limits the number of items that are\npresented in the response document.\nOnly items are counted that are on the first level of the collection\nin the response document. Nested objects contained within the\nexplicitly requested items shall not be counted.", "type": "integer", "minimum": 1, "maximum": 10000, "default": 10 }, "crs": { "description": "If the parameter is specified, then the coordinates of all\ngeometry-valued properties in the response document are in\nthe requested CRS. Otherwise the coordinates are in the default CRS,\nthat is http://www.opengis.net/def/crs/OGC/1.3/CRS84 for coordinates\nwithout height and http://www.opengis.net/def/crs/OGC/0/CRS84h for\ncoordinates with ellipsoidal height.", "type": "string", "format": "uri" }, "filter": { "description": "A search or filter condition. This condition determines which\nresources from the OGC API collection are included in the result\nset and are thus passed as values to the corresponding process input.\nThe `filter` parameter can be a string where the search condition is\nencoded in some text-based query langauge (e.g. cql2-text) or a\nCQL2 JSON object that encodes the search condition using JSON.", "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/CQL2" } ] }, "filterCrs": { "description": "Asserts the CRS used for the coordinate values of the `filter`\nparameter. The default is WGS 84 or WGS 84h depending on whether\nellispoidal jeight is included with the coordinates or not:\n * WGS 84 longitude/latitude\n (http://www.opengis.net/def/crs/OGC/1.3/CRS84)\n * WGS 84h longitude/latitude/ellipsoidal height\n (http://www.opengis.net/def/crs/OGC/0/CRS84h_", "type": "string", "format": "uri-reference" }, "filterLang": { "description": "Indicates the language used to encode a filter expression specified\nusing the `filter` parameter. Query languages can include CQL2 text,\nCQL 2 JSON or OGC Filter Encoding (XML).", "type": "string", "enum": [ "cql2-text", "cql2-json", "fes-xml" ] }, "subset": { "description": "Retrieve only part of the data by slicing or trimming along one or\nmore axis. For trimming: {axisAbbrev}({low}:{high}) (preserves\ndimensionality). An asterisk (`*`) can be used instead of {low} or\n{high} to indicate the minimum/maximum value. For slicing:\n{axisAbbrev}({value}) (reduces dimensionality).", "type": "array", "items": { "type": "string" } }, "subsetCrs": { "description": "Asserts the CRS used for the coordinate values of the `subset`\nparameter. The default is WGS 84 or WGS 84h depending on whether\nellispoidal height in included with the coordinates or not:\n * WGS 84 longitude/latitude\n (http://www.opengis.net/def/crs/OGC/1.3/CRS84)\n * WGS 84h longitude/latitude/ellipsoidal height\n (http://www.opengis.net/def/crs/OGC/0/CRS84h_", "type": "string" }, "ids": { "description": "The optional ids parameter allows a specific list of resources,\nindicated by their identifiers, to be fetched from the OGC API\ncollection. Only resources whose identifier matches one of the\nvalues listed for this parameter shall appear in the result set.", "type": "array", "items": { "type": "string" } }, "q": { "description": "The optional q parameter supports keyword searching. Only resources\nwhose text fields contain one or more of the specified search terms\nare selected. The specific set of text keys/fields/properties of a\nresource to which the q operator is applied is up to the discretion\nof the server. Implementations should, however, apply the q\noperator to the title, description and keywords keys/fields/properties\nif they exist in the resource.", "type": "array", "items": { "type": "string" } }, "assets": { "description": "A list of STAC asset tags.", "type": "array", "items": { "type": "string" } }, "properties": { "description": "A filter that selects resource properties to be included in a\nresponse document. The elements in the `properties` parameter can\nbe the names of resource properties, aliases for resources properties\nor synthetic properties. Synthetic properties are properties that\nare computed on the fly and can reference resource property names\nor aliases for resource properties.", "type": "array", "items": { "type": "string" } }, "aliases": { "description": "A dictionary of aliases that can be used as values for the\n`properties` parameter. Aliases can be alternative names for\nresource properties or synthetic properties. Synthetic properties\nare named expressions that are computed at run-time. Expressions\nfor synthetic properties are encoded using some expression language\nand can include references to resource property names or aliases\nfor resource properties..", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "expressionLang": { "type": "string", "enum": [ "cql2-text", "cql2-json" ] }, "expression": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/CQL2" } ] } } } ] } }, "passThroughParameters": { "description": "Parameters specified in this object are passed through to the value\nsource server for processing on that server. The keys used in this\nobject should be identical to query parameters that the value source\nserver would recognize. In the case where the OAProc server supports\nlocal filtering, the `passThroughParameters` property provides a\nmechanism to force filtering to happen on the value source server.", "type": "object" } } } ] }, "valueNoObject": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "boolean" }, { "type": "array", "items": {} }, { "$ref": "#/components/schemas/binaryValue" }, { "$ref": "#/components/schemas/bbox-processes" }, { "$ref": "#/components/schemas/collectionValue" } ] }, "valueNoObject-workflows": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "boolean" }, { "type": "array", "items": {} }, { "$ref": "#/components/schemas/binaryValue" }, { "$ref": "#/components/schemas/bbox-processes" }, { "$ref": "#/components/schemas/collectionValue" }, { "allOf": [ { "type": "object", "required": [ "process" ] }, { "$ref": "#/components/schemas/execute-workflow" } ] }, { "$ref": "#/components/schemas/inputParameterized" } ] }, "jobControlOptions": { "type": "string", "enum": [ "sync-execute", "async-execute", "dismiss" ] }, "metadata": { "oneOf": [ { "allOf": [ { "$ref": "#/components/schemas/inlineOrRefValue/oneOf/2" }, { "type": "object", "properties": { "role": { "type": "string" } } } ] }, { "type": "object", "properties": { "role": { "type": "string" }, "title": { "type": "string" }, "lang": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "object" } ] } } } ] }, "values": { "anyOf": [ { "$ref": "#/components/schemas/inlineOrRefValue" }, { "type": "array", "items": { "$ref": "#/components/schemas/inlineOrRefValue" } } ] }, "values-workflows": { "oneOf": [ { "$ref": "#/components/schemas/inlineOrRefValue-workflows" }, { "type": "array", "items": { "$ref": "#/components/schemas/inlineOrRefValue-workflows" } } ] }, "outputSelection": { "type": "object", "properties": { "format": { "$ref": "#/components/schemas/format" } } }, "outputDescription": { "allOf": [ { "$ref": "#/components/schemas/descriptionType" }, { "$ref": "#/components/schemas/dataClasses" }, { "$ref": "#/components/schemas/dataAccessAPIs" }, { "$ref": "#/components/schemas/schemaAndOccurrences" } ] }, "qualifiedValue": { "allOf": [ { "$ref": "#/components/schemas/format" }, { "type": "object", "required": [ "value" ], "properties": { "value": { "$ref": "#/components/schemas/value" } } } ] }, "reference": { "type": "object", "required": [ "$ref" ], "properties": { "$ref": { "type": "string", "format": "uri-reference" } }, "additionalProperties": false }, "results": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/values" } }, "schema": { "description": "Attributes of the features or fields of a coverage range. Defined by a subset of the JSON Schema for the properties of a feature", "type": "object", "required": [ "type", "properties" ], "properties": { "type": { "type": "string", "enum": [ "object" ] }, "required": { "type": "array", "minItems": 1, "items": { "type": "string" } }, "properties": { "type": "object", "default": {}, "additionalProperties": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "enum": { "type": "array", "minItems": 1, "items": {}, "uniqueItems": true }, "format": { "type": "string" }, "contentMediaType": { "type": "string" }, "maximum": { "type": "number" }, "exclusiveMaximum": { "type": "number" }, "minimum": { "type": "number" }, "exclusiveMinimum": { "type": "number" }, "pattern": { "type": "string", "format": "regex" }, "maxItems": { "type": "integer", "minimum": 0 }, "minItems": { "type": "integer", "default": 0, "minimum": 0 }, "x-ogc-definition": { "type": "string", "format": "uri" }, "x-ogc-unit": { "type": "string" }, "x-ogc-unitLang": { "type": "string" } } } } } }, "statusCode": { "type": "string", "nullable": false, "enum": [ "accepted", "running", "successful", "failed", "dismissed" ] }, "subscriber": { "description": "Optional URIs for callbacks for this job.\n\nSupport for this parameter is not required and the parameter may be\nremoved from the API definition, if conformance class **'callback'**\nis not listed in the conformance declaration under `/conformance`.", "type": "object", "properties": { "successUri": { "type": "string", "format": "uri" }, "inProgressUri": { "type": "string", "format": "uri" }, "failedUri": { "type": "string", "format": "uri" } } }, "inlineOrRefValue": { "oneOf": [ { "$ref": "#/components/schemas/valueNoObject" }, { "$ref": "#/components/schemas/qualifiedValue" }, { "allOf": [ { "type": "object", "required": [ "rel" ], "properties": { "rel": { "type": "string" }, "type": { "type": "string" }, "hreflang": { "type": "string" }, "title": { "type": "string" }, "length": { "type": "integer" } } }, { "type": "object", "properties": { "method": { "type": "string", "enum": [ "POST", "GET", "DELETE", "PATCH" ] }, "body": {}, "headers": { "type": "object", "additionalProperties": { "type": "string" } } } }, { "type": "object", "required": [ "href" ], "properties": { "href": { "type": "string" } } } ] } ] }, "inlineOrRefValue-workflows": { "oneOf": [ { "$ref": "#/components/schemas/valueNoObject-workflows" }, { "allOf": [ { "$ref": "#/components/schemas/format" }, { "$ref": "#/components/schemas/fieldsModifiers" }, { "type": "object", "required": [ "value" ], "properties": { "value": { "oneOf": [ { "$ref": "#/components/schemas/valueNoObject-workflows" }, { "type": "object" } ] } } } ] }, { "$ref": "#/components/schemas/link" } ] }, "fieldsModifiers": { "type": "object", "properties": { "filter": { "oneOf": [ { "type": "string" }, { "description": "Basic CQL2-JSON definition", "type": "array", "items": { "type": "object" } } ] }, "filter-lang": { "type": "string", "example": "cql2-text" }, "filter-crs": { "type": "string", "format": "uri-reference" }, "aliases": { "type": "object", "additionalProperties": { "type": "string" } }, "properties": { "type": "array", "items": { "type": "string" } }, "sortBy": { "type": "array", "items": { "type": "string" } } } }, "statusInfo": { "allOf": [ { "$ref": "#/components/schemas/descriptionType" }, { "type": "object", "required": [ "id", "status", "processingEntityType" ], "properties": { "id": { "type": "string" }, "processID": { "type": "string", "format": "uri" }, "processingEntityType": { "description": "The type of entity that created the job and is doing the processing.\nThis includes all the data access apis listed in \"apis.yaml\" plus\nthe processing APIs of OGC API Processes and OpenEO.", "anyOf": [ { "$ref": "#/components/schemas/apis" }, { "type": "string", "enum": [ "ogc-api-processes", "openeo" ] } ] }, "profileEntityType": { "description": "The type of entity requesting this status information. This may\nbe differernt than the processing entity. For example, the\nprocessing entity may be OGC API Processes but the status\ninformation is requested via the OpenEO API.", "anyOf": [ { "$ref": "#/components/schemas/apis" }, { "type": "string", "enum": [ "ogc-api-processes", "openeo" ] } ] }, "request": { "oneOf": [ { "type": "string" }, { "type": "object" }, { "$ref": "#/components/schemas/inlineOrRefValue/oneOf/2" } ] }, "status": { "$ref": "#/components/schemas/statusCode" }, "message": { "type": "string" }, "exception": { "$ref": "#/components/schemas/exception" }, "created": { "type": "string", "format": "date-time" }, "started": { "type": "string", "format": "date-time" }, "finished": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/inlineOrRefValue/oneOf/2" } } } } ] }, "dataAccessAPIs": { "type": "object", "properties": { "dataAccessAPIs": { "type": "array", "items": { "$ref": "#/components/schemas/apis" } } } }, "apis": { "description": "A non-exhaustive list of OGC and other data access APIs. This list can\nbe extended as required.", "type": "string", "enum": [ "ogc-api-features", "ogc-api-coverages", "ogc-api-edr", "ogc-api-tiles", "ogc-api-moving-features", "ogc-api-sensor-things", "ogc-api-records", "ogc-api-dggs", "stac-api" ] }, "dataClasses": { "type": "object", "properties": { "dataClasses": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "ogcapppkg": { "type": "object", "required": [ "executionUnit" ], "properties": { "processDescription": { "type": "object", "required": [ "process" ], "properties": { "process": { "$ref": "#/components/schemas/process" } } }, "executionUnit": { "oneOf": [ { "type": "object", "description": "Resource containing executable or runtime information for executing the\nprocess.", "required": [ "type" ], "properties": { "type": { "description": "Type of execution unit.", "type": "string", "anyOf": [ { "enum": [ "docker", "oci" ] }, { "type": "string" } ] }, "image": { "description": "Container image reference for the execution unit.", "type": "string" }, "deployment": { "description": "Deployment information for the execution unit.", "type": "string", "anyOf": [ { "enum": [ "local", "remote", "hpc", "cloud" ] }, { "type": "string" } ] }, "config": { "type": "object", "description": "Hardware requirements and configuration properties for executing the\nprocess.", "properties": { "cpuMin": { "description": "Minimum number of CPUs required to run the process (unit is CPU core).", "type": "number", "minimum": 1 }, "cpuMax": { "description": "Maximum number of CPU dedicated to the process (unit is CPU core)", "type": "number" }, "memoryMin": { "description": "Minimum RAM memory required to run the application (unit is GB)", "type": "number" }, "memoryMax": { "description": "Maximum RAM memory dedicated to the application (unit is GB)", "type": "number" }, "storageTempMin": { "description": "Minimum required temporary storage size (unit is GB)", "type": "number" }, "storageOutputsMin": { "description": "Minimum required output storage size (unit is GB)", "type": "number" }, "jobTimeout": { "description": "Timeout delay for a job execution (in seconds)", "type": "number" } }, "additionalProperties": true }, "bindings": { "type": "object", "properties": { "inputBindings": { "additionalProperties": { "type": "object", "description": ". Defines how to specify the input for the execution unit.\n. The value of various properties defined below can be expressions.\n . The expression language SHALL be JavaScript(???).\n. The \"$(...)\" syntax can be used to reference the current input or other\n process inputs in an expression.\n . The value \"self\" refers to the value of the current input.\n . The value \"inputs.\" refers to the value of another\n process input.\n . If the input is defined as a string of format \"file\" or \"directory\"\n then the meta-values \".path\", \".basename\", \".nameroot\" and \".nameext\"\n can be used to manipulate file or directory name without having to\n resort to complex regular expressions.\n . \".path\" returns the path of a file name without the file name\n . \".basename\" returns the name of the file without the path\n . \".nameroot\" returns the basename without any extension\n . \".nameext\" returns the extension of the basename", "properties": { "prefix": { "description": "Command line prefix to add before the value.", "type": "string" }, "position": { "description": ". The zero-based sorting key.\n. The value can be an integer or a string.\n. If the value is a string then it should be an expression that evaluates\n to a single integer value or null.", "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "valueFrom": { "description": ". If valueFrom is a constant string value, use this as the value.\n. If valueFrom is an expression, evaluate the expression to yield the\n actual value to use to build the command line.\n. If the value of the associated input parameter is null, valueFrom is\n not evaluated and nothing is added to the command line.", "type": "string" }, "itemSeparator": { "description": "Join the array elements into a single string with the elements separated\nby itemSeparator.", "type": "string" }, "shellQuote": { "description": ". A Boolean that controls whether the value is quoted on the command.\n. A value of true (or if shecllQuote is not provided) means that the\n implementation SHALL not permit the interpretation of any shell\n metacharacters or directives.\n. A value of false should be used to inject metacharacters for operations\n such as pipes.", "type": "boolean" } }, "additionalProperties": true } }, "outputBindings": { "additionalProperties": { "type": "object", "description": "Defines how to retrieve the output result from the command.", "properties": { "glob": { "description": ". Wildcard pattern to find the output on disk or mounted volume.\n. Uses UNIX \"glob\" wildcard patterns (see: \"man 7 glob\").\n. See inputBinding.yaml for referencing input values in an output\n binding \"glob\" expression.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "additionalProperties": true } } } } }, "additionalProperties": true, "example": { "type": "docker", "image": "mydocker/ndvi:latest", "bindings": { "inputBindings": { "inputImage": { "prefix": "inputsImages=", "inputSeparator": "," } }, "outputBindings": { "outputImage": { "glob": "$(\"/outputs/ndvi_\" + inputs.inputImage.basename)" } } }, "deployment": "local", "config": { "cpuMin": 2, "cpuMax": 5, "memoryMin": 1, "memoryMax": 3 } } }, { "$ref": "#/components/schemas/link" }, { "$ref": "#/components/schemas/qualifiedValue" }, { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ogcapppkg/properties/executionUnit/oneOf/0" }, { "$ref": "#/components/schemas/link" }, { "$ref": "#/components/schemas/qualifiedValue" } ] } } ] } } }, "staticIndicator": { "allOf": [ { "$ref": "#/components/schemas/processSummary" }, { "type": "object", "properties": { "mutable": { "type": "boolean", "default": true } } } ] } }, "parameters": { "f-metadata": { "name": "f", "in": "query", "description": "The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are 'json' or 'html'.", "required": false, "schema": { "type": "string", "enum": [ "json", "html" ] }, "style": "form", "explode": false }, "datetime": { "name": "datetime", "in": "query", "description": "Either a date-time or an interval, half-bounded or bounded. Date and time expressions\nadhere to RFC 3339. Half-bounded intervals are expressed using double-dots.\n\nExamples:\n\n* A date-time: \"2018-02-12T23:20:50Z\"\n* A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n* Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n\nOnly features that have a temporal property that intersects the value of\n`datetime` are selected.\n\nIf a feature has multiple temporal properties, it is the decision of the\nserver whether only a single temporal property is used to determine\nthe extent or all relevant temporal properties.", "required": false, "schema": { "type": "string" }, "style": "form", "explode": false }, "crs": { "name": "crs", "in": "query", "description": "reproject the output to the given crs", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "subset-crs": { "name": "subset-crs", "in": "query", "description": "crs for the specified subset", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "processID-path": { "name": "processID", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/processes-list" } }, "outputID": { "name": "outputID", "in": "path", "description": "identifier of an output", "required": true, "schema": { "type": "string" } }, "N": { "name": "N", "in": "path", "description": "0-based index identifying a specific value of a multi-values output resulting from a job", "required": true, "schema": { "type": "string" } }, "prefer-header-return": { "in": "header", "description": "Indicates client preferences, such as whether the client wishes a self-contained or minimal response.\nA `return=minimal` preference indicates that the client would prefer that links be returned to larger object to minimize the response payload.\nA `return=representation` indicates that the client would prefer if the server can return a self-contained response.", "name": "Prefer", "schema": { "type": "string" } }, "jobID": { "name": "jobID", "in": "path", "description": "local identifier of a job", "required": true, "schema": { "type": "string" } }, "processID-query": { "name": "processID", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, "output": { "name": "output", "in": "query", "required": false, "schema": { "type": "object", "required": [ "output" ], "properties": { "output": { "type": "string" }, "mediaType": { "type": "string" }, "encoding": { "type": "string" }, "schema": { "oneOf": [ { "type": "string", "format": "url" }, { "type": "object" } ] } } }, "explode": false }, "limit": { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 10 } }, "type": { "name": "type", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "process" ] } } }, "status": { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/statusCode" } } }, "minDuration": { "name": "minDuration", "in": "query", "required": false, "schema": { "type": "integer" } }, "maxDuration": { "name": "maxDuration", "in": "query", "required": false, "schema": { "type": "integer" } }, "w": { "name": "w", "description": "Point to the workflow identifier for deploying a CWL containing multiple workflow definitions", "in": "query", "required": false, "schema": { "type": "string" } } }, "responses": { "NotFound": { "description": "The requested resource does not exist on the server. For example, a path parameter had an incorrect value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exception" } }, "text/html": { "schema": { "type": "string" } } } }, "NotAcceptable": { "description": "Content negotiation failed. For example, the `Accept` header submitted in the request did not support any of the media types supported by the server for the requested resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exception" } }, "text/html": { "schema": { "type": "string" } } } }, "ServerError": { "description": "A server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exception" } }, "text/html": { "schema": { "type": "string" } } } }, "InvalidParameter": { "description": "A query parameter has an invalid value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exception" } }, "text/html": { "schema": { "type": "string" } } } }, "NotAllowed": { "description": "The method is not allowed at the path.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exception" } }, "text/html": { "schema": { "type": "string" } } } }, "Exception": { "description": "An error occured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exception" } }, "text/html": { "schema": { "type": "string" } } } }, "LandingPage": { "description": "The landing page provides links to the API definition (link relation `service-desc`, in this case path `/api`),\nto the Conformance declaration (path `/conformance`, link relation `http://www.opengis.net/def/rel/ogc/1.0/conformance`), and to other resources.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/landingPage" } }, "text/html": { "schema": { "type": "string" } } } }, "Conformance": { "description": "The URIs of all conformance classes supported by the server\n\nTo support \"generic\" clients that want to access multiple\nOGC API - Processes implementations - and not \"just\" a specific\nAPI / server, the server declares the conformance\nclasses it implements and conforms to.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/confClasses" } ], "example": { "conformsTo": [ "http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/core", "http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/json", "http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/html", "http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/oas30", "http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/collections", "http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core", "http://www.opengis.net/spec/ogcapi-processes-3/0.0/conf/nested-processes", "http://www.opengis.net/spec/ogcapi-processes-3/0.0/conf/remote-core-processes", "http://www.opengis.net/spec/ogcapi-processes-3/0.0/conf/collection-input", "http://www.opengis.net/spec/ogcapi-processes-3/0.0/conf/remote-collections", "http://www.opengis.net/spec/ogcapi-processes-3/0.0/conf/input-fields-modifiers", "http://www.opengis.net/spec/ogcapi-processes-3/0.0/conf/output-fields-modifiers", "http://www.opengis.net/spec/ogcapi-processes-3/0.0/conf/deployable-workflows", "http://www.opengis.net/spec/ogcapi-processes-3/0.0/conf/collection-output", "http://www.opengis.net/spec/ogcapi-processes-3/0.0/conf/cwl-workflows", "http://www.opengis.net/spec/ogcapi-processes-3/0.0/conf/openeo-workflows", "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/core", "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/tileset", "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/tilesets-list", "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/geodata-tilesets", "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/dataset-tilesets", "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/geodata-selection", "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/jpeg", "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/png", "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/mvt", "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/geojson", "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/tiff", "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/netcdf" ] } } } } }, "API": { "description": "The OpenAPI definition of the API.", "content": { "application/vnd.oai.openapi+json;version=3.0": { "schema": { "type": "object" } }, "text/html": { "schema": { "type": "string" } } } }, "Enumeration": { "description": "An enumerated list of valid string values for API parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enumeration" } }, "text/html": { "schema": { "type": "string" } } } }, "ProcessList": { "description": "Information about the available processes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/processList" } } } }, "ProcessDescription": { "description": "A process description.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/process" } } } }, "Results": { "description": "The processing results of a job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/results" } } } }, "Output": { "description": "An output resulting from a job", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/values" } } } }, "OutputValue": { "description": "An individual value of an output allowing multiple values resulting from a job", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inlineOrRefValue" } } } }, "Status": { "description": "The status of a job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/statusInfo" } } } }, "JobList": { "description": "A list of jobs for this process.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/jobList" } } } }, "ExecuteAsync": { "description": "Started asynchronous execution. Created job.", "headers": { "Location": { "schema": { "type": "string" }, "description": "URL to check the status of the execution/job." }, "Preference-Applied": { "schema": { "type": "string" }, "description": "The preference applied to execute the process asynchronously (see. RFC 2740)." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/statusInfo" } } } }, "ExecuteSync": { "description": "Result of synchronous execution", "content": { "application/json": { "schema": { "anyOf": [ { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "object", "nullable": true }, { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "string", "format": "binary" } ] }, { "$ref": "#/components/schemas/results" } ] } }, "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/tiff; application=geotiff": { "schema": { "type": "string", "format": "binary" } }, "application/geo+json": { "schema": { "allOf": [ { "format": "geojson-feature-collection" }, { "title": "GeoJSON FeatureCollection", "type": "object", "required": [ "type", "features" ], "properties": { "type": { "type": "string", "enum": [ "FeatureCollection" ] }, "features": { "type": "array", "items": { "title": "GeoJSON Feature", "type": "object", "required": [ "type", "properties", "geometry" ], "properties": { "type": { "type": "string", "enum": [ "Feature" ] }, "id": { "oneOf": [ { "type": "number" }, { "type": "string" } ] }, "properties": { "type": "object", "nullable": true }, "geometry": { "oneOf": [ { "title": "GeoJSON Point", "type": "object", "nullable": true, "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "type": "array", "minItems": 2, "items": { "type": "number" } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } }, { "title": "GeoJSON LineString", "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "LineString" ] }, "coordinates": { "type": "array", "minItems": 2, "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } }, { "title": "GeoJSON Polygon", "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "Polygon" ] }, "coordinates": { "type": "array", "items": { "type": "array", "minItems": 4, "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } }, { "title": "GeoJSON MultiPoint", "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "MultiPoint" ] }, "coordinates": { "type": "array", "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } }, { "title": "GeoJSON MultiLineString", "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "MultiLineString" ] }, "coordinates": { "type": "array", "items": { "type": "array", "minItems": 2, "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } }, { "title": "GeoJSON MultiPolygon", "type": "object", "required": [ "type", "coordinates" ], "properties": { "type": { "type": "string", "enum": [ "MultiPolygon" ] }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "minItems": 4, "items": { "type": "array", "minItems": 2, "items": { "type": "number" } } } } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } } ] }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } } }, "bbox": { "type": "array", "minItems": 4, "items": { "type": "number" } } } } ] } } } }, "ExecuteSyncRawRef": { "description": "Synchronous execution response.", "headers": { "Link": { "schema": { "type": "string" }, "description": "One or more Link headers pointing to each raw output." } } }, "EmptyResponse": { "description": "successful operation (no response body)" }, "DeployProcess": { "description": "the process is deployed", "headers": { "Location": { "schema": { "type": "string" }, "description": "URL to fetch the processDescription of the deployed process" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/staticIndicator" } } } }, "ProcessSummary": { "description": "A process summary.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/processSummary" } } } }, "DuplicateProcess": { "description": "the processes being added is already deployed (i.e. duplicate)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exception" } }, "text/html": { "schema": { "type": "string" } } } }, "ImmutableProcess": { "description": "the processes is not mutable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exception" } }, "text/html": { "schema": { "type": "string" } } } } } } }