Source code for weaver.wps_restapi.swagger_definitions

"""
Schema definitions for `OpenAPI` generation and validation of data from received requests and returned responses.

This module should contain any and every definition in use to build the Swagger UI and the OpenAPI JSON schema
so that one can update the specification without touching any other files after the initial integration.

Schemas defined in this module are employed (through ``deserialize`` method calls) to validate that data conforms to
reported definitions. This makes the documentation of the API better aligned with resulting code execution under it.
It also provides a reference point for external users to understand expected data structures with complete schema
definitions generated on the exposed endpoints (JSON and Swagger UI).

The definitions are also employed to generate the `OpenAPI` definitions reported in the documentation published
on `Weaver`'s `ReadTheDocs` page.
"""
# pylint: disable=C0103,invalid-name
import datetime
import inspect
import os
import re
from copy import copy
from decimal import Decimal
from typing import TYPE_CHECKING

import colander
import duration
import jsonschema
import yaml
from babel.numbers import list_currencies
from colander import All, DateTime, Email, Length, Money, OneOf, Range, Regex, drop, null, required
from dateutil import parser as date_parser

from weaver import WEAVER_SCHEMA_DIR, __meta__
from weaver.config import WeaverFeature
from weaver.execute import ExecuteControlOption, ExecuteMode, ExecuteResponse, ExecuteTransmissionMode
from weaver.formats import AcceptLanguage, ContentType, OutputFormat
from weaver.owsexceptions import OWSMissingParameterValue
from weaver.processes.constants import (
    CWL_REQUIREMENT_APP_BUILTIN,
    CWL_REQUIREMENT_APP_DOCKER,
    CWL_REQUIREMENT_APP_DOCKER_GPU,
    CWL_REQUIREMENT_APP_ESGF_CWT,
    CWL_REQUIREMENT_APP_OGC_API,
    CWL_REQUIREMENT_APP_WPS1,
    CWL_REQUIREMENT_CUDA,
    CWL_REQUIREMENT_INIT_WORKDIR,
    CWL_REQUIREMENT_INLINE_JAVASCRIPT,
    CWL_REQUIREMENT_INPLACE_UPDATE,
    CWL_REQUIREMENT_LOAD_LISTING,
    CWL_REQUIREMENT_NETWORK_ACCESS,
    CWL_REQUIREMENT_RESOURCE,
    CWL_REQUIREMENT_SCATTER,
    CWL_REQUIREMENT_TIME_LIMIT,
    CWL_REQUIREMENT_WORK_REUSE,
    OAS_COMPLEX_TYPES,
    OAS_DATA_TYPES,
    PACKAGE_ARRAY_BASE,
    PACKAGE_ARRAY_ITEMS,
    PACKAGE_CUSTOM_TYPES,
    PACKAGE_ENUM_BASE,
    PACKAGE_TYPE_POSSIBLE_VALUES,
    WPS_LITERAL_DATA_TYPES,
    JobInputsOutputsSchema,
    ProcessSchema
)
from weaver.quotation.status import QuoteStatus
from weaver.sort import Sort, SortMethods
from weaver.status import JOB_STATUS_CODE_API, JOB_STATUS_SEARCH_API, Status
from weaver.utils import AWS_S3_BUCKET_REFERENCE_PATTERN, load_file
from weaver.visibility import Visibility
from weaver.wps_restapi.colander_extras import (
    NO_DOUBLE_SLASH_PATTERN,
    AllOfKeywordSchema,
    AnyOfKeywordSchema,
    BoundedRange,
    CommaSeparated,
    EmptyMappingSchema,
    ExpandStringList,
    ExtendedBoolean as Boolean,
    ExtendedFloat as Float,
    ExtendedInteger as Integer,
    ExtendedMappingSchema,
    ExtendedSchemaNode,
    ExtendedSequenceSchema,
    ExtendedString as String,
    NotKeywordSchema,
    OneOfCaseInsensitive,
    OneOfKeywordSchema,
    PermissiveMappingSchema,
    PermissiveSequenceSchema,
    SchemeURL,
    SemanticVersion,
    StrictMappingSchema,
    StringOneOf,
    StringRange,
    XMLObject
)
from weaver.wps_restapi.constants import ConformanceCategory
from weaver.wps_restapi.patches import ServiceOnlyExplicitGetHead as Service  # warning: don't use 'cornice.Service'

if TYPE_CHECKING:
    from typing import Any, Union
    from typing_extensions import TypedDict

    from weaver.typedefs import DatetimeIntervalType, JSON, SettingsType

[docs] ViewInfo = TypedDict("ViewInfo", {"name": str, "pattern": str})
[docs]WEAVER_CONFIG_REMOTE_LIST = f"[{', '.join(WeaverFeature.REMOTE)}]"
[docs]API_TITLE = "Weaver REST API"
[docs]API_INFO = { "description": __meta__.__description__, "contact": {"name": __meta__.__authors__, "email": __meta__.__emails__, "url": __meta__.__source_repository__}
}
[docs]API_DOCS = { "description": f"{__meta__.__title__} documentation", "url": __meta__.__documentation_url__
}
[docs]DOC_URL = f"{__meta__.__documentation_url__}/en/latest"
[docs]CWL_VERSION = "v1.2"
[docs]CWL_REPO_URL = "https://github.com/common-workflow-language"
[docs]CWL_BASE_URL = "https://www.commonwl.org"
[docs]CWL_SPEC_URL = f"{CWL_BASE_URL}/#Specification"
[docs]CWL_USER_GUIDE_URL = f"{CWL_BASE_URL}/user_guide"
[docs]CWL_DOC_BASE_URL = f"{CWL_BASE_URL}/{CWL_VERSION}"
[docs]CWL_CMD_TOOL_URL = f"{CWL_DOC_BASE_URL}/CommandLineTool.html"
[docs]CWL_WORKFLOW_URL = f"{CWL_DOC_BASE_URL}/Workflow.html"
[docs]CWL_DOC_MESSAGE = ( "Note that multiple formats are supported and not all specification variants or parameters "
f"are presented here. Please refer to official CWL documentation for more details ({CWL_BASE_URL})." )
[docs]IO_INFO_IDS = ( "Identifier of the {first} {what}. To merge details between corresponding {first} and {second} "
"{what} specifications, this is the value that will be used to associate them together." ) # development references
[docs]OGC_API_REPO_URL = "https://github.com/opengeospatial/ogcapi-processes"
[docs]OGC_API_SCHEMA_URL = "https://raw.githubusercontent.com/opengeospatial/ogcapi-processes"
[docs]OGC_API_SCHEMA_VERSION = "master"
[docs]OGC_API_SCHEMA_BASE = f"{OGC_API_SCHEMA_URL}/{OGC_API_SCHEMA_VERSION}"
[docs]OGC_API_SCHEMA_CORE = f"{OGC_API_SCHEMA_BASE}/openapi/schemas/processes-core"
[docs]OGC_API_EXAMPLES_CORE = f"{OGC_API_SCHEMA_BASE}/core/examples"
# FIXME: OGC OpenAPI schema restructure (https://github.com/opengeospatial/ogcapi-processes/issues/319) # OGC_API_SCHEMA_EXT_DEPLOY = f"{OGC_API_SCHEMA_BASE}/openapi/schemas/processes-dru"
[docs]OGC_API_SCHEMA_EXT_DEPLOY = f"{OGC_API_SCHEMA_BASE}/extensions/deploy_replace_undeploy/standard/openapi/schemas"
[docs]OGC_API_EXAMPLES_EXT_DEPLOY = f"{OGC_API_SCHEMA_BASE}/extensions/deploy_replace_undeploy/examples"
# not available yet:
[docs]OGC_API_SCHEMA_EXT_BILL = f"{OGC_API_SCHEMA_BASE}/extensions/billing/standard/openapi/schemas"
[docs]OGC_API_SCHEMA_EXT_QUOTE = f"{OGC_API_SCHEMA_BASE}/extensions/quotation/standard/openapi/schemas"
[docs]OGC_API_SCHEMA_EXT_WORKFLOW = f"{OGC_API_SCHEMA_BASE}/extensions/workflows/standard/openapi/schemas"
# official/published references
[docs]OGC_API_PROC_PART1 = "https://schemas.opengis.net/ogcapi/processes/part1/1.0"
[docs]OGC_API_PROC_PART1_SCHEMAS = f"{OGC_API_PROC_PART1}/openapi/schemas"
[docs]OGC_API_PROC_PART1_RESPONSES = f"{OGC_API_PROC_PART1}/openapi/responses"
[docs]OGC_API_PROC_PART1_PARAMETERS = f"{OGC_API_PROC_PART1}/openapi/parameters"
[docs]OGC_API_PROC_PART1_EXAMPLES = f"{OGC_API_PROC_PART1}/examples"
[docs]WEAVER_SCHEMA_VERSION = "master"
[docs]WEAVER_SCHEMA_URL = f"https://raw.githubusercontent.com/crim-ca/weaver/{WEAVER_SCHEMA_VERSION}/weaver/schemas"
[docs]DATETIME_INTERVAL_CLOSED_SYMBOL = "/"
[docs]DATETIME_INTERVAL_OPEN_START_SYMBOL = "../"
[docs]DATETIME_INTERVAL_OPEN_END_SYMBOL = "/.."
# fields ordering for generation of ProcessDescription body (shared for OGC/OLD schema format)
[docs]PROCESS_DESCRIPTION_FIELD_FIRST = [ "id", "title", "version", "mutable", "abstract", # backward compat for deployment "description", "keywords", "metadata", "inputs", "outputs"
]
[docs]PROCESS_DESCRIPTION_FIELD_AFTER = [ "processDescriptionURL", "processEndpointWPS1", "executeEndpoint", "deploymentProfile", "links"
] # fields ordering for nested process definition of OLD schema format of ProcessDescription
[docs]PROCESS_DESCRIPTION_FIELD_FIRST_OLD_SCHEMA = ["process"]
[docs]PROCESS_DESCRIPTION_FIELD_AFTER_OLD_SCHEMA = ["links"]
[docs]PROCESS_IO_FIELD_FIRST = ["id", "title", "description", "minOccurs", "maxOccurs"]
[docs]PROCESS_IO_FIELD_AFTER = ["literalDataDomains", "formats", "crs", "bbox"]
[docs]PROCESSES_LISTING_FIELD_FIRST = ["description", "processes", "providers"]
[docs]PROCESSES_LISTING_FIELD_AFTER = ["page", "limit", "count", "total", "links"]
[docs]PROVIDER_DESCRIPTION_FIELD_FIRST = [ "id", "title", "version", "mutable", "description", "url", "type", "public", "keywords", "metadata",
]
[docs]PROVIDER_DESCRIPTION_FIELD_AFTER = ["links"]
[docs]JOBS_LISTING_FIELD_FIRST = ["description", "jobs", "groups"]
[docs]JOBS_LISTING_FIELD_AFTER = ["page", "limit", "count", "total", "links"]
[docs]QUOTES_LISTING_FIELD_FIRST = ["description", "quotations"]
[docs]QUOTES_LISTING_FIELD_AFTER = ["page", "limit", "count", "total", "links"]
######################################################### # Examples ######################################################### # load examples by file names as keys
[docs]SCHEMA_EXAMPLE_DIR = os.path.join(os.path.dirname(__file__), "examples")
[docs]EXAMPLES = {}
for name in os.listdir(SCHEMA_EXAMPLE_DIR):
[docs] path = os.path.join(SCHEMA_EXAMPLE_DIR, name)
ext = os.path.splitext(name)[-1] with open(path, "r", encoding="utf-8") as f: if ext in [".json", ".yaml", ".yml"]: EXAMPLES[name] = yaml.safe_load(f) # both JSON/YAML else: EXAMPLES[name] = f.read() ######################################################### # API tags #########################################################
[docs]TAG_API = "API"
[docs]TAG_JOBS = "Jobs"
[docs]TAG_VISIBILITY = "Visibility"
[docs]TAG_BILL_QUOTE = "Billing & Quoting"
[docs]TAG_PROVIDERS = "Providers"
[docs]TAG_PROCESSES = "Processes"
[docs]TAG_GETCAPABILITIES = "GetCapabilities"
[docs]TAG_DESCRIBEPROCESS = "DescribeProcess"
[docs]TAG_EXECUTE = "Execute"
[docs]TAG_DISMISS = "Dismiss"
[docs]TAG_STATUS = "Status"
[docs]TAG_DEPLOY = "Deploy"
[docs]TAG_RESULTS = "Results"
[docs]TAG_EXCEPTIONS = "Exceptions"
[docs]TAG_LOGS = "Logs"
[docs]TAG_STATISTICS = "Statistics"
[docs]TAG_VAULT = "Vault"
[docs]TAG_WPS = "WPS"
[docs]TAG_DEPRECATED = "Deprecated Endpoints"
############################################################################### # API endpoints # These "services" are wrappers that allow Cornice to generate the JSON API ###############################################################################
[docs]api_frontpage_service = Service(name="api_frontpage", path="/")
[docs]api_openapi_ui_service = Service(name="api_openapi_ui", path="/api") # idem to swagger
[docs]api_swagger_ui_service = Service(name="api_swagger_ui", path="/swagger")
[docs]api_redoc_ui_service = Service(name="api_redoc_ui", path="/redoc")
[docs]api_versions_service = Service(name="api_versions", path="/versions")
[docs]api_conformance_service = Service(name="api_conformance", path="/conformance")
[docs]openapi_json_service = Service(name="openapi_json", path="/json")
[docs]quotes_service = Service(name="quotes", path="/quotations")
[docs]quote_service = Service(name="quote", path=f"{quotes_service.path}/{{quote_id}}")
[docs]bills_service = Service(name="bills", path="/bills")
[docs]bill_service = Service(name="bill", path=f"{bills_service.path}/{{bill_id}}")
[docs]jobs_service = Service(name="jobs", path="/jobs")
[docs]job_service = Service(name="job", path=f"{jobs_service.path}/{{job_id}}")
[docs]job_results_service = Service(name="job_results", path=f"{job_service.path}/results")
[docs]job_exceptions_service = Service(name="job_exceptions", path=f"{job_service.path}/exceptions")
[docs]job_outputs_service = Service(name="job_outputs", path=f"{job_service.path}/outputs")
[docs]job_inputs_service = Service(name="job_inputs", path=f"{job_service.path}/inputs")
[docs]job_logs_service = Service(name="job_logs", path=f"{job_service.path}/logs")
[docs]job_stats_service = Service(name="job_stats", path=f"{job_service.path}/statistics")
[docs]processes_service = Service(name="processes", path="/processes")
[docs]process_service = Service(name="process", path=f"{processes_service.path}/{{process_id}}")
[docs]process_quotes_service = Service(name="process_quotes", path=process_service.path + quotes_service.path)
[docs]process_quote_service = Service(name="process_quote", path=process_service.path + quote_service.path)
[docs]process_estimator_service = Service(name="process_estimator_service", path=f"{process_service.path}/estimator")
[docs]process_visibility_service = Service(name="process_visibility", path=f"{process_service.path}/visibility")
[docs]process_package_service = Service(name="process_package", path=f"{process_service.path}/package")
[docs]process_payload_service = Service(name="process_payload", path=f"{process_service.path}/payload")
[docs]process_jobs_service = Service(name="process_jobs", path=process_service.path + jobs_service.path)
[docs]process_job_service = Service(name="process_job", path=process_service.path + job_service.path)
[docs]process_results_service = Service(name="process_results", path=process_service.path + job_results_service.path)
[docs]process_inputs_service = Service(name="process_inputs", path=process_service.path + job_inputs_service.path)
[docs]process_outputs_service = Service(name="process_outputs", path=process_service.path + job_outputs_service.path)
[docs]process_exceptions_service = Service(name="process_exceptions", path=process_service.path + job_exceptions_service.path)
[docs]process_logs_service = Service(name="process_logs", path=process_service.path + job_logs_service.path)
[docs]process_stats_service = Service(name="process_stats", path=process_service.path + job_stats_service.path)
[docs]process_execution_service = Service(name="process_execution", path=f"{process_service.path}/execution")
[docs]providers_service = Service(name="providers", path="/providers")
[docs]provider_service = Service(name="provider", path=f"{providers_service.path}/{{provider_id}}")
[docs]provider_processes_service = Service(name="provider_processes", path=provider_service.path + processes_service.path)
[docs]provider_process_service = Service(name="provider_process", path=provider_service.path + process_service.path)
[docs]provider_jobs_service = Service(name="provider_jobs", path=provider_service.path + process_jobs_service.path)
[docs]provider_job_service = Service(name="provider_job", path=provider_service.path + process_job_service.path)
[docs]provider_results_service = Service(name="provider_results", path=provider_service.path + process_results_service.path)
[docs]provider_inputs_service = Service(name="provider_inputs", path=provider_service.path + process_inputs_service.path)
[docs]provider_outputs_service = Service(name="provider_outputs", path=provider_service.path + process_outputs_service.path)
[docs]provider_logs_service = Service(name="provider_logs", path=provider_service.path + process_logs_service.path)
[docs]provider_stats_service = Service(name="provider_stats", path=provider_service.path + process_stats_service.path)
[docs]provider_exceptions_service = Service(name="provider_exceptions", path=provider_service.path + process_exceptions_service.path)
[docs]provider_execution_service = Service(name="provider_execution", path=f"{provider_process_service.path}/execution")
# backward compatibility deprecated routes
[docs]job_result_service = Service(name="job_result", path=f"{job_service.path}/result")
[docs]process_result_service = Service(name="process_result", path=process_service.path + job_result_service.path)
[docs]provider_result_service = Service(name="provider_result", path=provider_service.path + process_result_service.path)
[docs]vault_service = Service(name="vault", path="/vault")
[docs]vault_file_service = Service(name="vault_file", path=f"{vault_service.path}/{{file_id}}")
######################################################### # Generic schemas #########################################################
[docs]class SLUG(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "Slug name pattern."
[docs] example = "some-object-slug-name"
[docs] pattern = re.compile(r"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$")
[docs]class Tag(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "Identifier with optional tagged version forming a unique reference."
# ranges used to remove starting/ending ^$ characters
[docs] pattern = re.compile( rf"{SLUG.pattern.pattern[:-1]}"
rf"(:{SemanticVersion(v_prefix=False, rc_suffix=False).pattern[1:-1]})?$" )
[docs]class URL(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "URL reference."
[docs] format = "url"
[docs]class MediaType(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "IANA identifier of content and format."
[docs] example = ContentType.APP_JSON
[docs] pattern = re.compile(r"^\w+\/[-.\w]+(?:\+[-.\w]+)?(?:\;\s*.+)*$")
[docs]class QueryBoolean(Boolean):
[docs] description = "Boolean query parameter that allows handles common truthy/falsy values."
def __init__(self, *_, **__): # type: (*Any, **Any) -> None super(QueryBoolean, self).__init__( allow_string=True, false_choices=("False", "false", "0", "off", "no", "null", "Null", "none", "None", ""), true_choices=("True", "true", "1", "on", "yes")
)
[docs]class DateTimeInterval(ExtendedSchemaNode):
[docs] _schema = f"{OGC_API_PROC_PART1_PARAMETERS}/datetime.yaml"
[docs] schema_type = String
[docs] description = ( "DateTime format against OGC API - Processes, "
"to get values before a certain date-time use '../' before the date-time, " "to get values after a certain date-time use '/..' after the date-time like the example, " "to get values between two date-times use '/' between the date-times, " "to get values with a specific date-time just pass the datetime. " )
[docs] example = "2022-03-02T03:32:38.487000+00:00/.."
[docs] regex_datetime = re.compile(r"(\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(\.\d+)?(([+-]\d\d:\d\d)|Z)?)")
[docs] regex_interval_closed = re.compile(rf"{regex_datetime.pattern}\/{regex_datetime.pattern}")
[docs] regex_interval_open_start = re.compile(rf"\.\.\/{regex_datetime.pattern}")
[docs] regex_interval_open_end = re.compile(rf"{regex_datetime.pattern}\/\.\.")
[docs] pattern = re.compile( rf"^{regex_datetime.pattern}"
rf"|{regex_interval_closed.pattern}" rf"|{regex_interval_open_start.pattern}" rf"|{regex_interval_open_end.pattern}" r"$" )
[docs]class S3BucketReference(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "S3 bucket shorthand URL representation: 's3://{bucket}/[{dirs}/][{file-key}]'"
[docs] pattern = AWS_S3_BUCKET_REFERENCE_PATTERN
[docs]class FileLocal(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "Local file reference."
[docs] format = "file"
[docs] pattern = re.compile(rf"^(file://)?{NO_DOUBLE_SLASH_PATTERN}(?:/|[/?]\S+)$")
[docs]class FileURL(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "URL file reference."
[docs] format = "url"
[docs] validator = SchemeURL(schemes=["http", "https"])
[docs]class VaultReference(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "Vault file reference."
[docs] example = "vault://399dc5ac-ff66-48d9-9c02-b144a975abe4"
[docs] pattern = re.compile(r"^vault://[a-f0-9]{8}(?:-?[a-f0-9]{4}){3}-?[a-f0-9]{12}$")
[docs]class ProcessURL(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "Process URL reference."
[docs] format = "url"
[docs] validator = SchemeURL(schemes=["http", "https"], path_pattern=r"(?:/processes/\S+/?)")
[docs]class ReferenceURL(AnyOfKeywordSchema):
[docs] _any_of = [ FileURL(), FileLocal(), S3BucketReference(),
]
[docs]class ExecuteReferenceURL(AnyOfKeywordSchema):
[docs] _any_of = [ FileURL(), FileLocal(), S3BucketReference(), VaultReference(),
]
[docs]class UUID(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "Unique identifier."
[docs] example = "a9d14bf4-84e0-449a-bac8-16e598efe807"
[docs] format = "uuid"
[docs] pattern = re.compile("^[a-f0-9]{8}(?:-?[a-f0-9]{4}){3}-?[a-f0-9]{12}$")
[docs] title = "UUID"
[docs]class AnyIdentifier(SLUG): pass
[docs]class ProcessIdentifier(AnyOfKeywordSchema):
[docs] description = "Process identifier."
[docs] _any_of = [ # UUID first because more strict than SLUG, and SLUG can be similar to UUID, but in the end any is valid UUID(description="Unique identifier."), SLUG(description="Generic identifier. This is a user-friendly slug-name. " "Note that this will represent the latest process matching this name. " "For specific process version, use the UUID instead.", title="ID"),
]
[docs]class ProcessIdentifierTag(AnyOfKeywordSchema):
[docs] description = "Process identifier with optional revision tag."
[docs] _schema = f"{OGC_API_PROC_PART1_PARAMETERS}/processIdPathParam.yaml"
[docs] _any_of = [Tag] + ProcessIdentifier._any_of # type: ignore # noqa: W0212
[docs]class JobID(UUID):
[docs] _schema = f"{OGC_API_PROC_PART1_PARAMETERS}/jobId.yaml"
[docs] description = "ID of the job."
[docs] example = "a9d14bf4-84e0-449a-bac8-16e598efe807"
[docs]class Version(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "Version string."
[docs] example = "1.2.3"
[docs] validator = SemanticVersion()
[docs]class ContentTypeHeader(ExtendedSchemaNode): # ok to use 'name' in this case because target 'key' in the mapping must # be that specific value but cannot have a field named with this format
[docs] name = "Content-Type"
[docs] schema_type = String
[docs]class ContentLengthHeader(ExtendedSchemaNode):
[docs] name = "Content-Length"
[docs] schema_type = String
[docs] example = "125"
[docs]class ContentDispositionHeader(ExtendedSchemaNode):
[docs] name = "Content-Disposition"
[docs] schema_type = String
[docs] example = "attachment; filename=test.json"
[docs]class DateHeader(ExtendedSchemaNode):
[docs] description = "Creation date and time of the contents."
[docs] name = "Date"
[docs] schema_type = String
[docs] example = "Thu, 13 Jan 2022 12:37:19 GMT"
[docs]class LastModifiedHeader(ExtendedSchemaNode):
[docs] description = "Modification date and time of the contents."
[docs] name = "Last-Modified"
[docs] schema_type = String
[docs] example = "Thu, 13 Jan 2022 12:37:19 GMT"
[docs]class AcceptHeader(ExtendedSchemaNode): # ok to use 'name' in this case because target 'key' in the mapping must # be that specific value but cannot have a field named with this format
[docs] name = "Accept"
[docs] schema_type = String
# FIXME: raise HTTPNotAcceptable in not one of those?
[docs] validator = OneOf([ ContentType.APP_JSON, ContentType.APP_XML, ContentType.TEXT_XML, ContentType.TEXT_HTML, ContentType.TEXT_PLAIN, ContentType.ANY,
])
[docs] missing = drop
[docs] default = ContentType.APP_JSON # defaults to JSON for easy use within browsers
[docs]class AcceptLanguageHeader(ExtendedSchemaNode): # ok to use 'name' in this case because target 'key' in the mapping must # be that specific value but cannot have a field named with this format
[docs] name = "Accept-Language"
[docs] schema_type = String
[docs] missing = drop
[docs] default = AcceptLanguage.EN_CA
# FIXME: oneOf validator for supported languages (?)
[docs]class JsonHeader(ExtendedMappingSchema):
[docs] content_type = ContentTypeHeader(example=ContentType.APP_JSON, default=ContentType.APP_JSON)
[docs]class HtmlHeader(ExtendedMappingSchema):
[docs] content_type = ContentTypeHeader(example=ContentType.TEXT_HTML, default=ContentType.TEXT_HTML)
[docs]class XmlHeader(ExtendedMappingSchema):
[docs] content_type = ContentTypeHeader(example=ContentType.APP_XML, default=ContentType.APP_XML)
[docs]class XAuthDockerHeader(ExtendedSchemaNode):
[docs] summary = "Authentication header for private Docker registry access."
[docs] description = ( "Authentication header for private registry access in order to retrieve the Docker image reference "
"specified in an Application Package during Process deployment. When provided, this header should " "contain similar details as typical Authentication or X-Auth-Token headers " f"(see {DOC_URL}/package.html#dockerized-applications for more details)." )
[docs] name = "X-Auth-Docker"
[docs] example = "Basic {base64-auth-credentials}"
[docs] schema_type = String
[docs] missing = drop
[docs]class RequestContentTypeHeader(ContentTypeHeader):
[docs] example = ContentType.APP_JSON
[docs] default = ContentType.APP_JSON
[docs] validator = OneOf([ ContentType.APP_JSON,
# ContentType.APP_XML, ])
[docs]class ResponseContentTypeHeader(ContentTypeHeader):
[docs] example = ContentType.APP_JSON
[docs] default = ContentType.APP_JSON
[docs] validator = OneOf([ ContentType.APP_JSON, ContentType.APP_XML, ContentType.TEXT_XML, ContentType.TEXT_HTML,
])
[docs]class RequestHeaders(ExtendedMappingSchema): """ Headers that can indicate how to adjust the behavior and/or result to be provided in the response. """
[docs] accept = AcceptHeader()
[docs] accept_language = AcceptLanguageHeader()
[docs] content_type = RequestContentTypeHeader()
[docs]class ResponseHeaders(ResponseContentTypeHeader): """ Headers describing resulting response. """
[docs] content_type = ResponseContentTypeHeader()
[docs]class RedirectHeaders(ResponseHeaders):
[docs] Location = URL(example="https://job/123/result", description="Redirect resource location.")
[docs]class AcceptFormatHeaders(ExtendedMappingSchema):
[docs] accept = AcceptHeader(description="Output format selector. Equivalent to 'f' or 'format' queries.")
[docs] accept_language = AcceptLanguageHeader(description="Output content language if supported.")
[docs]class OutputFormatQuery(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "Output format selector for requested contents."
[docs] example = OutputFormat.JSON
[docs] validator = OneOf(OutputFormat.values())
[docs]class FormatQueryValue(OneOfKeywordSchema):
[docs] _one_of = [ MediaType(), OutputFormatQuery()
]
[docs]class FormatQuery(ExtendedMappingSchema):
[docs] f = FormatQueryValue( missing=drop, description="Output format selector. Equivalent to 'format' query or 'Accept' header."
)
[docs] format = FormatQueryValue( missing=drop, description="Output format selector. Equivalent to 'f' query or 'Accept' header."
)
[docs]class NoContent(ExtendedMappingSchema):
[docs] description = "Empty response body."
[docs] default = {}
[docs]class FileUploadHeaders(RequestHeaders): # MUST be multipart for upload
[docs] content_type = ContentTypeHeader( example=f"{ContentType.MULTI_PART_FORM}; boundary=43003e2f205a180ace9cd34d98f911ff", default=ContentType.MULTI_PART_FORM, description="Desired Content-Type of the file being uploaded.", missing=required)
[docs] content_length = ContentLengthHeader(description="Uploaded file contents size in bytes.")
[docs] content_disposition = ContentDispositionHeader(example="form-data; name=\"file\"; filename=\"desired-name.ext\"", description="Expected ")
[docs]class FileUploadContent(ExtendedSchemaNode):
[docs] schema_type = String()
[docs] description = ( "Contents of the file being uploaded with multipart. When prefixed with 'Content-Type: {media-type}', the "
"specified format will be applied to the input that will be attributed the 'vault://{UUID}' during execution. " "Contents can also have 'Content-Disposition' definition to provide the desired file name." )
[docs]class FileResponseHeaders(NoContent):
[docs] content_type = ContentTypeHeader(example=ContentType.APP_JSON)
[docs] content_length = ContentLengthHeader()
[docs] content_disposition = ContentDispositionHeader()
[docs] date = DateHeader()
[docs] last_modified = LastModifiedHeader()
[docs]class AccessToken(ExtendedSchemaNode):
[docs] schema_type = String
[docs]class DescriptionSchema(ExtendedMappingSchema):
[docs] description = ExtendedSchemaNode(String(), description="Description of the obtained contents.")
[docs]class KeywordList(ExtendedSequenceSchema):
[docs] keyword = ExtendedSchemaNode(String(), validator=Length(min=1))
[docs]class Language(ExtendedSchemaNode):
[docs] schema_type = String
[docs] example = AcceptLanguage.EN_CA
[docs] validator = OneOf(AcceptLanguage.values())
[docs]class ValueLanguage(ExtendedMappingSchema):
[docs] lang = Language(missing=drop, description="Language of the value content.")
[docs]class LinkLanguage(ExtendedMappingSchema):
[docs] hreflang = Language(missing=drop, description="Language of the content located at the link.")
[docs]class LinkHeader(ExtendedSchemaNode):
[docs] schema_type = String
[docs] example = "<http://example.com>; rel=\"relation\"; type=text/plain"
[docs]class MetadataBase(ExtendedMappingSchema):
[docs] title = ExtendedSchemaNode(String(), missing=drop)
[docs]class MetadataRole(ExtendedMappingSchema):
[docs] role = URL(missing=drop)
[docs]class LinkRelationshipType(OneOfKeywordSchema):
[docs] description = ( "Link relation as registered or extension type "
"(see https://www.rfc-editor.org/rfc/rfc8288.html#section-2.1)." )
[docs] _one_of = [ SLUG(description=( "Relationship of the link to the current content. " "This should be one item amongst registered relations https://www.iana.org/assignments/link-relations/." )), URL(description="Fully qualified extension link relation to the current content.")
]
[docs]class LinkRelationship(ExtendedMappingSchema):
[docs] rel = LinkRelationshipType()
[docs]class LinkBase(LinkLanguage, MetadataBase):
[docs] href = URL(description="Hyperlink reference.")
[docs] type = MediaType(description="IANA identifier of content-type located at the link.", missing=drop)
[docs]class MetadataValue(NotKeywordSchema, ValueLanguage, MetadataBase):
[docs] _not = [ # make sure value metadata does not allow 'rel' and 'hreflang' reserved for link reference # explicitly refuse them such that when a href/rel link is provided, only link details are possible LinkRelationship(description="Field 'rel' must refer to a link reference with 'href'."), LinkLanguage(description="Field 'hreflang' must refer to a link reference with 'href'."),
]
[docs] value = ExtendedSchemaNode(String(), description="Plain text value of the information.")
[docs]class MetadataContent(OneOfKeywordSchema):
[docs] _one_of = [ MetadataLink(), MetadataValue(),
]
[docs]class Metadata(MetadataContent, MetadataRole): pass
[docs]class MetadataList(ExtendedSequenceSchema):
[docs] metadata = Metadata()
[docs]class LandingPage(ExtendedMappingSchema):
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/landingPage.yaml"
# sub-schema within: # https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-core/format.yaml
[docs]class FormatSchema(OneOfKeywordSchema):
[docs] _one_of = [ # pointer to a file or JSON schema relative item (as in OpenAPI definitions) ReferenceURL(description="Reference where the schema definition can be retrieved to describe referenced data."), # literal JSON schema, permissive since it can be anything PermissiveMappingSchema(description="Explicit schema definition of the formatted reference data.")
] # because some pre-existing processes + pywps default schema is "" # deserialization against the validator pattern of 'ReferenceURL' makes it always fail # this causes the whole 'Format' container (and others similar) fail and be dropped # to resolve this issue, preemptively detect the empty string and signal the parent OneOf to remove it
[docs] def deserialize(self, cstruct): # type: ignore if isinstance(cstruct, str) and cstruct == "": return drop # field that refers to this schema will drop the field key entirely return super(FormatSchema, self).deserialize(cstruct)
[docs]class FormatMimeType(ExtendedMappingSchema): """ Used to respect ``mimeType`` field to work with pre-existing processes. """
[docs] mimeType = MediaType(default=ContentType.TEXT_PLAIN, example=ContentType.APP_JSON)
[docs] encoding = ExtendedSchemaNode(String(), missing=drop)
[docs] schema = FormatSchema(missing=drop)
[docs]class Format(ExtendedMappingSchema): """ Used to respect ``mediaType`` field as suggested per `OGC-API`. """
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/format.yaml"
[docs] _ext_schema_fields = [] # exclude "$schema" added on each sub-deserialize (too verbose, only for reference)
[docs] mediaType = MediaType(default=ContentType.TEXT_PLAIN, example=ContentType.APP_JSON)
[docs] encoding = ExtendedSchemaNode(String(), missing=drop)
[docs] schema = FormatSchema(missing=drop)
[docs]class FormatDefaultMimeType(FormatMimeType):
[docs] description = ( "Format for process input are assumed plain/text if the media-type was omitted and is not one of the known "
"formats by this instance. When executing a job, the best match against supported formats by the process " "definition will be used to run the process, and will fall back to the default as last resort." ) # NOTE: # The default is overridden from FormatMimeType since the FormatSelection 'oneOf' always fails, # due to the 'default' value which is always generated, and it causes the presence of both Format and FormatMimeType
[docs] mimeType = MediaType(example=ContentType.APP_JSON)
[docs]class FormatDefaultMediaType(Format):
[docs] description = ( "Format for process input are assumed plain/text if the media-type was omitted and is not one of the known "
"formats by this instance. When executing a job, the best match against supported formats by the process " "definition will be used to run the process, and will fall back to the default as last resort." ) # NOTE: # The default is overridden from Format since the FormatSelection 'oneOf' always fails, # due to the 'default' value which is always generated, and it causes the presence of both Format and FormatMimeType
[docs] mediaType = MediaType(example=ContentType.APP_JSON)
[docs]class FormatSelection(OneOfKeywordSchema): """ Validation against ``mimeType`` or ``mediaType`` format. .. seealso:: - :class:`FormatDefaultMediaType` - :class:`FormatDefaultMimeType` .. note:: Format are validated to be retro-compatible with pre-existing/deployed/remote processes. """
[docs] _one_of = [ FormatDefaultMediaType(), FormatDefaultMimeType()
] # only extra portion from: # https://github.com/opengeospatial/ogcapi-processes/blob/e6893b/extensions/workflows/openapi/workflows.yaml#L1538-L1547
[docs]class FormatDescription(ExtendedMappingSchema):
[docs] maximumMegabytes = ExtendedSchemaNode(Integer(), missing=drop, validator=Range(min=1))
# although original schema defines 'default' in above 'FormatDescription', separate it in order to omit it # from 'ResultFormat' employed for result reporting, which shouldn't have a default (applied vs supported format)
[docs]class FormatDefault(ExtendedMappingSchema):
[docs] default = ExtendedSchemaNode( Boolean(), missing=drop, # don't insert "default" field if omitted in deploy body to avoid causing differing "inputs"/"outputs" # definitions between the submitted payload and the validated one (in 'weaver.processes.utils._check_deploy') # default=False, description=( "Indicates if this format should be considered as the default one in case none of the other "
"allowed or supported formats was matched nor provided as input during job submission." ) )
[docs]class DescriptionFormat(Format, FormatDescription, FormatDefault): pass
[docs]class DeploymentFormat(FormatSelection, FormatDescription, FormatDefault): # NOTE: # The 'OGC-API' suggest to use 'mediaType' field for format representation, but retro-compatibility is # supported during deployment only, where either old 'mimeType' or new 'mediaType', but only 'mediaType' # is used for process description and result reporting. This support is added for deployment so that # pre-existing deploy definitions remain valid without need to update them. pass
[docs]class ResultFormat(FormatDescription): """ Format employed for reference results respecting 'OGC API - Processes' schemas. """
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/format.yaml"
[docs] _ext_schema_fields = [] # exclude "$schema" added on each sub-deserialize (too verbose, only for reference)
[docs] mediaType = MediaType(String())
[docs] encoding = ExtendedSchemaNode(String(), missing=drop)
[docs] schema = FormatSchema(missing=drop)
[docs]class DescriptionFormatList(ExtendedSequenceSchema):
[docs] format_item = DescriptionFormat()
[docs]class DeploymentFormatList(ExtendedSequenceSchema):
[docs] format_item = DeploymentFormat()
[docs]class AdditionalParameterUnique(OneOfKeywordSchema):
[docs] _one_of = [ ExtendedSchemaNode(String(), title="InputParameterLiteral.String"), ExtendedSchemaNode(Boolean(), title="InputParameterLiteral.Boolean"), ExtendedSchemaNode(Integer(), title="InputParameterLiteral.Integer"), ExtendedSchemaNode(Float(), title="InputParameterLiteral.Float"),
# PermissiveMappingSchema(title="InputParameterLiteral.object"), ]
[docs]class AdditionalParameterListing(ExtendedSequenceSchema):
[docs] param = AdditionalParameterUnique()
[docs]class AdditionalParameterValues(OneOfKeywordSchema):
[docs] _one_of = [ AdditionalParameterUnique(), AdditionalParameterListing()
]
[docs]class AdditionalParameterDefinition(ExtendedMappingSchema):
[docs] name = SLUG(title="AdditionalParameterName", example="EOImage")
[docs] values = AdditionalParameterValues(example=["true"])
[docs]class AdditionalParameterList(ExtendedSequenceSchema):
[docs] param = AdditionalParameterDefinition()
[docs]class AdditionalParametersMeta(OneOfKeywordSchema):
[docs] _one_of = [ LinkBase(title="AdditionalParameterLink"), MetadataRole(title="AdditionalParameterRole")
]
[docs]class AdditionalParameters(ExtendedMappingSchema):
[docs] parameters = AdditionalParameterList()
[docs]class AdditionalParametersItem(AnyOfKeywordSchema):
[docs] _any_of = [ AdditionalParametersMeta(), AdditionalParameters()
]
[docs]class AdditionalParametersList(ExtendedSequenceSchema):
[docs] additionalParameter = AdditionalParametersItem()
[docs]class Content(ExtendedMappingSchema):
[docs] href = ReferenceURL(description="URL to CWL file.", title="OWSContentURL", default=drop, # if invalid, drop it completely, missing=required, # but still mark as 'required' for parent objects example="http://some.host/applications/cwl/multisensor_ndvi.cwl")
[docs]class Offering(ExtendedMappingSchema):
[docs] code = ExtendedSchemaNode(String(), missing=drop, description="Descriptor of represented information in 'content'.")
[docs] content = Content()
[docs]class OWSContext(ExtendedMappingSchema):
[docs] description = "OGC Web Service definition from an URL reference."
[docs] title = "owsContext"
[docs] offering = Offering()
[docs]class DescriptionBase(ExtendedMappingSchema):
[docs] title = ExtendedSchemaNode(String(), missing=drop, description="Short human-readable name of the object.")
[docs] description = ExtendedSchemaNode(String(), missing=drop, description="Detailed explanation of the object.")
[docs]class ProcessContext(ExtendedMappingSchema):
[docs] owsContext = OWSContext(missing=drop)
[docs]class DescriptionExtra(ExtendedMappingSchema):
[docs] additionalParameters = AdditionalParametersList(missing=drop)
[docs]class DescriptionType(DescriptionBase, DescriptionLinks, DescriptionExtra): pass
[docs]class DeploymentType(DescriptionType):
[docs] deprecated = True
[docs] abstract = ExtendedSchemaNode( String(), missing=drop, deprecated=True, description="Description of the object. Will be replaced by 'description' field if not already provided. "
"Preserved for backward compatibility of pre-existing process deployment. " "Consider using 'description' directly instead." )
[docs]class DescriptionMeta(ExtendedMappingSchema): # employ empty lists by default if nothing is provided for process description
[docs] keywords = KeywordList( default=[], description="Keywords applied to the process for search and categorization purposes.")
[docs] metadata = MetadataList( default=[], description="External references to documentation or metadata sources relevant to the process.")
[docs]class ProcessDeployMeta(ExtendedMappingSchema): # don't require fields at all for process deployment, default to empty if omitted
[docs] keywords = KeywordList( missing=drop, default=[], description="Keywords applied to the process for search and categorization purposes.")
[docs] metadata = MetadataList( missing=drop, default=[], description="External references to documentation or metadata sources relevant to the process.")
[docs]class InputOutputDescriptionMeta(ExtendedMappingSchema): # remove unnecessary empty lists by default if nothing is provided for inputs/outputs def __init__(self, *args, **kwargs): # type: (*Any, **Any) -> None super(InputOutputDescriptionMeta, self).__init__(*args, **kwargs) for child in self.children: if child.name in ["keywords", "metadata"]: child.missing = drop
[docs]class ReferenceOAS(ExtendedMappingSchema):
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/reference.yaml"
[docs] _ref = ReferenceURL(name="$ref", description="External OpenAPI schema reference.")
[docs]class TypeOAS(ExtendedSchemaNode):
[docs] name = "type"
[docs] schema_type = String
[docs] validator = OneOf(OAS_DATA_TYPES)
[docs]class EnumItemOAS(OneOfKeywordSchema):
[docs] _one_of = [ ExtendedSchemaNode(Float()), ExtendedSchemaNode(Integer()), ExtendedSchemaNode(String()),
]
[docs]class EnumOAS(ExtendedSequenceSchema):
[docs] enum = EnumItemOAS()
[docs]class RequiredOAS(ExtendedSequenceSchema):
[docs] required_field = ExtendedSchemaNode(String(), description="Name of the field that is required under the object.")
[docs]class MultipleOfOAS(OneOfKeywordSchema):
[docs] _one_of = [ ExtendedSchemaNode(Float()), ExtendedSchemaNode(Integer()),
]
[docs]class PermissiveDefinitionOAS(NotKeywordSchema, PermissiveMappingSchema):
[docs] _not = [ ReferenceOAS
] # cannot make recursive declarative schemas # simulate it and assume it is sufficient for validation purposes
[docs]class PseudoObjectOAS(OneOfKeywordSchema):
[docs] _one_of = [ ReferenceOAS(), PermissiveDefinitionOAS(),
]
[docs]class KeywordObjectOAS(ExtendedSequenceSchema):
[docs] item = PseudoObjectOAS()
[docs]class AdditionalPropertiesOAS(OneOfKeywordSchema):
[docs] _one_of = [ ReferenceOAS(), PermissiveDefinitionOAS(), ExtendedSchemaNode(Boolean())
]
[docs]class AnyValueOAS(AnyOfKeywordSchema):
[docs] _any_of = [ PermissiveMappingSchema(), PermissiveSequenceSchema(), ExtendedSchemaNode(Float()), ExtendedSchemaNode(Integer()), ExtendedSchemaNode(Boolean()), ExtendedSchemaNode(String()),
] # reference: # https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/schema.yaml # note: # although reference definition provides multiple 'default: 0|false' entries, we omit them since the behaviour # of colander with extended schema nodes is to set this value by default in deserialize result if they were missing, # but reference 'default' correspond more to the default *interpretation* value if none was provided. # It is preferable in our case to omit (i.e.: drop) these defaults to keep obtained/resolved definitions succinct, # since those defaults can be defined (by default...) if needed. No reason to add them explicitly. # WARNING: # cannot use any KeywordMapper derived instance here, otherwise conflicts with same OpenAPI keywords as children nodes
[docs]class PropertyOAS(PermissiveMappingSchema):
[docs] _type = TypeOAS(name="type", missing=drop) # not present if top-most schema is {allOf,anyOf,oneOf,not}
[docs] _format = ExtendedSchemaNode(String(), name="format", missing=drop)
[docs] default = AnyValueOAS(unknown="preserve", missing=drop)
[docs] example = AnyValueOAS(unknown="preserve", missing=drop)
[docs] title = ExtendedSchemaNode(String(), missing=drop)
[docs] description = ExtendedSchemaNode(String(), missing=drop)
[docs] enum = EnumOAS(missing=drop)
[docs] items = PseudoObjectOAS(name="items", missing=drop)
[docs] required = RequiredOAS(missing=drop)
[docs] nullable = ExtendedSchemaNode(Boolean(), missing=drop)
[docs] deprecated = ExtendedSchemaNode(Boolean(), missing=drop)
[docs] read_only = ExtendedSchemaNode(Boolean(), name="readOnly", missing=drop)
[docs] write_only = ExtendedSchemaNode(Boolean(), name="writeOnly", missing=drop)
[docs] multiple_of = MultipleOfOAS(name="multipleOf", missing=drop, validator=BoundedRange(min=0, exclusive_min=True))
[docs] minimum = ExtendedSchemaNode(Integer(), name="minimum", missing=drop, validator=Range(min=0)) # default=0
[docs] maximum = ExtendedSchemaNode(Integer(), name="maximum", missing=drop, validator=Range(min=0))
[docs] exclusive_min = ExtendedSchemaNode(Boolean(), name="exclusiveMinimum", missing=drop) # default=False
[docs] exclusive_max = ExtendedSchemaNode(Boolean(), name="exclusiveMaximum", missing=drop) # default=False
[docs] min_length = ExtendedSchemaNode(Integer(), name="minLength", missing=drop, validator=Range(min=0)) # default=0
[docs] max_length = ExtendedSchemaNode(Integer(), name="maxLength", missing=drop, validator=Range(min=0))
[docs] pattern = ExtendedSchemaNode(Integer(), missing=drop)
[docs] min_items = ExtendedSchemaNode(Integer(), name="minItems", missing=drop, validator=Range(min=0)) # default=0
[docs] max_items = ExtendedSchemaNode(Integer(), name="maxItems", missing=drop, validator=Range(min=0))
[docs] unique_items = ExtendedSchemaNode(Boolean(), name="uniqueItems", missing=drop) # default=False
[docs] min_prop = ExtendedSchemaNode(Integer(), name="minProperties", missing=drop, validator=Range(min=0)) # default=0
[docs] max_prop = ExtendedSchemaNode(Integer(), name="maxProperties", missing=drop, validator=Range(min=0))
[docs] content_type = ExtendedSchemaNode(String(), name="contentMediaType", missing=drop)
[docs] content_encode = ExtendedSchemaNode(String(), name="contentEncoding", missing=drop)
[docs] content_schema = ExtendedSchemaNode(String(), name="contentSchema", missing=drop)
[docs] _not_key = PseudoObjectOAS(name="not", title="not", missing=drop)
[docs] _all_of = KeywordObjectOAS(name="allOf", missing=drop)
[docs] _any_of = KeywordObjectOAS(name="anyOf", missing=drop)
[docs] _one_of = KeywordObjectOAS(name="oneOf", missing=drop)
[docs] x_props = AdditionalPropertiesOAS(name="additionalProperties", missing=drop)
[docs] properties = PermissiveMappingSchema(missing=drop) # cannot do real recursive definitions, simply check mapping
# this class is only to avoid conflicting names with keyword mappers
[docs]class AnyPropertyOAS(OneOfKeywordSchema):
[docs] _one_of = [ ReferenceOAS(), PropertyOAS(),
]
[docs]class ObjectPropertiesOAS(ExtendedMappingSchema):
[docs] property_name = AnyPropertyOAS( variable="{property-name}", description="Named of the property being defined under the OpenAPI object.",
) # would not need this if we could do explicit recursive definitions but at the very least, validate that when an # object type is specified, its properties are as well and are slightly more specific than permissive mapping
[docs]class ObjectOAS(NotKeywordSchema, ExtendedMappingSchema):
[docs] _not = [ReferenceOAS]
[docs] _type = TypeOAS(name="type", missing=drop, validator=OneOf(OAS_COMPLEX_TYPES))
[docs] properties = ObjectPropertiesOAS() # required and more specific contrary to 'properties' in 'PropertyOAS'
# since we redefine 'properties', do not cause validation error for 'oneOf'
[docs]class DefinitionOAS(AnyOfKeywordSchema):
[docs] _any_of = [ ObjectOAS(), PropertyOAS(), # for top-level keyword schemas {allOf,anyOf,oneOf,not}
]
[docs]class OAS(OneOfKeywordSchema):
[docs] description = "OpenAPI schema definition."
# _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/schema.yaml" # definition used by OAP, but JSON-schema is more accurate
[docs] _schema = "http://json-schema.org/draft-07/schema#"
[docs] _one_of = [ ReferenceOAS(), DefinitionOAS(),
]
[docs]class InputOutputDescriptionSchema(ExtendedMappingSchema): # Validation is accomplished only for the first few levels of the OpenAPI definition. # This is sufficient to know if the I/O type is literal/bbox/complex. If 'schema' is explicitly provided, it # should minimally succeed those top-level validation for proper I/O interpretation. Pseudo-recursive schema # are defined for any more deeply nested definition to keep everything intact (eg: explicit object structure).
[docs] schema = OAS(missing=drop)
[docs]class MinOccursDefinition(OneOfKeywordSchema):
[docs] description = "Minimum amount of values required for this input."
[docs] title = "MinOccurs"
[docs] example = 1
[docs] _one_of = [ ExtendedSchemaNode(Integer(), validator=Range(min=0), title="MinOccurs.integer", ddescription="Positive integer."), ExtendedSchemaNode(String(), validator=StringRange(min=0), pattern="^[0-9]+$", title="MinOccurs.string", description="Numerical string representing a positive integer."),
]
[docs]class MaxOccursDefinition(OneOfKeywordSchema):
[docs] description = "Maximum amount of values allowed for this input."
[docs] title = "MaxOccurs"
[docs] example = 1
[docs] _one_of = [ ExtendedSchemaNode(Integer(), validator=Range(min=0), title="MaxOccurs.integer", description="Positive integer."), ExtendedSchemaNode(String(), validator=StringRange(min=0), pattern="^[0-9]+$", title="MaxOccurs.string", description="Numerical string representing a positive integer."), ExtendedSchemaNode(String(), validator=OneOf(["unbounded"]), title="MaxOccurs.unbounded", description="Special value indicating no limit to occurrences."),
]
[docs]class DescribeMinMaxOccurs(ExtendedMappingSchema):
[docs] minOccurs = MinOccursDefinition()
[docs] maxOccurs = MaxOccursDefinition()
[docs]class DeployMinMaxOccurs(ExtendedMappingSchema): # entirely omitted definitions are permitted to allow inference from fields in package (CWL) or using defaults # if explicitly provided though, schema format and values should be validated # - do not use 'missing=drop' to ensure we raise provided invalid value instead of ignoring it # - do not use any specific value (e.g.: 1) for 'default' such that we do not inject an erroneous value when it # was originally omitted, since it could be resolved differently depending on matching CWL inputs definitions
[docs] minOccurs = MinOccursDefinition(default=null, missing=null)
[docs] maxOccurs = MaxOccursDefinition(default=null, missing=null)
# does not inherit from 'DescriptionLinks' because other 'ProcessDescription<>' schema depend on this without 'links'
[docs]class ProcessDescriptionType(DescriptionBase, DescriptionExtra):
[docs] id = ProcessIdentifierTag()
[docs] version = Version(missing=None, default=None, example="1.2.3")
[docs] mutable = ExtendedSchemaNode(Boolean(), default=True, description=( "Indicates if the process is mutable (dynamically deployed), or immutable (builtin with this instance)."
))
[docs]class InputIdentifierType(ExtendedMappingSchema):
[docs] id = AnyIdentifier(description=IO_INFO_IDS.format(first="WPS", second="CWL", what="input"))
[docs]class OutputIdentifierType(ExtendedMappingSchema):
[docs] id = AnyIdentifier(description=IO_INFO_IDS.format(first="WPS", second="CWL", what="output"))
[docs]class DescribeWithFormats(ExtendedMappingSchema):
[docs] formats = DescriptionFormatList()
[docs]class DeployWithFormats(ExtendedMappingSchema):
[docs] formats = DeploymentFormatList()
[docs]class DescribeComplexInputType(DescribeWithFormats): pass
[docs]class DeployComplexInputType(DeployWithFormats): pass
[docs]class SupportedCRS(ExtendedMappingSchema):
[docs] crs = URL(title="CRS", description="Coordinate Reference System")
[docs] default = ExtendedSchemaNode(Boolean(), missing=drop)
[docs]class SupportedCRSList(ExtendedSequenceSchema):
[docs] crs = SupportedCRS(title="SupportedCRS")
[docs]class BoundingBoxInputType(ExtendedMappingSchema):
[docs] supportedCRS = SupportedCRSList()
# FIXME: support byte/binary type (string + format:byte) ? # https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-core/binaryInputValue.yaml
[docs]class AnyLiteralType(OneOfKeywordSchema): """ Submitted values that correspond to literal data. .. seealso:: - :class:`AnyLiteralDataType` - :class:`AnyLiteralValueType` - :class:`AnyLiteralDefaultType` """
[docs] _one_of = [ ExtendedSchemaNode(Float(), description="Literal data type representing a floating point number."), ExtendedSchemaNode(Integer(), description="Literal data type representing an integer number."), ExtendedSchemaNode(Boolean(), description="Literal data type representing a boolean flag."), ExtendedSchemaNode(String(), description="Literal data type representing a generic string."),
]
[docs]class Number(OneOfKeywordSchema): """ Represents a literal number, integer or float. """
[docs] _one_of = [ ExtendedSchemaNode(Float()), ExtendedSchemaNode(Integer()),
]
[docs]class NumericType(OneOfKeywordSchema): """ Represents a numeric-like value. """
[docs] _one_of = [ ExtendedSchemaNode(Float()), ExtendedSchemaNode(Integer()), ExtendedSchemaNode(String(), pattern="^[0-9]+$"),
]
[docs]class DecimalType(ExtendedSchemaNode):
[docs] schema_type = colander.Decimal
[docs] format = "decimal"
[docs]class PositiveNumber(AnyOfKeywordSchema): """ Represents a literal number, integer or float, of positive value. """
[docs] _any_of = [ DecimalType(validator=Range(min=0.0)), ExtendedSchemaNode(Float(), validator=Range(min=0.0)), ExtendedSchemaNode(Integer(), validator=Range(min=0)),
]
[docs]class LiteralReference(ExtendedMappingSchema):
[docs] reference = ExecuteReferenceURL()
# https://github.com/opengeospatial/ogcapi-processes/blob/e6893b/extensions/workflows/openapi/workflows.yaml#L1707-L1716
[docs]class NameReferenceType(ExtendedMappingSchema):
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/nameReferenceType.yaml"
[docs] name = ExtendedSchemaNode(String())
[docs] reference = ExecuteReferenceURL(missing=drop, description="Reference URL to schema definition of the named entity.")
[docs]class DataTypeSchema(NameReferenceType):
[docs] description = "Type of the literal data representation."
[docs] title = "DataType"
# any named type that can be converted by: 'weaver.processes.convert.any2wps_literal_datatype'
[docs] name = ExtendedSchemaNode(String(), validator=OneOf(list(WPS_LITERAL_DATA_TYPES)))
[docs]class UomSchema(NameReferenceType):
[docs] title = "UnitOfMeasure"
# https://github.com/opengeospatial/ogcapi-processes/blob/e6893b/extensions/workflows/openapi/workflows.yaml#L1423 # NOTE: Original is only 'string', but we allow any literal type
[docs]class AllowedValuesList(ExtendedSequenceSchema):
[docs] value = AnyLiteralType()
# https://github.com/opengeospatial/ogcapi-processes/blob/e6893b/extensions/workflows/openapi/workflows.yaml#L1772-L1787 # NOTE: # Contrary to original schema where all fields are 'string', we allow any literal type as well since those make more # sense when parsing corresponding data values (eg: float, integer, bool).
[docs]class AllowedRange(ExtendedMappingSchema):
[docs] minimumValue = NumericType(missing=drop)
[docs] maximumValue = NumericType(missing=drop)
[docs] spacing = NumericType(missing=drop)
[docs] rangeClosure = ExtendedSchemaNode(String(), missing=drop, validator=OneOf(["closed", "open", "open-closed", "closed-open"]))
[docs]class AllowedRangesList(ExtendedSequenceSchema):
[docs] range = AllowedRange()
[docs]class AllowedValues(OneOfKeywordSchema):
[docs] _one_of = [ AllowedRangesList(description="List of value ranges and constraints."), # array of {range} AllowedValuesList(description="List of enumerated allowed values."), # array of "value" ExtendedSchemaNode(String(), description="Single allowed value."), # single "value"
] # https://github.com/opengeospatial/ogcapi-processes/blob/e6893b/extensions/workflows/openapi/workflows.yaml#L1425-L1430
[docs]class AnyValue(ExtendedMappingSchema):
[docs] anyValue = ExtendedSchemaNode( Boolean(), missing=drop, default=True, description="Explicitly indicate if any value is allowed. "
"This is the default behaviour if no other constrains are specified." ) # https://github.com/opengeospatial/ogcapi-processes/blob/e6893b/extensions/workflows/openapi/workflows.yaml#L1801-L1803
[docs]class ValuesReference(ExecuteReferenceURL):
[docs] description = "URL where to retrieve applicable values."
[docs]class ArrayLiteralType(ExtendedSequenceSchema):
[docs] value_item = AnyLiteralType()
[docs]class ArrayLiteralDataType(ExtendedMappingSchema):
[docs] data = ArrayLiteralType()
[docs]class ArrayLiteralValueType(ExtendedMappingSchema):
[docs] value = ArrayLiteralType()
[docs]class AnyLiteralDataType(ExtendedMappingSchema):
[docs] data = AnyLiteralType()
[docs]class AnyLiteralValueType(ExtendedMappingSchema):
[docs] value = AnyLiteralType()
[docs]class AnyLiteralDefaultType(ExtendedMappingSchema):
[docs] default = AnyLiteralType()
[docs]class LiteralDataValueDefinition(OneOfKeywordSchema):
[docs] _one_of = [ AllowedValues(description="Constraints of allowed values."), ValuesReference(description="Reference URL where to retrieve allowed values."), # 'AnyValue' must be last because it's the most permissive (always valid, default) AnyValue(description="Permissive definition for any allowed value."),
] # https://github.com/opengeospatial/ogcapi-processes/blob/e6893b/extensions/workflows/openapi/workflows.yaml#L1675-L1688 # literalDataDomain: # valueDefinition: oneOf(<allowedValues, anyValue, valuesReference>) # defaultValue: <string> # dataType: <nameReferenceType> # uom: <nameReferenceType>
[docs]class LiteralDataDomain(ExtendedMappingSchema):
[docs] default = ExtendedSchemaNode(Boolean(), default=True, description="Indicates if this literal data domain definition is the default one.")
[docs] defaultValue = AnyLiteralType(missing=drop, description="Default value to employ if none was provided.")
[docs] dataType = DataTypeSchema(missing=drop, description="Type name and reference of the literal data representation.")
[docs] uom = UomSchema(missing=drop, description="Unit of measure applicable for the data.")
[docs] valueDefinition = LiteralDataValueDefinition(description="Literal data domain constraints.")
[docs]class LiteralDataDomainList(ExtendedSequenceSchema): """ Constraints that apply to the literal data values. """
[docs] literalDataDomain = LiteralDataDomain()
# https://github.com/opengeospatial/ogcapi-processes/blob/e6893b/extensions/workflows/openapi/workflows.yaml#L1689-L1697
[docs]class LiteralDataType(NotKeywordSchema, ExtendedMappingSchema): # NOTE: # Apply 'missing=drop' although original schema of 'literalDataDomains' (see link above) requires it because # we support omitting it for minimalistic literal input definition. # This is because our schema validation allows us to do detection of 'basic' types using the literal parsing. # Because there is not explicit requirement though (ie: missing would fail schema validation), we must check # that 'format' is not present to avoid conflict with minimalistic literal data definition in case of ambiguity.
[docs] literalDataDomains = LiteralDataDomainList(missing=drop)
[docs] _not = [ DescribeWithFormats,
]
[docs]class LiteralInputType(LiteralDataType): pass
[docs]class DescribeInputTypeDefinition(OneOfKeywordSchema):
[docs] _one_of = [ # NOTE: # LiteralInputType could be used to represent a complex input if the 'format' is missing in # process description definition but is instead provided in CWL definition. # This use case is still valid because 'format' can be inferred from the combining Process/CWL contents. BoundingBoxInputType, DescribeComplexInputType, # should be 2nd to last because very permissive, but requires format at least LiteralInputType, # must be last because it's the most permissive (all can default if omitted)
]
[docs]class DeployInputTypeDefinition(OneOfKeywordSchema):
[docs] _one_of = [ # NOTE: # LiteralInputType could be used to represent a complex input if the 'format' is missing in # process deployment definition but is instead provided in CWL definition. # This use case is still valid because 'format' can be inferred from the combining Process/CWL contents. BoundingBoxInputType, DeployComplexInputType, # should be 2nd to last because very permissive, but requires formats at least LiteralInputType, # must be last because it's the most permissive (all can default if omitted)
]
[docs]class DescribeInputType(AllOfKeywordSchema):
[docs] _all_of = [ DescriptionType(), InputOutputDescriptionMeta(), InputOutputDescriptionSchema(), DescribeInputTypeDefinition(), DescribeMinMaxOccurs(), DescriptionExtra(),
]
[docs] _sort_first = PROCESS_IO_FIELD_FIRST
[docs] _sort_after = PROCESS_IO_FIELD_AFTER
[docs]class DescribeInputTypeWithID(InputIdentifierType, DescribeInputType):
[docs] title = "DescribeInputTypeWithID"
# Different definition than 'Describe' such that nested 'complex' type 'formats' can be validated and backward # compatible with pre-existing/deployed/remote processes, with either ``mediaType`` and ``mimeType`` formats.
[docs]class DeployInputType(AllOfKeywordSchema):
[docs] _all_of = [ DeploymentType(), InputOutputDescriptionMeta(), InputOutputDescriptionSchema(), DeployInputTypeDefinition(), DeployMinMaxOccurs(), DescriptionExtra(),
]
[docs] _sort_first = PROCESS_IO_FIELD_FIRST
[docs] _sort_after = PROCESS_IO_FIELD_AFTER
[docs]class DeployInputTypeWithID(InputIdentifierType, DeployInputType): pass
# for [{id: "", ...}] representation within ProcessDescription (OLD schema)
[docs]class DescribeInputTypeList(ExtendedSequenceSchema): """ Listing of process inputs descriptions. """
[docs] input = DescribeInputTypeWithID()
# for {"<id>": {...}} representation within ProcessDescription (OGC schema)
[docs]class DescribeInputTypeMap(PermissiveMappingSchema): """ Description of all process inputs under mapping. """
[docs] input_id = DescribeInputType( variable="{input-id}", description="Input definition under mapping of process description.", missing=drop, # allowed because process can have empty inputs (see schema: ProcessDescriptionOGC)
) # for [{id: "", ...}] representation within ProcessDeployment (OLD schema)
[docs]class DeployInputTypeList(ExtendedSequenceSchema): """ Listing of process input definitions to deploy. """
[docs] input_item = DeployInputTypeWithID()
# for {"<id>": {...}} representation within ProcessDeployment (OGC schema)
[docs]class DeployInputTypeMap(PermissiveMappingSchema): """ Definition of all process inputs under mapping. """
[docs] input_id = DeployInputType( variable="{input-id}", description="Input definition under mapping of process deployment."
)
[docs]class DeployInputTypeAny(OneOfKeywordSchema):
[docs] _one_of = [ DeployInputTypeList(), DeployInputTypeMap(),
]
[docs]class LiteralOutputType(LiteralDataType): pass
[docs]class BoundingBoxOutputType(ExtendedMappingSchema):
[docs] supportedCRS = SupportedCRSList()
[docs]class DescribeComplexOutputType(DescribeWithFormats): pass
[docs]class DeployComplexOutputType(DeployWithFormats): pass
[docs]class DescribeOutputTypeDefinition(OneOfKeywordSchema):
[docs] _one_of = [ BoundingBoxOutputType, DescribeComplexOutputType, # should be 2nd to last because very permissive, but requires formats at least LiteralOutputType, # must be last because it's the most permissive (all can default if omitted)
]
[docs]class DeployOutputTypeDefinition(OneOfKeywordSchema):
[docs] _one_of = [ BoundingBoxOutputType, DeployComplexOutputType, # should be 2nd to last because very permissive, but requires formats at least LiteralOutputType, # must be last because it's the most permissive (all can default if omitted)
]
[docs]class DescribeOutputType(AllOfKeywordSchema):
[docs] _all_of = [ DescriptionType(), InputOutputDescriptionMeta(), InputOutputDescriptionSchema(), DescribeOutputTypeDefinition(),
]
[docs] _sort_first = PROCESS_IO_FIELD_FIRST
[docs] _sort_after = PROCESS_IO_FIELD_AFTER
[docs]class DescribeOutputTypeWithID(OutputIdentifierType, DescribeOutputType): pass
[docs]class DescribeOutputTypeList(ExtendedSequenceSchema): """ Listing of process outputs descriptions. """
[docs] output = DescribeOutputTypeWithID()
# for {"<id>": {...}} representation within ProcessDescription (OGC schema)
[docs]class DescribeOutputTypeMap(PermissiveMappingSchema): """ Definition of all process outputs under mapping. """
[docs] output_id = DescribeOutputType( variable="{output-id}", title="ProcessOutputDefinition", description="Output definition under mapping of process description."
) # Different definition than 'Describe' such that nested 'complex' type 'formats' can be validated and backward # compatible with pre-existing/deployed/remote processes, with either ``mediaType`` and ``mimeType`` formats.
[docs]class DeployOutputType(AllOfKeywordSchema):
[docs] _all_of = [ DeploymentType(), InputOutputDescriptionMeta(), InputOutputDescriptionSchema(), DeployOutputTypeDefinition(),
]
[docs] _sort_first = PROCESS_IO_FIELD_FIRST
[docs] _sort_after = PROCESS_IO_FIELD_AFTER
[docs]class DeployOutputTypeWithID(OutputIdentifierType, DeployOutputType): pass
# for [{id: "", ...}] representation within ProcessDeployment (OLD schema)
[docs]class DeployOutputTypeList(ExtendedSequenceSchema): """ Listing of process output definitions to deploy. """
[docs] input = DeployOutputTypeWithID()
# for {"<id>": {...}} representation within ProcessDeployment (OGC schema)
[docs]class DeployOutputTypeMap(PermissiveMappingSchema): """ Definition of all process outputs under mapping. """
[docs] input_id = DeployOutputType( variable="{input-id}", description="Output definition under mapping of process deployment."
)
[docs]class DeployOutputTypeAny(OneOfKeywordSchema):
[docs] _one_of = [ DeployOutputTypeList, DeployOutputTypeMap,
]
[docs]class JobExecuteModeEnum(ExtendedSchemaNode): # _schema: none available by itself, legacy parameter that was directly embedded in 'execute.yaml' # (https://github.com/opengeospatial/ogcapi-processes/blob/1.0-draft.5/core/openapi/schemas/execute.yaml)
[docs] schema_type = String
[docs] title = "JobExecuteMode"
# no default to enforce required input as per OGC-API schemas # default = EXECUTE_MODE_AUTO
[docs] example = ExecuteMode.ASYNC
[docs] validator = OneOf(ExecuteMode.values())
[docs]class JobControlOptionsEnum(ExtendedSchemaNode):
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/jobControlOptions.yaml"
[docs] schema_type = String
[docs] title = "JobControlOptions"
[docs] default = ExecuteControlOption.ASYNC
[docs] example = ExecuteControlOption.ASYNC
[docs] validator = OneOf(ExecuteControlOption.values())
[docs]class JobResponseOptionsEnum(ExtendedSchemaNode): # _schema: none available by itself, legacy parameter that was directly embedded in 'execute.yaml' # (https://github.com/opengeospatial/ogcapi-processes/blob/1.0-draft.6/core/openapi/schemas/execute.yaml)
[docs] schema_type = String
[docs] title = "JobResponseOptions"
# no default to enforce required input as per OGC-API schemas # default = ExecuteResponse.DOCUMENT
[docs] example = ExecuteResponse.DOCUMENT
[docs] validator = OneOf(ExecuteResponse.values())
[docs]class TransmissionModeEnum(ExtendedSchemaNode):
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/transmissionMode.yaml"
[docs] schema_type = String
[docs] title = "TransmissionMode"
[docs] default = ExecuteTransmissionMode.VALUE
[docs] example = ExecuteTransmissionMode.VALUE
[docs] validator = OneOf(ExecuteTransmissionMode.values())
[docs]class JobStatusEnum(ExtendedSchemaNode):
[docs] _schema = f"{OGC_API_PROC_PART1_PARAMETERS}/status.yaml" # subset of this implementation
[docs] schema_type = String
[docs] title = "JobStatus"
[docs] default = Status.ACCEPTED
[docs] example = Status.ACCEPTED
[docs] validator = OneOf(JOB_STATUS_CODE_API)
[docs]class JobStatusSearchEnum(ExtendedSchemaNode):
[docs] schema_type = String
[docs] title = "JobStatusSearch"
[docs] default = Status.ACCEPTED
[docs] example = Status.ACCEPTED
[docs] validator = StringOneOf(JOB_STATUS_SEARCH_API, delimiter=",", case_sensitive=False)
[docs]class JobTypeEnum(ExtendedSchemaNode):
[docs] _schema = f"{OGC_API_PROC_PART1_PARAMETERS}/type.yaml" # subset of this implementation
[docs] schema_type = String
[docs] title = "JobType"
[docs] default = null
[docs] example = "process"
[docs] validator = OneOf(["process", "provider", "service"])
[docs]class JobSortEnum(ExtendedSchemaNode):
[docs] schema_type = String
[docs] title = "JobSortingMethod"
[docs] default = Sort.CREATED
[docs] example = Sort.CREATED
[docs] validator = OneOf(SortMethods.JOB)
[docs]class ProcessSortEnum(ExtendedSchemaNode):
[docs] schema_type = String
[docs] title = "ProcessSortMethod"
[docs] default = Sort.ID
[docs] example = Sort.CREATED
[docs] validator = OneOf(SortMethods.PROCESS)
[docs]class QuoteSortEnum(ExtendedSchemaNode):
[docs] schema_type = String
[docs] title = "QuoteSortingMethod"
[docs] default = Sort.ID
[docs] example = Sort.PROCESS
[docs] validator = OneOf(SortMethods.QUOTE)
[docs]class JobTagsCommaSeparated(ExpandStringList, ExtendedSchemaNode):
[docs] schema_type = String
[docs] validator = CommaSeparated()
[docs] default = None
[docs] missing = drop
[docs] description = ( "Comma-separated tags that can be used to filter jobs. "
f"Only {validator.allow_chars} characters are permitted." )
[docs]class JobGroupsCommaSeparated(ExpandStringList, ExtendedSchemaNode):
[docs] schema_type = String
[docs] default = None
[docs] example = "process,service"
[docs] missing = drop
[docs] description = "Comma-separated list of grouping fields with which to list jobs."
[docs] validator = StringOneOf(["process", "provider", "service", "status"], delimiter=",", case_sensitive=True)
[docs]class LaunchJobQuerystring(ExtendedMappingSchema):
[docs] tags = JobTagsCommaSeparated()
[docs]class VisibilityValue(ExtendedSchemaNode):
[docs] schema_type = String
[docs] validator = OneOf(Visibility.values())
[docs] example = Visibility.PUBLIC
[docs]class JobAccess(VisibilityValue): pass
[docs]class VisibilitySchema(ExtendedMappingSchema):
[docs] value = VisibilityValue()
[docs]class QuoteEstimatorConfigurationSchema(ExtendedMappingSchema):
[docs] _schema = f"{WEAVER_SCHEMA_URL}/quotation/quote-estimator.yaml#/definitions/Configuration"
[docs] description = "Quote Estimator Configuration"
[docs] def deserialize(self, cstruct): schema = ExtendedMappingSchema(_schema=self._schema) # avoid recursion return validate_node_schema(schema, cstruct)
[docs]class QuoteEstimatorWeightedParameterSchema(ExtendedMappingSchema): # NOTE: # value/size parameters omitted since they will be provided at runtime by the # quote estimation job obtained from submitted body in 'QuoteProcessParametersSchema'
[docs] weight = ExtendedSchemaNode( Float(), default=1.0, missing=drop, description="Weight attributed to this parameter when submitted for quote estimation.",
)
[docs]class QuoteEstimatorInputParametersSchema(ExtendedMappingSchema):
[docs] description = "Parametrization of inputs for quote estimation."
[docs] input_id = QuoteEstimatorWeightedParameterSchema( variable="{input-id}", title="QuoteEstimatorInputParameters", description="Mapping of input definitions for quote estimation.", missing=drop, # because only weight expected, if missing/invalid, ignore mapping (1.0 applied by default later)
)
[docs]class QuoteEstimatorOutputParametersSchema(ExtendedMappingSchema):
[docs] description = "Parametrization of outputs for quote estimation."
[docs] output_id = QuoteEstimatorWeightedParameterSchema( variable="{output-id}", title="QuoteEstimatorOutputParameters", description="Mapping of output definitions for quote estimation.", missing=drop, # because only weight expected, if missing/invalid, ignore mapping (1.0 applied by default later)
)
[docs]class QuoteEstimatorSchema(ExtendedMappingSchema):
[docs] _schema = f"{WEAVER_SCHEMA_URL}/quotation/quote-estimator.yaml"
[docs] description = "Configuration of the quote estimation algorithm for a given process."
[docs] config = QuoteEstimatorConfigurationSchema()
[docs] inputs = QuoteEstimatorInputParametersSchema(missing=drop, default={})
[docs] outputs = QuoteEstimatorOutputParametersSchema(missing=drop, default={})
######################################################### # Path parameter definitions #########################################################
[docs]class LocalProcessQuery(ExtendedMappingSchema):
[docs] version = Version(example="1.2.3", missing=drop, description=( "Specific process version to locate. "
"If process ID was requested with tagged 'id:version' revision format, this parameter is ignored." ))
[docs]class LocalProcessPath(ExtendedMappingSchema):
[docs] process_id = ProcessIdentifierTag( example="jsonarray2netcdf[:1.0.0]", summary="Process identifier with optional tag version.", description=( "Process identifier with optional tag version. "
"If tag is omitted, the latest version of that process is assumed. " "Otherwise, the specific process revision as 'id:version' must be matched. " "Alternatively, the plain process ID can be specified in combination to 'version' query parameter." ), )
[docs]class ProviderPath(ExtendedMappingSchema):
[docs] provider_id = AnyIdentifier(description="Remote provider identifier.", example="hummingbird")
[docs]class ProviderProcessPath(ProviderPath): # note: Tag representation not allowed in this case
[docs] process_id = ProcessIdentifier(example="provider-process", description=( "Identifier of a process that is offered by the remote provider."
))
[docs]class JobPath(ExtendedMappingSchema):
[docs] job_id = UUID(description="Job ID", example="14c68477-c3ed-4784-9c0f-a4c9e1344db5")
[docs]class BillPath(ExtendedMappingSchema):
[docs] bill_id = UUID(description="Bill ID")
[docs]class QuotePath(ExtendedMappingSchema):
[docs] quote_id = UUID(description="Quote ID")
[docs]class ResultPath(ExtendedMappingSchema):
[docs] result_id = UUID(description="Result ID")
######################################################### # These classes define each of the endpoints parameters #########################################################
[docs]class FrontpageEndpoint(ExtendedMappingSchema):
[docs] header = RequestHeaders()
[docs]class VersionsEndpoint(ExtendedMappingSchema):
[docs] header = RequestHeaders()
[docs]class ConformanceQueries(ExtendedMappingSchema):
[docs] category = ExtendedSchemaNode( String(), missing=drop, default=ConformanceCategory.CONFORMANCE, validator=OneOf(ConformanceCategory.values()), description="Select the desired conformance item references to be returned."
)
[docs]class ConformanceEndpoint(ExtendedMappingSchema):
[docs] header = RequestHeaders()
[docs] querystring = ConformanceQueries()
# FIXME: support YAML (https://github.com/crim-ca/weaver/issues/456)
[docs]class OpenAPIAcceptHeader(AcceptHeader):
[docs] default = ContentType.APP_OAS_JSON
[docs] validator = OneOf([ContentType.APP_OAS_JSON, ContentType.APP_JSON])
[docs]class OpenAPIRequestHeaders(RequestHeaders):
[docs] accept = OpenAPIAcceptHeader()
[docs]class OpenAPIEndpoint(ExtendedMappingSchema):
[docs] header = OpenAPIRequestHeaders()
[docs]class SwaggerUIEndpoint(ExtendedMappingSchema): pass
[docs]class RedocUIEndpoint(ExtendedMappingSchema): pass
[docs]class OWSNamespace(XMLObject):
[docs] prefix = "ows"
[docs] namespace = "http://www.opengis.net/ows/1.1"
[docs]class WPSNamespace(XMLObject):
[docs] prefix = "wps"
[docs] namespace = "http://www.opengis.net/wps/1.0.0"
[docs]class XMLNamespace(XMLObject):
[docs] prefix = "xml"
[docs]class XMLReferenceAttribute(ExtendedSchemaNode, XMLObject):
[docs] schema_type = String
[docs] attribute = True
[docs] name = "href"
[docs] prefix = "xlink"
[docs] format = "url"
[docs]class MimeTypeAttribute(ExtendedSchemaNode, XMLObject):
[docs] schema_type = String
[docs] attribute = True
[docs] name = "mimeType"
[docs] prefix = drop
[docs] example = ContentType.APP_JSON
[docs]class EncodingAttribute(ExtendedSchemaNode, XMLObject):
[docs] schema_type = String
[docs] attribute = True
[docs] name = "encoding"
[docs] prefix = drop
[docs] example = "UTF-8"
[docs]class OWSVersion(ExtendedSchemaNode, OWSNamespace):
[docs] schema_type = String
[docs] name = "Version"
[docs] default = "1.0.0"
[docs] example = "1.0.0"
[docs]class OWSAcceptVersions(ExtendedSequenceSchema, OWSNamespace):
[docs] description = "Accepted versions to produce the response."
[docs] name = "AcceptVersions"
[docs] item = OWSVersion()
[docs]class OWSLanguage(ExtendedSchemaNode, OWSNamespace):
[docs] description = "Desired language to produce the response."
[docs] schema_type = String
[docs] name = "Language"
[docs] default = AcceptLanguage.EN_US
[docs] example = AcceptLanguage.EN_CA
[docs]class OWSLanguageAttribute(OWSLanguage):
[docs] description = "RFC-4646 language code of the human-readable text."
[docs] name = "language"
[docs] attribute = True
[docs]class OWSService(ExtendedSchemaNode, OWSNamespace):
[docs] description = "Desired service to produce the response (SHOULD be 'WPS')."
[docs] schema_type = String
[docs] name = "service"
[docs] attribute = True
[docs] default = AcceptLanguage.EN_US
[docs] example = AcceptLanguage.EN_CA
[docs]class WPSServiceAttribute(ExtendedSchemaNode, XMLObject):
[docs] schema_type = String
[docs] name = "service"
[docs] attribute = True
[docs] default = "WPS"
[docs] example = "WPS"
[docs]class WPSVersionAttribute(ExtendedSchemaNode, XMLObject):
[docs] schema_type = String
[docs] name = "version"
[docs] attribute = True
[docs] default = "1.0.0"
[docs] example = "1.0.0"
[docs]class WPSLanguageAttribute(ExtendedSchemaNode, XMLNamespace):
[docs] schema_type = String
[docs] name = "lang"
[docs] attribute = True
[docs] default = AcceptLanguage.EN_US
[docs] example = AcceptLanguage.EN_CA
[docs]class WPSParameters(ExtendedMappingSchema):
[docs] service = ExtendedSchemaNode(String(), example="WPS", description="Service selection.", validator=OneOfCaseInsensitive(["WPS"]))
[docs] request = ExtendedSchemaNode(String(), example="GetCapabilities", description="WPS operation to accomplish", validator=OneOfCaseInsensitive(["GetCapabilities", "DescribeProcess", "Execute"]))
[docs] version = Version(exaple="1.0.0", default="1.0.0", validator=OneOf(["1.0.0", "2.0.0", "2.0"]))
[docs] identifier = ExtendedSchemaNode(String(), exaple="hello", missing=drop, example="example-process,another-process", description="Single or comma-separated list of process identifiers to describe, "
"and single one for execution.")
[docs] data_inputs = ExtendedSchemaNode(String(), name="DataInputs", missing=drop, example="message=hi&names=user1,user2&value=1", description="Process execution inputs provided as Key-Value Pairs (KVP).")
[docs]class WPSOperationGetNoContent(ExtendedMappingSchema):
[docs] description = "No content body provided (GET requests)."
[docs] default = {}
[docs]class WPSOperationPost(ExtendedMappingSchema):
[docs] _schema = "http://schemas.opengis.net/wps/1.0.0/common/RequestBaseType.xsd"
[docs] accepted_versions = OWSAcceptVersions(missing=drop, default="1.0.0")
[docs] language = OWSLanguageAttribute(missing=drop)
[docs] service = OWSService()
[docs]class WPSGetCapabilitiesPost(WPSOperationPost, WPSNamespace):
[docs] _schema = "http://schemas.opengis.net/wps/1.0.0/wpsGetCapabilities_request.xsd"
[docs] name = "GetCapabilities"
[docs] title = "GetCapabilities"
[docs]class OWSIdentifier(ExtendedSchemaNode, OWSNamespace):
[docs] schema_type = String
[docs] name = "Identifier"
[docs]class OWSIdentifierList(ExtendedSequenceSchema, OWSNamespace):
[docs] name = "Identifiers"
[docs] item = OWSIdentifier()
[docs]class OWSTitle(ExtendedSchemaNode, OWSNamespace):
[docs] schema_type = String
[docs] name = "Title"
[docs]class OWSAbstract(ExtendedSchemaNode, OWSNamespace):
[docs] schema_type = String
[docs] name = "Abstract"
[docs]class OWSMetadata(ExtendedSequenceSchema, OWSNamespace):
[docs] schema_type = String
[docs] name = "Metadata"
[docs] title = OWSMetadataLink(missing=drop)
[docs]class WPSDescribeProcessPost(WPSOperationPost, WPSNamespace):
[docs] _schema = "http://schemas.opengis.net/wps/1.0.0/wpsDescribeProcess_request.xsd"
[docs] name = "DescribeProcess"
[docs] title = "DescribeProcess"
[docs] identifier = OWSIdentifierList( description="Single or comma-separated list of process identifier to describe.", example="example"
)
[docs]class WPSExecuteDataInputs(ExtendedMappingSchema, WPSNamespace):
[docs] description = "XML data inputs provided for WPS POST request (Execute)."
[docs] name = "DataInputs"
[docs] title = "DataInputs"
# FIXME: missing details about 'DataInputs'
[docs]class WPSExecutePost(WPSOperationPost, WPSNamespace):
[docs] _schema = "http://schemas.opengis.net/wps/1.0.0/wpsExecute_request.xsd"
[docs] name = "Execute"
[docs] title = "Execute"
[docs] identifier = OWSIdentifier(description="Identifier of the process to execute with data inputs.")
[docs] dataInputs = WPSExecuteDataInputs(description="Data inputs to be provided for process execution.")
[docs]class WPSRequestBody(OneOfKeywordSchema):
[docs] _one_of = [ WPSExecutePost(), WPSDescribeProcessPost(), WPSGetCapabilitiesPost(),
]
[docs] examples = { "Execute": { "summary": "Execute request example.", "value": EXAMPLES["wps_execute_request.xml"]
} }
[docs]class WPSHeaders(ExtendedMappingSchema):
[docs] accept = AcceptHeader(missing=drop)
[docs]class WPSEndpointGet(ExtendedMappingSchema):
[docs] header = WPSHeaders()
[docs] querystring = WPSParameters()
[docs] body = WPSOperationGetNoContent(missing=drop)
[docs]class WPSEndpointPost(ExtendedMappingSchema):
[docs] header = WPSHeaders()
[docs] body = WPSRequestBody()
[docs]class XMLBooleanAttribute(ExtendedSchemaNode, XMLObject):
[docs] schema_type = Boolean
[docs] attribute = True
[docs]class XMLString(ExtendedSchemaNode, XMLObject):
[docs] schema_type = String
[docs]class OWSString(ExtendedSchemaNode, OWSNamespace):
[docs] schema_type = String
[docs]class OWSKeywordList(ExtendedSequenceSchema, OWSNamespace):
[docs] title = "OWSKeywords"
[docs] keyword = OWSString(name="Keyword", title="OWSKeyword", example="Weaver")
[docs]class OWSType(ExtendedMappingSchema, OWSNamespace):
[docs] schema_type = String
[docs] name = "Type"
[docs] example = "theme"
[docs] additionalProperties = { "codeSpace": { "type": "string", "example": "ISOTC211/19115", "xml": {"attribute": True}
} }
[docs]class OWSPhone(ExtendedMappingSchema, OWSNamespace):
[docs] name = "Phone"
[docs] voice = OWSString(name="Voice", title="OWSVoice", example="1-234-567-8910", missing=drop)
[docs] facsimile = OWSString(name="Facsimile", title="OWSFacsimile", missing=drop)
[docs]class OWSAddress(ExtendedMappingSchema, OWSNamespace):
[docs] name = "Address"
[docs] delivery_point = OWSString(name="DeliveryPoint", title="OWSDeliveryPoint", example="123 Place Street", missing=drop)
[docs] city = OWSString(name="City", title="OWSCity", example="Nowhere", missing=drop)
[docs] country = OWSString(name="Country", title="OWSCountry", missing=drop)
[docs] admin_area = OWSString(name="AdministrativeArea", title="AdministrativeArea", missing=drop)
[docs] postal_code = OWSString(name="PostalCode", title="OWSPostalCode", example="A1B 2C3", missing=drop)
[docs] email = OWSString(name="ElectronicMailAddress", title="OWSElectronicMailAddress", example="mail@me.com", validator=Email, missing=drop)
[docs]class OWSContactInfo(ExtendedMappingSchema, OWSNamespace):
[docs] name = "ContactInfo"
[docs] phone = OWSPhone(missing=drop)
[docs] address = OWSAddress(missing=drop)
[docs]class OWSServiceContact(ExtendedMappingSchema, OWSNamespace):
[docs] name = "ServiceContact"
[docs] individual = OWSString(name="IndividualName", title="OWSIndividualName", example="John Smith", missing=drop)
[docs] position = OWSString(name="PositionName", title="OWSPositionName", example="One-Man Team", missing=drop)
[docs] contact = OWSContactInfo(missing=drop, default={})
[docs]class OWSServiceProvider(ExtendedMappingSchema, OWSNamespace):
[docs] description = "Details about the institution providing the service."
[docs] name = "ServiceProvider"
[docs] title = "ServiceProvider"
[docs] provider_name = OWSString(name="ProviderName", title="OWSProviderName", example="EXAMPLE")
[docs] provider_site = OWSString(name="ProviderName", title="OWSProviderName", example="http://schema-example.com")
[docs] contact = OWSServiceContact(required=False, defalult={})
[docs]class WPSDescriptionType(ExtendedMappingSchema, OWSNamespace):
[docs] _schema = "http://schemas.opengis.net/wps/1.0.0/common/DescriptionType.xsd"
[docs] name = "DescriptionType"
[docs] _title = OWSTitle(description="Title of the service.", example="Weaver")
[docs] abstract = OWSAbstract(description="Detail about the service.", example="Weaver WPS example schema.", missing=drop)
[docs] metadata = OWSMetadata(description="Metadata of the service.", example="Weaver WPS example schema.", missing=drop)
[docs]class OWSServiceIdentification(WPSDescriptionType, OWSNamespace):
[docs] name = "ServiceIdentification"
[docs] title = "ServiceIdentification"
[docs] keywords = OWSKeywordList(name="Keywords")
[docs] type = OWSType()
[docs] svc_type = OWSString(name="ServiceType", title="ServiceType", example="WPS")
[docs] svc_type_ver1 = OWSString(name="ServiceTypeVersion", title="ServiceTypeVersion", example="1.0.0")
[docs] svc_type_ver2 = OWSString(name="ServiceTypeVersion", title="ServiceTypeVersion", example="2.0.0")
[docs] fees = OWSString(name="Fees", title="Fees", example="NONE", missing=drop, default="NONE")
[docs] access = OWSString(name="AccessConstraints", title="AccessConstraints", example="NONE", missing=drop, default="NONE")
[docs] provider = OWSServiceProvider()
[docs]class OWSOperationName(ExtendedSchemaNode, OWSNamespace):
[docs] schema_type = String
[docs] attribute = True
[docs] name = "name"
[docs] example = "GetCapabilities"
[docs] validator = OneOf(["GetCapabilities", "DescribeProcess", "Execute"])
[docs]class OperationRequest(ExtendedMappingSchema, OWSNamespace):
[docs] href = OperationLink()
[docs]class OWS_HTTP(ExtendedMappingSchema, OWSNamespace): # noqa: N802
[docs] get = OperationRequest(name="Get", title="OWSGet")
[docs] post = OperationRequest(name="Post", title="OWSPost")
[docs]class OWS_DCP(ExtendedMappingSchema, OWSNamespace): # noqa: N802
[docs] http = OWS_HTTP(name="HTTP", missing=drop)
[docs] https = OWS_HTTP(name="HTTPS", missing=drop)
[docs]class Operation(ExtendedMappingSchema, OWSNamespace):
[docs] name = OWSOperationName()
[docs] dcp = OWS_DCP()
[docs]class OperationsMetadata(ExtendedSequenceSchema, OWSNamespace):
[docs] name = "OperationsMetadata"
[docs] op = Operation()
[docs]class ProcessVersion(ExtendedSchemaNode, WPSNamespace):
[docs] schema_type = String
[docs] attribute = True
[docs]class OWSProcessSummary(ExtendedMappingSchema, WPSNamespace):
[docs] version = ProcessVersion(name="processVersion", default="None", example="1.2", description="Version of the corresponding process summary.")
[docs] identifier = OWSIdentifier(example="example", description="Identifier to refer to the process.")
[docs] _title = OWSTitle(example="Example Process", description="Title of the process.")
[docs] abstract = OWSAbstract(example="Process for example schema.", description="Detail about the process.")
[docs]class WPSProcessOfferings(ExtendedSequenceSchema, WPSNamespace):
[docs] name = "ProcessOfferings"
[docs] title = "ProcessOfferings"
[docs] process = OWSProcessSummary(name="Process")
[docs]class WPSLanguagesType(ExtendedSequenceSchema, WPSNamespace):
[docs] title = "LanguagesType"
[docs] wrapped = False
[docs] lang = OWSLanguage(name="Language")
[docs]class WPSLanguageSpecification(ExtendedMappingSchema, WPSNamespace):
[docs] name = "Languages"
[docs] title = "Languages"
[docs] default = OWSLanguage(name="Default")
[docs] supported = WPSLanguagesType(name="Supported")
[docs]class WPSResponseBaseType(PermissiveMappingSchema, WPSNamespace):
[docs] _schema = "http://schemas.opengis.net/wps/1.0.0/common/ResponseBaseType.xsd"
[docs] service = WPSServiceAttribute()
[docs] version = WPSVersionAttribute()
[docs] lang = WPSLanguageAttribute()
[docs]class WPSProcessVersion(ExtendedSchemaNode, WPSNamespace):
[docs] _schema = "http://schemas.opengis.net/wps/1.0.0/common/ProcessVersion.xsd"
[docs] schema_type = String
[docs] description = "Release version of this Process."
[docs] name = "processVersion"
[docs] attribute = True
[docs]class WPSInputDescriptionType(WPSDescriptionType):
[docs] identifier = OWSIdentifier(description="Unique identifier of the input.")
# override below to have different examples/descriptions
[docs] _title = OWSTitle(description="Human-readable representation of the process input.")
[docs] abstract = OWSAbstract(missing=drop)
[docs] metadata = OWSMetadata(missing=drop)
[docs]class WPSLiteralInputType(ExtendedMappingSchema, XMLObject): pass
[docs]class WPSLiteralData(WPSLiteralInputType):
[docs] name = "LiteralData"
[docs]class WPSCRSsType(ExtendedMappingSchema, WPSNamespace):
[docs] crs = XMLString(name="CRS", description="Coordinate Reference System")
[docs]class WPSSupportedCRS(ExtendedSequenceSchema):
[docs] crs = WPSCRSsType(name="CRS")
[docs]class WPSSupportedCRSType(ExtendedMappingSchema, WPSNamespace):
[docs] name = "SupportedCRSsType"
[docs] default = WPSCRSsType(name="Default")
[docs] supported = WPSSupportedCRS(name="Supported")
[docs]class WPSBoundingBoxData(ExtendedMappingSchema, XMLObject):
[docs] data = WPSSupportedCRSType(name="BoundingBoxData")
[docs]class WPSFormatDefinition(ExtendedMappingSchema, XMLObject):
[docs] mime_type = XMLString(name="MimeType", default=ContentType.TEXT_PLAIN, example=ContentType.TEXT_PLAIN)
[docs] encoding = XMLString(name="Encoding", missing=drop, example="base64")
[docs] schema = XMLString(name="Schema", missing=drop)
[docs]class WPSFileFormat(ExtendedMappingSchema, XMLObject):
[docs] name = "Format"
[docs] format_item = WPSFormatDefinition()
[docs]class WPSFormatList(ExtendedSequenceSchema):
[docs] format_item = WPSFileFormat()
[docs]class WPSComplexInputType(ExtendedMappingSchema, WPSNamespace):
[docs] max_mb = XMLString(name="maximumMegabytes", attribute=True)
[docs] defaults = WPSFileFormat(name="Default")
[docs] supported = WPSFormatList(name="Supported")
[docs]class WPSComplexData(ExtendedMappingSchema, XMLObject):
[docs] data = WPSComplexInputType(name="ComplexData")
[docs]class WPSInputFormChoice(OneOfKeywordSchema):
[docs] title = "InputFormChoice"
[docs] _one_of = [ WPSComplexData(), WPSLiteralData(), WPSBoundingBoxData(),
]
[docs]class WPSMinOccursAttribute(MinOccursDefinition, XMLObject):
[docs] name = "minOccurs"
[docs] attribute = True
[docs]class WPSMaxOccursAttribute(MinOccursDefinition, XMLObject):
[docs] name = "maxOccurs"
[docs] prefix = drop
[docs] attribute = True
[docs]class WPSDataInputDescription(ExtendedMappingSchema):
[docs] min_occurs = WPSMinOccursAttribute()
[docs] max_occurs = WPSMaxOccursAttribute()
[docs]class WPSDataInputItem(AllOfKeywordSchema, WPSNamespace):
[docs] _all_of = [ WPSInputDescriptionType(), WPSInputFormChoice(), WPSDataInputDescription(),
]
[docs]class WPSDataInputs(ExtendedSequenceSchema, WPSNamespace):
[docs] name = "DataInputs"
[docs] title = "DataInputs"
[docs] input = WPSDataInputItem()
[docs]class WPSOutputDescriptionType(WPSDescriptionType):
[docs] name = "OutputDescriptionType"
[docs] title = "OutputDescriptionType"
[docs] identifier = OWSIdentifier(description="Unique identifier of the output.")
# override below to have different examples/descriptions
[docs] _title = OWSTitle(description="Human-readable representation of the process output.")
[docs] abstract = OWSAbstract(missing=drop)
[docs] metadata = OWSMetadata(missing=drop)
[docs]class ProcessOutputs(ExtendedSequenceSchema, WPSNamespace):
[docs] name = "ProcessOutputs"
[docs] title = "ProcessOutputs"
[docs] output = WPSOutputDescriptionType()
[docs]class WPSGetCapabilities(WPSResponseBaseType):
[docs] _schema = "http://schemas.opengis.net/wps/1.0.0/wpsGetCapabilities_response.xsd"
[docs] name = "Capabilities"
[docs] title = "Capabilities" # not to be confused by 'GetCapabilities' used for request
[docs] svc = OWSServiceIdentification()
[docs] ops = OperationsMetadata()
[docs] offering = WPSProcessOfferings()
[docs] languages = WPSLanguageSpecification()
[docs]class WPSProcessDescriptionType(WPSResponseBaseType, WPSProcessVersion):
[docs] name = "ProcessDescriptionType"
[docs] description = "Description of the requested process by identifier."
[docs] store = XMLBooleanAttribute(name="storeSupported", example=True, default=True)
[docs] status = XMLBooleanAttribute(name="statusSupported", example=True, default=True)
[docs] inputs = WPSDataInputs()
[docs] outputs = ProcessOutputs()
[docs]class WPSProcessDescriptionList(ExtendedSequenceSchema, WPSNamespace):
[docs] name = "ProcessDescriptions"
[docs] title = "ProcessDescriptions"
[docs] description = "Listing of process description for every requested identifier."
[docs] wrapped = False
[docs] process = WPSProcessDescriptionType()
[docs]class WPSDescribeProcess(WPSResponseBaseType):
[docs] _schema = "http://schemas.opengis.net/wps/1.0.0/wpsDescribeProcess_response.xsd"
[docs] name = "DescribeProcess"
[docs] title = "DescribeProcess"
[docs] process = WPSProcessDescriptionList()
[docs]class WPSStatusLocationAttribute(ExtendedSchemaNode, XMLObject):
[docs] schema_type = String
[docs] name = "statusLocation"
[docs] prefix = drop
[docs] attribute = True
[docs] format = "file"
[docs]class WPSServiceInstanceAttribute(ExtendedSchemaNode, XMLObject):
[docs] schema_type = String
[docs] name = "serviceInstance"
[docs] prefix = drop
[docs] attribute = True
[docs] format = "url"
[docs]class CreationTimeAttribute(ExtendedSchemaNode, XMLObject):
[docs] schema_type = DateTime
[docs] name = "creationTime"
[docs] title = "CreationTime"
[docs] prefix = drop
[docs] attribute = True
[docs]class WPSStatusSuccess(ExtendedSchemaNode, WPSNamespace):
[docs] schema_type = String
[docs] name = "ProcessSucceeded"
[docs] title = "ProcessSucceeded"
[docs]class WPSStatusFailed(ExtendedSchemaNode, WPSNamespace):
[docs] schema_type = String
[docs] name = "ProcessFailed"
[docs] title = "ProcessFailed"
[docs]class WPSStatus(ExtendedMappingSchema, WPSNamespace):
[docs] name = "Status"
[docs] title = "Status"
[docs] creationTime = CreationTimeAttribute()
[docs] status_success = WPSStatusSuccess(missing=drop)
[docs] status_failed = WPSStatusFailed(missing=drop)
[docs]class WPSProcessSummary(ExtendedMappingSchema, WPSNamespace):
[docs] name = "Process"
[docs] title = "Process"
[docs] identifier = OWSIdentifier()
[docs] _title = OWSTitle()
[docs] abstract = OWSAbstract(missing=drop)
[docs]class WPSOutputBase(ExtendedMappingSchema):
[docs] identifier = OWSIdentifier()
[docs] _title = OWSTitle()
[docs] abstract = OWSAbstract(missing=drop)
[docs]class WPSOutputDefinitionItem(WPSOutputBase, WPSNamespace):
[docs] name = "Output"
# use different title to avoid OpenAPI schema definition clash with 'Output' of 'WPSProcessOutputs'
[docs] title = "OutputDefinition"
[docs]class WPSOutputDefinitions(ExtendedSequenceSchema, WPSNamespace):
[docs] name = "OutputDefinitions"
[docs] title = "OutputDefinitions"
[docs] out_def = WPSOutputDefinitionItem()
[docs]class WPSOutputLiteral(ExtendedMappingSchema):
[docs] data = ()
[docs]class WPSReference(ExtendedMappingSchema, WPSNamespace):
[docs] href = XMLReferenceAttribute()
[docs] mimeType = MimeTypeAttribute()
[docs] encoding = EncodingAttribute()
[docs]class WPSOutputReference(ExtendedMappingSchema):
[docs] title = "OutputReference"
[docs] reference = WPSReference(name="Reference")
[docs]class WPSOutputData(OneOfKeywordSchema):
[docs] _one_of = [ WPSOutputLiteral(), WPSOutputReference(),
]
[docs]class WPSDataOutputItem(AllOfKeywordSchema, WPSNamespace):
[docs] name = "Output"
# use different title to avoid OpenAPI schema definition clash with 'Output' of 'WPSOutputDefinitions'
[docs] title = "DataOutput"
[docs] _all_of = [ WPSOutputBase(), WPSOutputData(),
]
[docs]class WPSProcessOutputs(ExtendedSequenceSchema, WPSNamespace):
[docs] name = "ProcessOutputs"
[docs] title = "ProcessOutputs"
[docs] output = WPSDataOutputItem()
[docs]class WPSExecuteResponse(WPSResponseBaseType, WPSProcessVersion):
[docs] _schema = "http://schemas.opengis.net/wps/1.0.0/wpsExecute_response.xsd"
[docs] name = "ExecuteResponse"
[docs] title = "ExecuteResponse" # not to be confused by 'Execute' used for request
[docs] location = WPSStatusLocationAttribute()
[docs] svc_loc = WPSServiceInstanceAttribute()
[docs] process = WPSProcessSummary()
[docs] status = WPSStatus()
[docs] inputs = WPSDataInputs(missing=drop) # when lineage is requested only
[docs] out_def = WPSOutputDefinitions(missing=drop) # when lineage is requested only
[docs] outputs = WPSProcessOutputs()
[docs]class WPSXMLSuccessBodySchema(OneOfKeywordSchema):
[docs] _one_of = [ WPSGetCapabilities(), WPSDescribeProcess(), WPSExecuteResponse(),
]
[docs]class OWSExceptionCodeAttribute(ExtendedSchemaNode, XMLObject):
[docs] schema_type = String
[docs] name = "exceptionCode"
[docs] title = "Exception"
[docs] attribute = True
[docs]class OWSExceptionLocatorAttribute(ExtendedSchemaNode, XMLObject):
[docs] schema_type = String
[docs] name = "locator"
[docs] attribute = True
[docs]class OWSExceptionText(ExtendedSchemaNode, OWSNamespace):
[docs] schema_type = String
[docs] name = "ExceptionText"
[docs]class OWSException(ExtendedMappingSchema, OWSNamespace):
[docs] name = "Exception"
[docs] title = "Exception"
[docs] code = OWSExceptionCodeAttribute(example="MissingParameterValue")
[docs] locator = OWSExceptionLocatorAttribute(default="None", example="service")
[docs] text = OWSExceptionText(example="Missing service")
[docs]class OWSExceptionReport(ExtendedMappingSchema, OWSNamespace):
[docs] name = "ExceptionReport"
[docs] title = "ExceptionReport"
[docs] exception = OWSException()
[docs]class WPSException(ExtendedMappingSchema):
[docs] report = OWSExceptionReport()
[docs]class OkWPSResponse(ExtendedMappingSchema):
[docs] description = "WPS operation successful"
[docs] header = XmlHeader()
[docs] body = WPSXMLSuccessBodySchema()
[docs]class ErrorWPSResponse(ExtendedMappingSchema):
[docs] description = "Unhandled error occurred on WPS endpoint."
[docs] header = XmlHeader()
[docs] body = WPSException()
[docs]class ProviderEndpoint(ProviderPath):
[docs] header = RequestHeaders()
[docs]class ProcessDescriptionQuery(ExtendedMappingSchema): # see: 'ProcessDescription' schema and 'Process.offering' method
[docs] schema = ExtendedSchemaNode( String(), example=ProcessSchema.OGC, default=ProcessSchema.OGC, validator=OneOfCaseInsensitive(ProcessSchema.values()), summary="Selects the desired schema representation of the process description.", description=( "Selects the desired schema representation of the process description. "
f"When '{ProcessSchema.OGC}' is used, inputs and outputs will be represented as mapping of objects. " "Process metadata are also directly provided at the root of the content. " f"When '{ProcessSchema.OLD}' is used, inputs and outputs will be represented as list of objects with ID. " "Process metadata are also reported nested under a 'process' field. " "See '#/definitions/ProcessDescription' schema for more details about each case. " "These schemas are all represented with JSON content. " f"For the XML definition, employ '{ProcessSchema.WPS}' or any format selector (f, format, Accept) with XML." ) )
[docs]class ProviderProcessEndpoint(ProviderProcessPath):
[docs] header = RequestHeaders()
[docs] querystring = ProcessDescriptionQuery()
[docs]class LocalProcessDescriptionQuery(ProcessDescriptionQuery, LocalProcessQuery, FormatQuery): pass
[docs]class LocalProcessEndpointHeaders(AcceptFormatHeaders, RequestHeaders): # order important for descriptions to appear pass
[docs]class ProcessEndpoint(LocalProcessPath):
[docs] header = LocalProcessEndpointHeaders()
[docs] querystring = LocalProcessDescriptionQuery()
[docs]class ProcessPackageEndpoint(LocalProcessPath):
[docs] header = RequestHeaders()
[docs] querystring = LocalProcessQuery()
[docs]class ProcessPayloadEndpoint(LocalProcessPath):
[docs] header = RequestHeaders()
[docs] querystring = LocalProcessQuery()
[docs]class ProcessQuoteEstimatorGetEndpoint(LocalProcessPath):
[docs] header = RequestHeaders()
[docs] querystring = LocalProcessQuery()
[docs]class ProcessQuoteEstimatorPutEndpoint(LocalProcessPath):
[docs] header = RequestHeaders()
[docs] querystring = LocalProcessQuery()
[docs] body = QuoteEstimatorSchema()
[docs]class ProcessQuoteEstimatorDeleteEndpoint(LocalProcessPath):
[docs] header = RequestHeaders()
[docs] querystring = LocalProcessQuery()
[docs]class ProcessVisibilityGetEndpoint(LocalProcessPath):
[docs] header = RequestHeaders()
[docs] querystring = LocalProcessQuery()
[docs]class ProcessVisibilityPutEndpoint(LocalProcessPath):
[docs] header = RequestHeaders()
[docs] querystring = LocalProcessQuery()
[docs] body = VisibilitySchema()
[docs]class ProviderJobEndpoint(ProviderProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs]class JobEndpoint(JobPath):
[docs] header = RequestHeaders()
[docs]class ProcessInputsEndpoint(LocalProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs]class ProviderInputsEndpoint(ProviderProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs]class JobInputsOutputsQuery(ExtendedMappingSchema):
[docs] schema = ExtendedSchemaNode( String(), title="JobInputsOutputsQuerySchema", example=JobInputsOutputsSchema.OGC, default=JobInputsOutputsSchema.OLD, validator=OneOfCaseInsensitive(JobInputsOutputsSchema.values()), summary="Selects the schema employed for representation of submitted job inputs and outputs.", description=( "Selects the schema employed for representing job inputs and outputs that were submitted for execution. "
f"When '{JobInputsOutputsSchema.OLD}' is employed, listing of object with IDs is returned. " f"When '{JobInputsOutputsSchema.OGC}' is employed, mapping of object definitions is returned. " "If no schema is requested, the original formats from submission are employed, which could be a mix of " "both representations. Providing a schema forces their corresponding conversion as applicable." ) )
[docs]class JobInputsEndpoint(JobPath):
[docs] header = RequestHeaders()
[docs] querystring = JobInputsOutputsQuery()
[docs]class JobResultsQuery(ExtendedMappingSchema):
[docs] schema = ExtendedSchemaNode( String(), title="JobOutputResultsSchema", example=JobInputsOutputsSchema.OGC, default=JobInputsOutputsSchema.OLD, validator=OneOfCaseInsensitive(JobInputsOutputsSchema.values()), summary="Selects the schema employed for representation of job outputs.", description=( "Selects the schema employed for representation of job results (produced outputs) "
"for providing file Content-Type details. " f"When '{JobInputsOutputsSchema.OLD}' is employed, " "'format.mimeType' is used and 'type' is reported as well. " f"When '{JobInputsOutputsSchema.OGC}' is employed, " "'format.mediaType' is used and 'type' is reported as well. " "When the '+strict' value is added, only the 'format' or 'type' will be represented according to the " f"reference standard ({JobInputsOutputsSchema.OGC}, {JobInputsOutputsSchema.OLD}) representation." ) )
[docs]class LocalProcessJobResultsQuery(LocalProcessQuery, JobResultsQuery): pass
[docs]class JobOutputsEndpoint(JobPath):
[docs] header = RequestHeaders()
[docs] querystring = LocalProcessJobResultsQuery()
[docs]class ProcessOutputsEndpoint(LocalProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs] querystring = LocalProcessJobResultsQuery()
[docs]class ProviderOutputsEndpoint(ProviderProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs] querystring = JobResultsQuery()
[docs]class ProcessResultEndpoint(ProcessOutputsEndpoint):
[docs] deprecated = True
[docs] header = RequestHeaders()
[docs]class ProviderResultEndpoint(ProviderOutputsEndpoint):
[docs] deprecated = True
[docs] header = RequestHeaders()
[docs]class JobResultEndpoint(JobPath):
[docs] deprecated = True
[docs] header = RequestHeaders()
[docs]class ProcessResultsEndpoint(LocalProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs]class ProviderResultsEndpoint(ProviderProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs]class JobResultsEndpoint(ProviderProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs]class ProviderExceptionsEndpoint(ProviderProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs]class JobExceptionsEndpoint(JobPath):
[docs] header = RequestHeaders()
[docs]class ProcessExceptionsEndpoint(LocalProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs] querystring = LocalProcessQuery()
[docs]class ProviderLogsEndpoint(ProviderProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs]class JobLogsEndpoint(JobPath):
[docs] header = RequestHeaders()
[docs]class ProcessLogsEndpoint(LocalProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs] querystring = LocalProcessQuery()
[docs]class JobStatisticsEndpoint(JobPath):
[docs] header = RequestHeaders()
[docs]class ProcessJobStatisticsEndpoint(LocalProcessPath, JobPath):
[docs] header = RequestHeaders()
[docs] querystring = LocalProcessQuery()
[docs]class ProviderJobStatisticsEndpoint(ProviderProcessPath, JobPath):
[docs] header = RequestHeaders()
################################################################## # These classes define schemas for requests that feature a body ##################################################################
[docs]class ProviderPublic(ExtendedMappingSchema):
[docs] public = ExtendedSchemaNode( Boolean(), default=False, description="Whether the service is defined as publicly visible. "
"This will not control allowance/denial of requests to the registered endpoint of the service. " "It only indicates if it should appear during listing of providers." )
[docs]class CreateProviderRequestBody(ProviderPublic):
[docs] id = AnyIdentifier()
[docs] url = URL(description="Endpoint where to query the provider.")
[docs]class ExecuteInputDataType(InputIdentifierType): pass
[docs]class ExecuteOutputDataType(OutputIdentifierType): pass
[docs]class ExecuteOutputDefinition(ExtendedMappingSchema):
[docs] transmissionMode = TransmissionModeEnum(missing=drop)
[docs] format = Format(missing=drop)
[docs]class ExecuteOutputItem(ExecuteOutputDataType, ExecuteOutputDefinition): pass
[docs]class ExecuteOutputSpecList(ExtendedSequenceSchema): """ Filter list of outputs to be obtained from execution and their reporting method. """
[docs] output = ExecuteOutputItem()
[docs]class ExecuteOutputMapAdditionalProperties(ExtendedMappingSchema):
[docs] output_id = ExecuteOutputDefinition(variable="{output-id}", title="ExecuteOutputSpecMap", description="Desired output reporting method.")
[docs]class ExecuteOutputSpecMap(AnyOfKeywordSchema):
[docs] _any_of = [ ExecuteOutputMapAdditionalProperties(), # normal {"<output-id>": {...}} EmptyMappingSchema(), # allows explicitly provided {}
]
[docs]class ExecuteOutputSpec(OneOfKeywordSchema): """ Filter list of outputs to be obtained from execution and define their reporting method. """
[docs] _one_of = [ # OLD format: {"outputs": [{"id": "<id>", "transmissionMode": "value|reference"}, ...]} ExecuteOutputSpecList(), # OGC-API: {"inputs": {"<id>": {"transmissionMode": "value|reference"}, ...}} ExecuteOutputSpecMap(),
]
[docs]class ProviderNameSchema(AnyIdentifier):
[docs] title = "ProviderName"
[docs] description = "Identifier of the remote provider."
[docs]class ProviderSummarySchema(DescriptionType, ProviderPublic, DescriptionMeta, DescriptionLinks): """ Service provider summary definition. """
[docs] id = ProviderNameSchema()
[docs] url = URL(description="Endpoint of the service provider.")
[docs] type = ExtendedSchemaNode(String())
[docs] _sort_first = PROVIDER_DESCRIPTION_FIELD_FIRST
[docs] _sort_after = PROVIDER_DESCRIPTION_FIELD_AFTER
[docs]class ProviderCapabilitiesSchema(ProviderSummarySchema): """ Service provider detailed capabilities. """
[docs]class TransmissionModeList(ExtendedSequenceSchema):
[docs] transmissionMode = TransmissionModeEnum()
[docs]class JobControlOptionsList(ExtendedSequenceSchema):
[docs] jobControlOption = JobControlOptionsEnum()
[docs]class ExceptionReportType(ExtendedMappingSchema):
[docs] code = ExtendedSchemaNode(String())
[docs] description = ExtendedSchemaNode(String(), missing=drop)
[docs]class ProcessControl(ExtendedMappingSchema):
[docs] jobControlOptions = JobControlOptionsList(missing=ExecuteControlOption.values(), default=ExecuteControlOption.values())
[docs] outputTransmission = TransmissionModeList(missing=ExecuteTransmissionMode.values(), default=ExecuteTransmissionMode.values())
[docs]class ProcessLocations(ExtendedMappingSchema): """ Additional endpoint locations specific to the process. """
[docs] processDescriptionURL = URL(description="Process description endpoint using OGC-API interface.", missing=drop, title="processDescriptionURL")
[docs] processEndpointWPS1 = URL(description="Process description endpoint using WPS-1 interface.", missing=drop, title="processEndpointWPS1")
[docs] executeEndpoint = URL(description="Endpoint where the process can be executed from.", missing=drop, title="executeEndpoint")
# 'links' already included via 'ProcessDescriptionType->DescriptionType'
[docs]class ProcessSummary( ProcessDescriptionType, DescriptionMeta, ProcessControl, ProcessLocations, DescriptionLinks ): """ Summary process definition. """
[docs] _schema = f"{OGC_API_SCHEMA_CORE}/processSummary.yaml"
[docs] _sort_first = PROCESS_DESCRIPTION_FIELD_FIRST
[docs] _sort_after = PROCESS_DESCRIPTION_FIELD_AFTER
[docs]class ProcessSummaryList(ExtendedSequenceSchema):
[docs] summary = ProcessSummary()
[docs]class ProcessNamesList(ExtendedSequenceSchema):
[docs] process_name = ProcessIdentifierTag( description="Process identifier or tagged representation if revision was requested."
)
[docs]class ProcessListing(OneOfKeywordSchema):
[docs] _one_of = [ ProcessSummaryList(description="Listing of process summary details from existing definitions."), ProcessNamesList(description="Listing of process names when not requesting details.", missing=drop), # in case of empty list, both schema are valid, drop this one to resolve
]
[docs]class ProcessCollection(ExtendedMappingSchema):
[docs] processes = ProcessListing()
[docs]class ProcessPagingQuery(ExtendedMappingSchema):
[docs] sort = ProcessSortEnum(missing=drop)
# if page is omitted but limit provided, use reasonable zero by default
[docs] page = ExtendedSchemaNode(Integer(allow_string=True), missing=0, default=0, validator=Range(min=0))
[docs] limit = ExtendedSchemaNode(Integer(allow_string=True), missing=None, default=None, validator=Range(min=1), schema=f"{OGC_API_PROC_PART1_PARAMETERS}/limit.yaml")
[docs]class ProcessVisibility(ExtendedMappingSchema):
[docs] visibility = VisibilityValue(missing=drop)
[docs]class ProcessDeploymentProfile(ExtendedMappingSchema):
[docs] deploymentProfile = URL(missing=drop)
[docs]class Process( # following are like 'ProcessSummary', # except without 'ProcessControl' and 'DescriptionLinks' that are outside the nested 'process' ProcessDescriptionType, DescriptionMeta, # following are additional fields only in description, just like for OGC-API ProcessDescription ProcessContext, ProcessVisibility, ProcessLocations ): """ Old nested process schema for process description. """ # note: deprecated in favor of OGC-API schema
[docs] inputs = DescribeInputTypeList(description="Inputs definition of the process.")
[docs] outputs = DescribeOutputTypeList(description="Outputs definition of the process.")
[docs] _sort_first = PROCESS_DESCRIPTION_FIELD_FIRST
[docs] _sort_after = PROCESS_DESCRIPTION_FIELD_AFTER
[docs]class ProcessDescriptionOLD(ProcessControl, ProcessDeploymentProfile, DescriptionLinks): """ Old schema for process description. """
[docs] deprecated = True
[docs] process = Process()
[docs] _sort_first = PROCESS_DESCRIPTION_FIELD_FIRST_OLD_SCHEMA
[docs] _sort_after = PROCESS_DESCRIPTION_FIELD_AFTER_OLD_SCHEMA
[docs]class ProcessDescriptionOGC( ProcessSummary, ProcessContext, ProcessVisibility, ProcessLocations, ProcessDeploymentProfile, DescriptionLinks ): """ OGC-API schema for process description. """ # technically, empty inputs are allowed for processes that should generate constant/randomized outputs # example: # https://pavics.ouranos.ca/twitcher/ows/proxy/catalog # ?service=WPS&request=DescribeProcess&version=1.0.0&identifier=pavicstestdocs
[docs] inputs = DescribeInputTypeMap(description="Inputs definition of the process.", missing=drop, default={})
[docs] outputs = DescribeOutputTypeMap(description="Outputs definition of the process.")
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/process.yaml"
[docs] _sort_first = PROCESS_DESCRIPTION_FIELD_FIRST
[docs] _sort_after = PROCESS_DESCRIPTION_FIELD_AFTER
[docs]class ProcessDescription(OneOfKeywordSchema): """ Supported schema representations of a process description (based on specified query parameters). """
[docs] _one_of = [ ProcessDescriptionOGC, ProcessDescriptionOLD,
]
[docs]class ProcessDeployment(ProcessSummary, ProcessContext, ProcessDeployMeta): # override ID to forbid deploy to contain a tagged version part # if version should be applied, it must be provided with its 'Version' field
[docs] id = ProcessIdentifier()
# explicit "abstract" handling for bw-compat, new versions should use "description" # only allowed in deploy to support older servers that report abstract (or parsed from WPS-1/2) # recent OGC-API v1+ will usually provide directly "description" as per the specification
[docs] abstract = ExtendedSchemaNode(String(), missing=drop, deprecated=True, description="Detailed explanation of the process being deployed. "
"[Deprecated] Consider using 'description' instead.") # allowed undefined I/O during deploy because of reference from owsContext or executionUnit
[docs] inputs = DeployInputTypeAny( missing=drop, title="DeploymentInputs", description="Additional definitions for process inputs to extend generated details by the referred package. "
"These are optional as they can mostly be inferred from the 'executionUnit', but allow specific " f"overrides (see '{DOC_URL}/package.html#correspondence-between-cwl-and-wps-fields')")
[docs] outputs = DeployOutputTypeAny( missing=drop, title="DeploymentOutputs", description="Additional definitions for process outputs to extend generated details by the referred package. "
"These are optional as they can mostly be inferred from the 'executionUnit', but allow specific " f"overrides (see '{DOC_URL}/package.html#correspondence-between-cwl-and-wps-fields')")
[docs] visibility = VisibilityValue(missing=drop)
[docs] _schema = f"{OGC_API_SCHEMA_EXT_DEPLOY}/processSummary.yaml"
[docs] _sort_first = PROCESS_DESCRIPTION_FIELD_FIRST
[docs] _sort_after = PROCESS_DESCRIPTION_FIELD_AFTER
[docs]class Duration(ExtendedSchemaNode): # note: using String instead of Time because timedelta object cannot be directly handled (missing parts at parsing)
[docs] schema_type = String
[docs] description = "Human-readable representation of the duration."
[docs] example = "hh:mm:ss"
# FIXME: use ISO-8601 duration (?) - P[n]Y[n]M[n]DT[n]H[n]M[n]S # https://pypi.org/project/isodate/ # https://en.wikipedia.org/wiki/ISO_8601#Durations # See: # 'duration.to_iso8601' already employed for quotes, should apply for jobs as well
[docs]class DurationISO(ExtendedSchemaNode): """ Duration represented using ISO-8601 format. .. seealso:: - https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.7.3.1 - :rfc:`3339#appendix-A` """
[docs] schema_type = String
[docs] description = "ISO-8601 representation of the duration."
[docs] example = "P[n]Y[n]M[n]DT[n]H[n]M[n]S"
[docs] format = "duration"
[docs] def deserialize(self, cstruct): # type: (Union[datetime.timedelta, str]) -> str if isinstance(cstruct, datetime.timedelta) or isinstance(cstruct, str) and not cstruct.startswith("P"): return duration.to_iso8601(cstruct) return cstruct
[docs]class JobStatusInfo(ExtendedMappingSchema):
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/statusInfo.yaml"
[docs] jobID = JobID()
[docs] processID = ProcessIdentifierTag(missing=None, default=None, description="Process identifier corresponding to the job execution.")
[docs] providerID = ProcessIdentifier(missing=None, default=None, description="Provider identifier corresponding to the job execution.")
[docs] type = JobTypeEnum(description="Type of the element associated to the creation of this job.")
[docs] status = JobStatusEnum(description="Last updated status.")
[docs] message = ExtendedSchemaNode(String(), missing=drop, description="Information about the last status update.")
[docs] created = ExtendedSchemaNode(DateTime(), missing=drop, default=None, description="Timestamp when the process execution job was created.")
[docs] started = ExtendedSchemaNode(DateTime(), missing=drop, default=None, description="Timestamp when the process started execution if applicable.")
[docs] finished = ExtendedSchemaNode(DateTime(), missing=drop, default=None, description="Timestamp when the process completed execution if applicable.")
[docs] updated = ExtendedSchemaNode(DateTime(), missing=drop, default=None, description="Timestamp of the last update of the job status. This can correspond to "
"any of the other timestamps according to current execution status or " "even slightly after job finished execution according to the duration " "needed to deallocate job resources and store results.")
[docs] duration = Duration(missing=drop, description="Duration since the start of the process execution.")
[docs] runningDuration = DurationISO(missing=drop, description="Duration in ISO-8601 format since the start of the process execution.")
[docs] runningSeconds = Number(missing=drop, description="Duration in seconds since the start of the process execution.")
[docs] expirationDate = ExtendedSchemaNode(DateTime(), missing=drop, description="Timestamp when the job will be canceled if not yet completed.")
[docs] estimatedCompletion = ExtendedSchemaNode(DateTime(), missing=drop)
[docs] nextPoll = ExtendedSchemaNode(DateTime(), missing=drop, description="Timestamp when the job will be prompted for updated status details.")
[docs] percentCompleted = Number(example=0, validator=Range(min=0, max=100), description="Completion percentage of the job as indicated by the process.")
[docs] progress = ExtendedSchemaNode(Integer(), example=100, validator=Range(0, 100), description="Completion progress of the job (alias to 'percentCompleted').")
[docs]class JobEntrySchema(OneOfKeywordSchema): # note: # Since JobID is a simple string (not a dict), no additional mapping field can be added here. # They will be discarded by `OneOfKeywordSchema.deserialize()`.
[docs] _one_of = [ JobStatusInfo, UUID(description="Job ID."),
]
[docs]class JobCollection(ExtendedSequenceSchema):
[docs] item = JobEntrySchema()
[docs]class CreatedJobStatusSchema(DescriptionSchema):
[docs] jobID = JobID(description="Unique identifier of the created job for execution.")
[docs] processID = ProcessIdentifierTag(description="Identifier of the process that will be executed.")
[docs] providerID = AnyIdentifier(description="Remote provider identifier if applicable.", missing=drop)
[docs] status = ExtendedSchemaNode(String(), example=Status.ACCEPTED)
[docs] location = ExtendedSchemaNode(String(), example="http://{host}/weaver/processes/{my-process-id}/jobs/{my-job-id}")
[docs]class PagingBodySchema(ExtendedMappingSchema): # don't use defaults if missing, otherwise we might report incorrect values compared to actual contents
[docs] count = ExtendedSchemaNode(Integer(), missing=drop, validator=Range(min=0), description="Number of items returned within this paged result.")
[docs] limit = ExtendedSchemaNode(Integer(), missing=drop, validator=Range(min=1, max=1000), schema=f"{OGC_API_PROC_PART1_PARAMETERS}/limit.yaml", description="Maximum number of items returned per page.")
[docs] page = ExtendedSchemaNode(Integer(), missing=drop, validator=Range(min=0), description="Paging index.")
[docs] total = ExtendedSchemaNode(Integer(), missing=drop, validator=Range(min=0), description="Total number of items regardless of paging.")
[docs]class GetPagingJobsSchema(PagingBodySchema):
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/jobList.yaml" # technically, no 'links' yet, but added after by oneOf
[docs] jobs = JobCollection()
[docs]class JobCategoryFilters(PermissiveMappingSchema):
[docs] category = ExtendedSchemaNode(String(), title="CategoryFilter", variable="{category}", default=None, missing=None, description="Value of the corresponding parameter forming that category group.")
[docs]class GroupedJobsCategorySchema(ExtendedMappingSchema):
[docs] category = JobCategoryFilters(description="Grouping values that compose the corresponding job list category.")
[docs] jobs = JobCollection(description="List of jobs that matched the corresponding grouping values.")
[docs] count = ExtendedSchemaNode(Integer(), description="Number of matching jobs for the corresponding group category.")
[docs]class GroupedCategoryJobsSchema(ExtendedSequenceSchema):
[docs] job_group_category_item = GroupedJobsCategorySchema()
[docs]class GetGroupedJobsSchema(ExtendedMappingSchema):
[docs] groups = GroupedCategoryJobsSchema()
[docs]class GetQueriedJobsSchema(OneOfKeywordSchema):
[docs] _one_of = [ GetPagingJobsSchema(description="Matched jobs according to filter queries."), GetGroupedJobsSchema(description="Matched jobs grouped by specified categories."),
]
[docs] total = ExtendedSchemaNode(Integer(), description="Total number of matched jobs regardless of grouping or paging result.")
[docs] _sort_first = JOBS_LISTING_FIELD_FIRST
[docs] _sort_after = JOBS_LISTING_FIELD_AFTER
[docs]class DismissedJobSchema(ExtendedMappingSchema):
[docs] status = JobStatusEnum()
[docs] jobID = JobID()
[docs] message = ExtendedSchemaNode(String(), example="Job dismissed.")
[docs] percentCompleted = ExtendedSchemaNode(Integer(), example=0)
# same as base Format, but for process/job responses instead of process submission # (ie: 'Format' is for allowed/supported formats, this is the result format)
[docs]class DataEncodingAttributes(FormatSelection): pass
[docs]class ReferenceBase(ExtendedMappingSchema):
[docs] format = DataEncodingAttributes(missing=drop)
[docs] body = ExtendedSchemaNode(String(), missing=drop)
[docs] bodyReference = ReferenceURL(missing=drop)
[docs]class Reference(ReferenceBase):
[docs] title = "Reference"
[docs] href = ReferenceURL(description="Endpoint of the reference.")
[docs]class ExecuteReference(ReferenceBase):
[docs] title = "ExecuteReference"
[docs] href = ExecuteReferenceURL(description="Endpoint of the reference.")
[docs]class ArrayReference(ExtendedSequenceSchema):
[docs] item = ExecuteReference()
[docs]class ArrayReferenceValueType(ExtendedMappingSchema):
[docs] value = ArrayReference()
# Backward compatible data-input that allows values to be nested under 'data' or 'value' fields, # both for literal values and link references, for inputs submitted as list-items. # Also allows the explicit 'href' (+ optional format) reference for a link. # # Because this data-input structure applies only to list-items (see 'ExecuteInputItem' below), mapping is always needed. # (i.e.: values cannot be submitted inline in the list, because field 'id' of each input must also be provided) # For this reason, one of 'value', 'data', 'href' or 'reference' is mandatory.
[docs]class ExecuteInputAnyType(OneOfKeywordSchema): """ Permissive variants that we attempt to parse automatically. """
[docs] _one_of = [ # Array of literal data with 'data' key ArrayLiteralDataType(), # same with 'value' key (OGC specification) ArrayLiteralValueType(), # Array of HTTP references with various keywords ArrayReferenceValueType(), # literal data with 'data' key AnyLiteralDataType(), # same with 'value' key (OGC specification) AnyLiteralValueType(), # HTTP references with various keywords LiteralReference(), ExecuteReference()
]
[docs]class ExecuteInputItem(ExecuteInputDataType, ExecuteInputAnyType):
[docs] description = ( "Default value to be looked for uses key 'value' to conform to older drafts of OGC-API standard. "
"Even older drafts that allowed other fields 'data' instead of 'value' and 'reference' instead of 'href' " "are also looked for to remain back-compatible." ) # backward compatible definition: # # inputs: [ # {"id": "<id>", "value": <data>}, # {"id": "<id>", "href": <link>} # ... (other variants) ... # ] #
[docs]class ExecuteInputListValues(ExtendedSequenceSchema):
[docs] input_item = ExecuteInputItem(summary="Received list input value definition during job submission.")
# same as 'ExecuteInputReference', but using 'OGC' schema with 'type' field # Defined as: # https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-core/link.yaml # But explicitly in the context of an execution input, rather than any other link (eg: metadata) # same as 'ExecuteInputLink', but using 'OLD' schema with 'format' field
[docs]class ExecuteInputReference(Reference):
[docs] summary = "Execute input reference link definition with parameters."
[docs]class ExecuteInputFile(AnyOfKeywordSchema):
[docs] _any_of = [ # 'href' required for both to provide file link/reference ExecuteInputFileLink(), # 'OGC' schema with 'type: <MediaType>' ExecuteInputReference(), # 'OLD' schema with 'format: {mimeType|mediaType: <MediaType>}'
] # https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-core/inputValueNoObject.yaml # Any literal value directly provided inline in input mapping. # # {"inputs": {"<id>": <literal-data>}} # # Excludes objects to avoid conflict with later object mapping and {"value": <data>} definitions. # Excludes array literals that will be defined separately with allowed array of any item within this schema. # FIXME: does not support byte/binary type (string + format:byte) - see also: 'AnyLiteralType' # https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-core/binaryInputValue.yaml # FIXME: does not support bbox # https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-core/bbox.yaml
[docs]class ExecuteInputInlineValue(OneOfKeywordSchema):
[docs] description = "Execute input value provided inline."
[docs] _one_of = [ ExtendedSchemaNode(Float(), title="ExecuteInputValueFloat"), ExtendedSchemaNode(Integer(), title="ExecuteInputValueInteger"), ExtendedSchemaNode(Boolean(), title="ExecuteInputValueBoolean"), ExtendedSchemaNode(String(), title="ExecuteInputValueString"),
] # https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-core/inputValue.yaml # # oneOf: # - $ref: "inputValueNoObject.yaml" # - type: object
[docs]class ExecuteInputObjectData(OneOfKeywordSchema):
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/inputValue.yaml"
[docs] description = "Data value of any schema "
[docs] _one_of = [ ExecuteInputInlineValue(), PermissiveMappingSchema(description="Data provided as any object schema."),
] # https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-core/qualifiedInputValue.yaml
[docs]class ExecuteInputQualifiedValue(Format):
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/qualifiedInputValue.yaml"
[docs] value = ExecuteInputObjectData() # can be anything, including literal value, array of them, nested object
# https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-core/inlineOrRefData.yaml # # oneOf: # - $ref: "inputValueNoObject.yaml" # in OGC-API spec, includes a generic array # - $ref: "qualifiedInputValue.yaml" # - $ref: "link.yaml" #
[docs]class ExecuteInputInlineOrRefData(OneOfKeywordSchema):
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/inlineOrRefData.yaml"
[docs] _one_of = [ ExecuteInputInlineValue(), # <inline-literal> ExecuteInputQualifiedValue(), # {"value": <anything>, "mediaType": "<>", "schema": <OAS link or object>} ExecuteInputFile(), # 'href' with either 'type' (OGC) or 'format' (OLD)
# FIXME: other types here, 'bbox+crs', 'collection', 'nested process', etc. ]
[docs]class ExecuteInputArrayValues(ExtendedSequenceSchema):
[docs] item_value = ExecuteInputInlineOrRefData()
# combine 'inlineOrRefData' and its 'array[inlineOrRefData]' variants to simplify 'ExecuteInputAny' definition
[docs]class ExecuteInputData(OneOfKeywordSchema):
[docs] description = "Execute data definition of the input."
[docs] _one_of = [ ExecuteInputInlineOrRefData, ExecuteInputArrayValues,
] # https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-core/execute.yaml # # inputs: # additionalProperties: # this is the below 'variable=<input-id>' # oneOf: # - $ref: "inlineOrRefData.yaml" # - type: array # items: # $ref: "inlineOrRefData.yaml" #
[docs]class ExecuteInputMapAdditionalProperties(ExtendedMappingSchema):
[docs] input_id = ExecuteInputData(variable="{input-id}", title="ExecuteInputValue", description="Received mapping input value definition during job submission.")
[docs]class ExecuteInputMapValues(AnyOfKeywordSchema):
[docs] _any_of = [ ExecuteInputMapAdditionalProperties(), # normal {"<input-id>": {...}} EmptyMappingSchema(), # allows explicitly provided {}
]
[docs]class ExecuteInputValues(OneOfKeywordSchema):
[docs] _one_of = [ # OLD format: {"inputs": [{"id": "<id>", "value": <data>}, ...]} ExecuteInputListValues(description="Process job execution inputs defined as item listing."), # OGC-API: {"inputs": {"<id>": <data>, "<id>": {"value": <data>}, ...}} ExecuteInputMapValues(description="Process job execution inputs defined as mapping."),
]
[docs]class ExecuteInputOutputs(ExtendedMappingSchema): # Permit unspecified (optional) inputs for processes that could technically allow no-inputs definition (CWL). # This is very unusual in real world scenarios, but has some possible cases: constant endpoint fetcher, RNG output. # # NOTE: # It is **VERY** important to use 'default={}' and not 'missing=drop' contrary to other optional fields. # Using 'drop' causes and invalid input definition to be ignored/removed and not be validated for expected schema. # We want to ensure format is validated if present to rapidly report the issue and not move on to full execution. # If 'inputs' are indeed omitted, the default with match against and empty 'ExecuteInputMapValues' schema. # If 'inputs' are explicitly provided as '{}' or '[]', it will also behave the right way for no-inputs process. # # See tests validating both cases (incorrect schema vs optionals inputs): # - 'tests.wps_restapi.test_processes.WpsRestApiProcessesTest.test_execute_process_missing_required_params' # - 'tests.wps_restapi.test_providers.WpsRestApiProcessesTest.test_execute_process_no_error_not_required_params' # - 'tests.wps_restapi.test_providers.WpsRestApiProcessesTest.test_get_provider_process_no_inputs' # - 'tests.wps_restapi.test_colander_extras.test_oneof_variable_dict_or_list'
[docs] inputs = ExecuteInputValues(default={}, description="Values submitted for execution.")
[docs] outputs = ExecuteOutputSpec( description=( "Defines which outputs to be obtained from the execution (filtered or all), " "as well as the reporting method for each output according to 'transmissionMode', " "the 'response' type, and the execution 'mode' provided " f"(see for more details: {DOC_URL}/processes.html#execution-body)." ), default={}
)
[docs]class Execute(ExecuteInputOutputs): # OGC 'execute.yaml' does not enforce any required item
[docs] _schema = f"{OGC_API_PROC_PART1_SCHEMAS}/execute.yaml"
[docs] examples = { "ExecuteJSON": { "summary": "Execute a process job using REST JSON payload with OGC API schema.", "value": EXAMPLES["job_execute.json"],
}, }
[docs] mode = JobExecuteModeEnum( missing=drop, default=ExecuteMode.AUTO, deprecated=True, description=( "Desired execution mode specified directly. This is intended for backward compatibility support. " "To obtain more control over execution mode selection, employ the official Prefer header instead " f"(see for more details: {DOC_URL}/processes.html#execution-mode)." ), validator=OneOf(ExecuteMode.values())
)
[docs] response = JobResponseOptionsEnum( missing=drop, default=ExecuteResponse.DOCUMENT, description=( "Indicates the desired representation format of the response. " f"(see for more details: {DOC_URL}/processes.html#execution-body)." ), validator=OneOf(ExecuteResponse.values())
)
[docs] notification_email = ExtendedSchemaNode( String(), missing=drop, validator=Email(), description="Optionally send a notification email when the job is done."
)
[docs]class QuoteStatusSchema(ExtendedSchemaNode):
[docs] schema_type = String
[docs] validator = OneOf(QuoteStatus.values())
[docs]class PartialQuoteSchema(ExtendedMappingSchema):
[docs] status = QuoteStatusSchema()
[docs] quoteID = UUID(description="Quote ID.")
[docs] processID = ProcessIdentifierTag(description="Process identifier corresponding to the quote definition.")
[docs]class DecimalRegex(Regex): # because the received value can be a Decimal, # the pattern match object cannot perform regex check directly on it def __call__(self, node, value): return super().__call__(node, str(value))
[docs]class PriceAmount(ExtendedSchemaNode):
[docs] schema_type = Money()
[docs] format = "decimal" # https://github.com/OAI/OpenAPI-Specification/issues/845#issuecomment-378139730
[docs] description = "Monetary value of the price."
[docs] validator = All( Range(min=0), DecimalRegex(re.compile("^[0-9]+.[0-9]+$"), msg="Number must be formatted as currency decimal."),
)
[docs]class PriceCurrency(ExtendedSchemaNode):
[docs] schema_type = String()
[docs] description = "Currency code in ISO-4217 format."
[docs] default = "USD" # most common online
[docs] validator = All( Length(min=3, max=3), OneOf(sorted(list_currencies())),
)
[docs]class PriceSchema(ExtendedMappingSchema):
[docs] amount = PriceAmount()
[docs] currency = PriceCurrency(description=( "Until processed by the quotation estimator for the process, corresponds to the user-requested currency. "
"Once processed, the requested currency will be applied for the amount if exchange rates could be resolved. " "Otherwise, the estimator-specific or API-wide default currency value will be used for the estimated amount." )) def __json__(self, value): """ Handler for :mod:`pyramid` and :mod:`webob` if the object reaches the JSON serializer. Combined with :mod:`simplejson` to automatically handle :class:`Decimal` conversion. """ return super().deserialize(value)
[docs]class QuoteProcessParameters(PermissiveMappingSchema, ExecuteInputOutputs):
[docs] description = ( "Parameters passed for traditional process execution (inputs, outputs) "
"with added metadata for quote evaluation." )
[docs]class QuoteEstimateValue(PermissiveMappingSchema):
[docs] description = "Details of an estimated value, with it attributed rate and resulting cost."
[docs] estimate = PositiveNumber(default=Decimal("0.0"), missing=None)
[docs] rate = PositiveNumber(default=Decimal("1.0"), missing=None)
[docs] cost = PositiveNumber(default=Decimal("0.0"), missing=Decimal("0.0"))
[docs]class QuoteStepChainedInputLiteral(StrictMappingSchema, QuoteEstimatorWeightedParameterSchema):
[docs] value = AnyLiteralType()
[docs]class QuoteStepChainedInputComplex(StrictMappingSchema, QuoteEstimatorWeightedParameterSchema):
[docs] size = PositiveNumber()
[docs]class QuoteStepChainedInput(OneOfKeywordSchema):
[docs] _one_of = [ QuoteStepChainedInputLiteral(), QuoteStepChainedInputComplex(),
]
[docs]class QuoteStepOutputParameters(ExtendedMappingSchema):
[docs] description = "Outputs from a quote estimation to be chained as inputs for a following Workflow step."
[docs] output_id = QuoteStepChainedInput( variable="{output-id}", description="Mapping of output to chain as input for quote estimation.",
)
[docs]class QuoteProcessResults(PermissiveMappingSchema):
[docs] _schema = f"{WEAVER_SCHEMA_URL}/quotation/quote-estimation-result.yaml"
[docs] description = ( "Results of the quote estimation. "
"Will be empty until completed. " "Contents may vary according to the estimation methodology. " "Each category provides details about its contribution toward the total." )
[docs] flat = QuoteEstimateValue(missing=drop)
[docs] memory = QuoteEstimateValue(missing=drop)
[docs] storage = QuoteEstimateValue(missing=drop)
[docs] duration = QuoteEstimateValue(missing=drop)
[docs] cpu = QuoteEstimateValue(missing=drop)
[docs] gpu = QuoteEstimateValue(missing=drop)
[docs] total = PositiveNumber(default=Decimal("0.0"))
[docs] currency = PriceCurrency(missing=drop, description=( "Optional currency employed by the estimator to produce the quote. "
"API-wide default currency employed if not specified." ))
[docs]class UserIdSchema(OneOfKeywordSchema):
[docs] _one_of = [ ExtendedSchemaNode(String(), missing=drop), ExtendedSchemaNode(Integer(), default=None),
]
[docs]class StepQuotation(PartialQuoteSchema):
[docs] detail = ExtendedSchemaNode(String(), description="Detail about quote processing.", missing=None)
[docs] price = PriceSchema(description="Estimated price for process execution.")
[docs] expire = ExtendedSchemaNode(DateTime(), description="Expiration date and time of the quote in ISO-8601 format.")
[docs] created = ExtendedSchemaNode(DateTime(), description="Creation date and time of the quote in ISO-8601 format.")
[docs] userID = UserIdSchema(description="User ID that requested the quote.", missing=required, default=None)
[docs] estimatedTime = Duration(missing=drop, description="Estimated duration of process execution in human-readable format.")
[docs] estimatedSeconds = ExtendedSchemaNode(Integer(), missing=drop, description="Estimated duration of process execution in seconds.")
[docs] estimatedDuration = DurationISO(missing=drop, description="Estimated duration of process execution in ISO-8601 format.")
[docs] processParameters = QuoteProcessParameters(title="QuoteProcessParameters")
[docs] results = QuoteProcessResults(title="QuoteProcessResults", default={})
[docs] outputs = QuoteStepOutputParameters(missing=drop)
[docs]class StepQuotationList(ExtendedSequenceSchema):
[docs] description = "Detailed child processes and prices part of the complete quote."
[docs] step = StepQuotation(description="Quote of a workflow step process.")
[docs]class Quotation(StepQuotation):
[docs] paid = ExtendedSchemaNode(Boolean(), default=False, description=( "Indicates if the quote as been paid by the user. "
"This is mandatory in order to execute the job corresponding to the produced quote." ))
[docs] steps = StepQuotationList(missing=drop)
[docs]class QuoteStepReferenceList(ExtendedSequenceSchema):
[docs] description = "Summary of child process quote references part of the complete quote."
[docs] ref = ReferenceURL()
[docs]class QuoteBase(ExtendedMappingSchema):
[docs] price = PriceSchema(description=( "Total price of the quote including all estimated costs and step processes if applicable."
))
[docs]class QuoteSummary(PartialQuoteSchema, QuoteBase):
[docs] steps = QuoteStepReferenceList()
[docs]class QuoteSchema(Quotation, QuoteBase): pass
[docs]class QuotationList(ExtendedSequenceSchema):
[docs] quote = UUID(description="Quote ID.")
[docs]class QuotationListSchema(PagingBodySchema):
[docs] _sort_first = QUOTES_LISTING_FIELD_FIRST
[docs] _sort_after = QUOTES_LISTING_FIELD_AFTER
[docs] quotations = QuotationList()
[docs]class CreatedQuotedJobStatusSchema(PartialQuoteSchema, CreatedJobStatusSchema):
[docs] billID = UUID(description="ID of the created bill.")
[docs]class BillSchema(ExtendedMappingSchema):
[docs] billID = UUID(description="Bill ID.")
[docs] quoteID = UUID(description="Original quote ID that produced this bill.", missing=drop)
[docs] processID = ProcessIdentifierTag()
[docs] jobID = JobID()
[docs] title = ExtendedSchemaNode(String(), description="Name of the bill.")
[docs] description = ExtendedSchemaNode(String(), missing=drop)
[docs] price = PriceSchema(description="Price associated to the bill.")
[docs] created = ExtendedSchemaNode(DateTime(), description="Creation date and time of the bill in ISO-8601 format.")
[docs] userID = ExtendedSchemaNode(Integer(), description="User id that requested the quote.")
[docs]class BillList(ExtendedSequenceSchema):
[docs] bill = UUID(description="Bill ID.")
[docs]class BillListSchema(ExtendedMappingSchema):
[docs] bills = BillList()
[docs]class SupportedValues(ExtendedMappingSchema): pass
[docs]class DefaultValues(ExtendedMappingSchema): pass
[docs]class CWLClass(ExtendedSchemaNode): # in this case it is ok to use 'name' because target fields receiving it will # never be able to be named 'class' because of Python reserved keyword
[docs] name = "class"
[docs] title = "Class"
[docs] schema_type = String
[docs] example = "CommandLineTool"
[docs] validator = OneOf(["CommandLineTool", "ExpressionTool", "Workflow"])
[docs] description = ( "CWL class specification. This is used to differentiate between single Application Package (AP)"
"definitions and Workflow that chains multiple packages." )
[docs]class CWLExpression(ExtendedSchemaNode):
[docs] schema_type = String
[docs] title = "CWLExpression"
[docs] description = ( f"When combined with '{CWL_REQUIREMENT_INLINE_JAVASCRIPT}', "
"this field allows runtime parameter references " f"(see also: {CWL_CMD_TOOL_URL}#Expression)." )
[docs]class RequirementClass(ExtendedSchemaNode): # in this case it is ok to use 'name' because target fields receiving it will # never be able to be named 'class' because of Python reserved keyword
[docs] name = "class"
[docs] title = "RequirementClass"
[docs] schema_type = String
[docs] description = "CWL requirement class specification."
[docs]class CUDAComputeCapability(ExtendedSchemaNode):
[docs] schema_type = String
[docs] example = "3.0"
[docs] title = "CUDA compute capability"
[docs] description = "The compute capability supported by the GPU hardware."
[docs] validator = SemanticVersion(regex=r"^\d+\.\d+$")
[docs]class CUDAComputeCapabilityArray(ExtendedSequenceSchema):
[docs] item = CUDAComputeCapability()
[docs] validator = Length(min=1)
[docs]class CUDAComputeCapabilitySchema(OneOfKeywordSchema): # https://github.com/common-workflow-language/cwltool/blob/67a180/cwltool/extensions.yml#L178
[docs] title = CUDAComputeCapability.title
[docs] description = inspect.cleandoc(""" The compute capability supported by the GPU hardware. * If this is a single value, it defines only the minimum compute capability. GPUs with higher capability are also accepted. * If it is an array value, then only select GPUs with compute capabilities that explicitly appear in the array. See https://docs.nvidia.com/deploy/cuda-compatibility/#faq and https://docs.nvidia.com/cuda/cuda-c-best-practices-guide/index.html#cuda-compute-capability for details. """)
[docs] _one_of = [ CUDAComputeCapability, CUDAComputeCapabilityArray,
]
[docs]class CUDARequirementSpecification(PermissiveMappingSchema): # https://github.com/common-workflow-language/cwltool/blob/67a180/cwltool/extensions.yml#L178
[docs] cudaVersionMin = ExtendedSchemaNode( String(), example="11.4", title="CUDA version minimum", description=inspect.cleandoc(""" The minimum CUDA version required to run the software. This corresponds to a CUDA SDK release. When run in a container, the container image should provide the CUDA runtime, and the host driver is injected into the container. In this case, because CUDA drivers are backwards compatible, it is possible to use an older SDK with a newer driver across major versions. See https://docs.nvidia.com/deploy/cuda-compatibility/ for details. """), validator=SemanticVersion(regex=r"^\d+\.\d+$"),
)
[docs] cudaComputeCapability = CUDAComputeCapabilitySchema()
[docs] cudaDeviceCountMin = ExtendedSchemaNode( Integer(), example=1, default=1, validator=Range(min=1), title="CUDA device count minimum", description="The minimum amount of devices required.",
)
[docs] cudaDeviceCountMax = ExtendedSchemaNode( Integer(), example=8, default=1, validator=Range(min=1), title="CUDA device count maximum", description="The maximum amount of devices required.",
)
[docs]class CUDARequirementMap(ExtendedMappingSchema):
[docs] CUDARequirement = CUDARequirementSpecification( name=CWL_REQUIREMENT_CUDA, title=CWL_REQUIREMENT_CUDA,
)
[docs]class CUDARequirementClass(CUDARequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_CUDA, validator=OneOf([CWL_REQUIREMENT_CUDA]))
[docs]class NetworkAccessRequirementSpecification(PermissiveMappingSchema):
[docs] networkAccess = ExtendedSchemaNode( Boolean(), example=True, title="Network Access", description="Indicate whether a process requires outgoing IPv4/IPv6 network access.",
)
[docs]class NetworkAccessRequirementMap(ExtendedMappingSchema):
[docs] NetworkAccessRequirement = NetworkAccessRequirementSpecification( name=CWL_REQUIREMENT_NETWORK_ACCESS, title=CWL_REQUIREMENT_NETWORK_ACCESS,
)
[docs]class NetworkAccessRequirementClass(NetworkAccessRequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_NETWORK_ACCESS, validator=OneOf([CWL_REQUIREMENT_NETWORK_ACCESS]))
[docs]class ResourceRequirementValue(OneOfKeywordSchema):
[docs] _one_of = [ ExtendedSchemaNode(Float(), validator=BoundedRange(min=0.0, exclusive_min=True)), ExtendedSchemaNode(Integer(), validator=Range(min=1)), CWLExpression,
]
[docs]class ResourceRequirementSpecification(PermissiveMappingSchema):
[docs] description = inspect.cleandoc(f""" Specify basic hardware resource requirements (see also: {CWL_CMD_TOOL_URL}#{CWL_REQUIREMENT_RESOURCE}). """)
[docs] coresMin = ResourceRequirementValue( missing=drop, default=1, title="ResourceCoresMinimum", summary="Minimum reserved number of CPU cores.", description=inspect.cleandoc(""" Minimum reserved number of CPU cores. May be a fractional value to indicate to a scheduling algorithm that one core can be allocated to multiple jobs. For example, a value of 0.25 indicates that up to 4 jobs may run in parallel on 1 core. A value of 1.25 means that up to 3 jobs can run on a 4 core system (4/1.25 ≈ 3). Processes can only share a core allocation if the sum of each of their 'ramMax', 'tmpdirMax', and 'outdirMax' requests also do not exceed the capacity of the node. Processes sharing a core must have the same level of isolation (typically a container or VM) that they would normally have. The reported number of CPU cores reserved for the process, which is available to expressions on the 'CommandLineTool' as 'runtime.cores', must be a non-zero integer, and may be calculated by rounding up the cores request to the next whole number. Scheduling systems may allocate fractional CPU resources by setting quotas or scheduling weights. Scheduling systems that do not support fractional CPUs may round up the request to the next whole number. """),
)
[docs] coresMax = ResourceRequirementValue( missing=drop, title="ResourceCoresMaximum", summary="Maximum reserved number of CPU cores.", description=inspect.cleandoc(""" Maximum reserved number of CPU cores. See 'coresMin' for discussion about fractional CPU requests. """),
)
[docs] ramMin = ResourceRequirementValue( missing=drop, default=256, title="ResourceRAMMinimum", summary="Minimum reserved RAM in mebibytes.", description=inspect.cleandoc(""" Minimum reserved RAM in mebibytes (2**20). May be a fractional value. If so, the actual RAM request must be rounded up to the next whole number. The reported amount of RAM reserved for the process, which is available to expressions on the 'CommandLineTool' as 'runtime.ram', must be a non-zero integer. """),
)
[docs] ramMax = ResourceRequirementValue( missing=drop, title="ResourceRAMMaximum", summary="Maximum reserved RAM in mebibytes.", description=inspect.cleandoc(""" Maximum reserved RAM in mebibytes (2**20). See 'ramMin' for discussion about fractional RAM requests. """),
)
[docs] tmpdirMin = ResourceRequirementValue( missing=drop, default=1024, title="ResourceTmpDirMinimum", summary="Minimum reserved filesystem based storage for the designated temporary directory in mebibytes.", description=inspect.cleandoc(""" Minimum reserved filesystem based storage for the designated temporary directory in mebibytes (2**20). May be a fractional value. If so, the actual storage request must be rounded up to the next whole number. The reported amount of storage reserved for the process, which is available to expressions on the 'CommandLineTool' as 'runtime.tmpdirSize', must be a non-zero integer. """),
)
[docs] tmpdirMax = ResourceRequirementValue( missing=drop, title="ResourceTmpDirMaximum", summary="Maximum reserved filesystem based storage for the designated temporary directory in mebibytes.", description=inspect.cleandoc(""" Maximum reserved filesystem based storage for the designated temporary directory in mebibytes (2**20). See 'tmpdirMin' for discussion about fractional storage requests. """),
)
[docs] outdirMin = ResourceRequirementValue( missing=drop, default=1024, title="ResourceOutDirMinimum", summary="Minimum reserved filesystem based storage for the designated output directory in mebibytes.", description=inspect.cleandoc(""" Minimum reserved filesystem based storage for the designated output directory in mebibytes (2**20). May be a fractional value. If so, the actual storage request must be rounded up to the next whole number. The reported amount of storage reserved for the process, which is available to expressions on the 'CommandLineTool' as runtime.outdirSize, must be a non-zero integer. """),
)
[docs] outdirMax = ResourceRequirementValue( missing=drop, default=1, title="ResourceOutDirMaximum", summary="Maximum reserved filesystem based storage for the designated output directory in mebibytes.", description=inspect.cleandoc(""" Maximum reserved filesystem based storage for the designated output directory in mebibytes (2**20). See 'outdirMin' for discussion about fractional storage requests. """),
)
[docs]class ResourceRequirementMap(ExtendedMappingSchema):
[docs] ResourceRequirement = ResourceRequirementSpecification( name=CWL_REQUIREMENT_RESOURCE, title=CWL_REQUIREMENT_RESOURCE,
)
[docs]class ResourceRequirementClass(ResourceRequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_RESOURCE, validator=OneOf([CWL_REQUIREMENT_RESOURCE]))
[docs]class DockerRequirementSpecification(PermissiveMappingSchema):
[docs] dockerPull = ExtendedSchemaNode( String(), example="docker-registry.host.com/namespace/image:1.2.3", title="Docker pull reference", description="Reference package that will be retrieved and executed by CWL."
)
[docs]class DockerRequirementMap(ExtendedMappingSchema):
[docs] DockerRequirement = DockerRequirementSpecification( name=CWL_REQUIREMENT_APP_DOCKER, title=CWL_REQUIREMENT_APP_DOCKER
)
[docs]class DockerRequirementClass(DockerRequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_APP_DOCKER, validator=OneOf([CWL_REQUIREMENT_APP_DOCKER]))
[docs]class DockerGpuRequirementSpecification(DockerRequirementSpecification):
[docs] deprecated = True
[docs] description = inspect.cleandoc(f""" Docker requirement with GPU-enabled support (https://github.com/NVIDIA/nvidia-docker). The instance must have the NVIDIA toolkit installed to use this feature. WARNING: This requirement is specific to Weaver and is preserved only for backward compatibility. Prefer the combined use of official '{CWL_REQUIREMENT_APP_DOCKER}' and '{CWL_REQUIREMENT_CUDA}' for better support of GPU capabilities and portability to other CWL-supported platforms. """)
[docs]class DockerGpuRequirementMap(ExtendedMappingSchema):
[docs] deprecated = True
[docs] req = DockerGpuRequirementSpecification(name=CWL_REQUIREMENT_APP_DOCKER_GPU)
[docs]class DockerGpuRequirementClass(DockerGpuRequirementSpecification):
[docs] deprecated = True
[docs] title = CWL_REQUIREMENT_APP_DOCKER_GPU
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_APP_DOCKER_GPU, validator=OneOf([CWL_REQUIREMENT_APP_DOCKER_GPU]))
[docs]class DirectoryListingItem(PermissiveMappingSchema):
[docs] entry = ExtendedSchemaNode(String(), missing=drop)
[docs] entryname = ExtendedSchemaNode(String(), missing=drop)
[docs] writable = ExtendedSchemaNode(Boolean(), missing=drop)
[docs]class InitialWorkDirListing(ExtendedSequenceSchema):
[docs] item = DirectoryListingItem()
[docs]class InitialWorkDirRequirementSpecification(PermissiveMappingSchema):
[docs] listing = InitialWorkDirListing()
[docs]class InitialWorkDirRequirementMap(ExtendedMappingSchema):
[docs] req = InitialWorkDirRequirementSpecification(name=CWL_REQUIREMENT_INIT_WORKDIR)
[docs]class InitialWorkDirRequirementClass(InitialWorkDirRequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_INIT_WORKDIR, validator=OneOf([CWL_REQUIREMENT_INIT_WORKDIR]))
[docs]class InlineJavascriptLibraries(ExtendedSequenceSchema):
[docs] description = inspect.cleandoc(""" Additional code fragments that will also be inserted before executing the expression code. Allows for function definitions that may be called from CWL expressions. """)
[docs] exp_lib = ExtendedSchemaNode(String(), missing=drop)
[docs]class InlineJavascriptRequirementSpecification(PermissiveMappingSchema):
[docs] description = inspect.cleandoc(f""" Indicates that the workflow platform must support inline Javascript expressions. If this requirement is not present, the workflow platform must not perform expression interpolation (see also: {CWL_CMD_TOOL_URL}#{CWL_REQUIREMENT_INLINE_JAVASCRIPT}). """)
[docs] expressionLib = InlineJavascriptLibraries(missing=drop)
[docs]class InlineJavascriptRequirementMap(ExtendedMappingSchema):
[docs] req = InlineJavascriptRequirementSpecification(name=CWL_REQUIREMENT_INLINE_JAVASCRIPT)
[docs]class InlineJavascriptRequirementClass(InlineJavascriptRequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_INLINE_JAVASCRIPT, validator=OneOf([CWL_REQUIREMENT_INLINE_JAVASCRIPT]))
[docs]class InplaceUpdateRequirementSpecification(PermissiveMappingSchema):
[docs] description = inspect.cleandoc(f""" If 'inplaceUpdate' is true, then an implementation supporting this feature may permit tools to directly update files with 'writable: true' in '{CWL_REQUIREMENT_INIT_WORKDIR}'. That is, as an optimization, files may be destructively modified in place as opposed to copied and updated (see also: {CWL_CMD_TOOL_URL}#{CWL_REQUIREMENT_INPLACE_UPDATE}). """)
[docs] inplaceUpdate = ExtendedSchemaNode(Boolean())
[docs]class InplaceUpdateRequirementMap(ExtendedMappingSchema):
[docs] req = InplaceUpdateRequirementSpecification(name=CWL_REQUIREMENT_INPLACE_UPDATE)
[docs]class InplaceUpdateRequirementClass(InplaceUpdateRequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_INPLACE_UPDATE, validator=OneOf([CWL_REQUIREMENT_INPLACE_UPDATE]))
[docs]class LoadListingEnum(ExtendedSchemaNode):
[docs] schema_type = String
[docs] title = "LoadListingEnum"
[docs] validator = OneOf(["no_listing", "shallow_listing", "deep_listing"])
[docs]class LoadListingRequirementSpecification(PermissiveMappingSchema):
[docs] description = ( "Specify the desired behavior for loading the listing field of a 'Directory' object for use by expressions "
f"(see also: {CWL_CMD_TOOL_URL}#{CWL_REQUIREMENT_LOAD_LISTING})." )
[docs] loadListing = LoadListingEnum()
[docs]class LoadListingRequirementMap(ExtendedMappingSchema):
[docs] req = LoadListingRequirementSpecification(name=CWL_REQUIREMENT_LOAD_LISTING)
[docs]class LoadListingRequirementClass(LoadListingRequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_LOAD_LISTING, validator=OneOf([CWL_REQUIREMENT_LOAD_LISTING]))
[docs]class IdentifierArray(ExtendedSequenceSchema):
[docs] item = AnyIdentifier()
[docs]class ScatterIdentifiersSchema(OneOfKeywordSchema):
[docs] title = "Scatter"
[docs] description = inspect.cleandoc(""" The scatter field specifies one or more input parameters which will be scattered. An input parameter may be listed more than once. The declared type of each input parameter implicitly becomes an array of items of the input parameter type. If a parameter is listed more than once, it becomes a nested array. As a result, upstream parameters which are connected to scattered parameters must be arrays. All output parameter types are also implicitly wrapped in arrays. Each job in the scatter results in an entry in the output array. If any scattered parameter runtime value is an empty array, all outputs are set to empty arrays and no work is done for the step, according to applicable scattering rules. """)
[docs] _one_of = [ AnyIdentifier(), IdentifierArray(validator=Length(min=1)),
]
[docs]class ScatterFeatureRequirementSpecification(PermissiveMappingSchema):
[docs] description = inspect.cleandoc(f""" A 'scatter' operation specifies that the associated Workflow step should execute separately over a list of input elements. Each job making up a scatter operation is independent and may be executed concurrently (see also: {CWL_WORKFLOW_URL}#WorkflowStep). """)
[docs] scatter = ScatterIdentifiersSchema()
[docs] scatterMethod = ExtendedSchemaNode( String(), validator=OneOf(["dotproduct", "nested_crossproduct", "flat_crossproduct"]), default="dotproduct", missing=drop, description=inspect.cleandoc(""" If 'scatter' declares more than one input parameter, 'scatterMethod' describes how to decompose the input into a discrete set of jobs. - dotproduct: specifies that each of the input arrays are aligned and one element taken from each array to construct each job. It is an error if all input arrays are not the same length. - nested_crossproduct: specifies the Cartesian product of the inputs, producing a job for every combination of the scattered inputs. The output must be nested arrays for each level of scattering, in the order that the input arrays are listed in the 'scatter' field. - flat_crossproduct: specifies the Cartesian product of the inputs, producing a job for every combination of the scattered inputs. The output arrays must be flattened to a single level, but otherwise listed in the order that the input arrays are listed in the 'scatter' field. """)
)
[docs]class ScatterFeatureRequirementMap(ExtendedMappingSchema):
[docs] req = ScatterFeatureRequirementSpecification(name=CWL_REQUIREMENT_SCATTER)
[docs]class ScatterFeatureRequirementClass(ScatterFeatureRequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_SCATTER, validator=OneOf([CWL_REQUIREMENT_SCATTER]))
[docs]class TimeLimitValue(OneOfKeywordSchema):
[docs] _one_of = [ ExtendedSchemaNode(Float(), validator=Range(min=0.0)), ExtendedSchemaNode(Integer(), validator=Range(min=0)), CWLExpression,
]
[docs]class ToolTimeLimitRequirementSpecification(PermissiveMappingSchema):
[docs] description = inspect.cleandoc(""" Set an upper limit on the execution time of a CommandLineTool. A CommandLineTool whose execution duration exceeds the time limit may be preemptively terminated and considered failed. May also be used by batch systems to make scheduling decisions. The execution duration excludes external operations, such as staging of files, pulling a docker image etc., and only counts wall-time for the execution of the command line itself. """)
[docs] timelimit = TimeLimitValue( description=inspect.cleandoc(""" The time limit, in seconds. A time limit of zero means no time limit. Negative time limits are an error. """)
)
[docs]class ToolTimeLimitRequirementMap(ExtendedMappingSchema):
[docs] req = ToolTimeLimitRequirementSpecification(name=CWL_REQUIREMENT_TIME_LIMIT)
[docs]class ToolTimeLimitRequirementClass(ToolTimeLimitRequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_TIME_LIMIT, validator=OneOf([CWL_REQUIREMENT_TIME_LIMIT]))
[docs]class EnableReuseValue(OneOfKeywordSchema):
[docs] _one_of = [ ExtendedSchemaNode(Boolean(allow_string=False)), CWLExpression,
]
[docs]class WorkReuseRequirementSpecification(PermissiveMappingSchema):
[docs] description = inspect.cleandoc(f""" For implementations that support reusing output from past work (on the assumption that same code and same input produce same results), control whether to enable or disable the reuse behavior for a particular tool or step (to accommodate situations where that assumption is incorrect). A reused step is not executed but instead returns the same output as the original execution. If '{CWL_REQUIREMENT_WORK_REUSE}' is not specified, correct tools should assume it is enabled by default. """)
[docs] enableReuse = EnableReuseValue( description=inspect.cleandoc(f""" Indicates if reuse is enabled for this tool. Can be an expression when combined with '{CWL_REQUIREMENT_INLINE_JAVASCRIPT}' (see also: {CWL_CMD_TOOL_URL}#Expression). """)
)
[docs]class WorkReuseRequirementMap(ExtendedMappingSchema):
[docs] req = WorkReuseRequirementSpecification(name=CWL_REQUIREMENT_WORK_REUSE)
[docs]class WorkReuseRequirementClass(WorkReuseRequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_WORK_REUSE, validator=OneOf([CWL_REQUIREMENT_WORK_REUSE]))
[docs]class BuiltinRequirementSpecification(PermissiveMappingSchema):
[docs] title = CWL_REQUIREMENT_APP_BUILTIN
[docs] description = ( "Hint indicating that the Application Package corresponds to a builtin process of "
"this instance. (note: can only be an 'hint' as it is unofficial CWL specification)." )
[docs] process = AnyIdentifier(description="Builtin process identifier.")
[docs]class BuiltinRequirementMap(ExtendedMappingSchema):
[docs] req = BuiltinRequirementSpecification(name=CWL_REQUIREMENT_APP_BUILTIN)
[docs]class BuiltinRequirementClass(BuiltinRequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_APP_BUILTIN, validator=OneOf([CWL_REQUIREMENT_APP_BUILTIN]))
[docs]class ESGF_CWT_RequirementSpecification(PermissiveMappingSchema): # noqa: N802
[docs] title = CWL_REQUIREMENT_APP_ESGF_CWT
[docs] description = ( "Hint indicating that the Application Package corresponds to an ESGF-CWT provider process"
"that should be remotely executed and monitored by this instance. " "(note: can only be an 'hint' as it is unofficial CWL specification)." )
[docs] process = AnyIdentifier(description="Process identifier of the remote ESGF-CWT provider.")
[docs] provider = URL(description="ESGF-CWT provider endpoint.")
[docs]class ESGF_CWT_RequirementMap(ExtendedMappingSchema): # noqa: N802
[docs] req = ESGF_CWT_RequirementSpecification(name=CWL_REQUIREMENT_APP_ESGF_CWT)
[docs]class ESGF_CWT_RequirementClass(ESGF_CWT_RequirementSpecification): # noqa: N802
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_APP_ESGF_CWT, validator=OneOf([CWL_REQUIREMENT_APP_ESGF_CWT]))
[docs]class OGCAPIRequirementSpecification(PermissiveMappingSchema):
[docs] title = CWL_REQUIREMENT_APP_OGC_API
[docs] description = ( "Hint indicating that the Application Package corresponds to an OGC API - Processes provider"
"that should be remotely executed and monitored by this instance. " "(note: can only be an 'hint' as it is unofficial CWL specification)." )
[docs] process = ReferenceURL(description="Process URL of the remote OGC API Process.")
[docs]class OGCAPIRequirementMap(ExtendedMappingSchema):
[docs] req = OGCAPIRequirementSpecification(name=CWL_REQUIREMENT_APP_OGC_API)
[docs]class OGCAPIRequirementClass(OGCAPIRequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_APP_OGC_API, validator=OneOf([CWL_REQUIREMENT_APP_OGC_API]))
[docs]class WPS1RequirementSpecification(PermissiveMappingSchema):
[docs] title = CWL_REQUIREMENT_APP_WPS1
[docs] description = ( "Hint indicating that the Application Package corresponds to a WPS-1 provider process"
"that should be remotely executed and monitored by this instance. " "(note: can only be an 'hint' as it is unofficial CWL specification)." )
[docs] process = AnyIdentifier(description="Process identifier of the remote WPS provider.")
[docs] provider = URL(description="WPS provider endpoint.")
[docs]class WPS1RequirementMap(ExtendedMappingSchema):
[docs] req = WPS1RequirementSpecification(name=CWL_REQUIREMENT_APP_WPS1)
[docs]class WPS1RequirementClass(WPS1RequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_APP_WPS1, validator=OneOf([CWL_REQUIREMENT_APP_WPS1]))
[docs]class UnknownRequirementMap(PermissiveMappingSchema):
[docs] description = "Generic schema to allow alternative CWL requirements/hints not explicitly defined in schemas."
[docs]class UnknownRequirementClass(PermissiveMappingSchema):
[docs] _class = RequirementClass(example="UnknownRequirement")
[docs]class CWLRequirementsMap(AnyOfKeywordSchema):
[docs] _any_of = [ DockerRequirementMap(missing=drop), DockerGpuRequirementMap(missing=drop), InitialWorkDirRequirementMap(missing=drop), InlineJavascriptRequirementMap(missing=drop), InplaceUpdateRequirementMap(missing=drop), LoadListingRequirementMap(missing=drop), NetworkAccessRequirementMap(missing=drop), ResourceRequirementMap(missing=drop), ScatterFeatureRequirementMap(missing=drop), ToolTimeLimitRequirementMap(missing=drop), WorkReuseRequirementMap(missing=drop), UnknownRequirementMap(missing=drop), # allows anything, must be last
]
[docs]class CWLRequirementsItem(OneOfKeywordSchema): # in case there is any conflict between definitions, # the class field can be used to discriminate which one is expected.
[docs] discriminator = "class"
[docs] _one_of = [ DockerRequirementClass(missing=drop), DockerGpuRequirementClass(missing=drop), InitialWorkDirRequirementClass(missing=drop), InlineJavascriptRequirementClass(missing=drop), InplaceUpdateRequirementClass(missing=drop), LoadListingRequirementClass(missing=drop), NetworkAccessRequirementClass(missing=drop), ResourceRequirementClass(missing=drop), ScatterFeatureRequirementClass(missing=drop), ToolTimeLimitRequirementClass(missing=drop), WorkReuseRequirementClass(missing=drop), UnknownRequirementClass(missing=drop), # allows anything, must be last
]
[docs]class CWLRequirementsList(ExtendedSequenceSchema):
[docs] requirement = CWLRequirementsItem()
[docs]class CWLRequirements(OneOfKeywordSchema):
[docs] _one_of = [ CWLRequirementsMap(), CWLRequirementsList(),
]
[docs]class CWLHintsMap(AnyOfKeywordSchema, PermissiveMappingSchema):
[docs] _any_of = [ BuiltinRequirementMap(missing=drop), CUDARequirementMap(missing=drop), DockerRequirementMap(missing=drop), DockerGpuRequirementMap(missing=drop), InitialWorkDirRequirementMap(missing=drop), InlineJavascriptRequirementMap(missing=drop), InplaceUpdateRequirementMap(missing=drop), LoadListingRequirementMap(missing=drop), NetworkAccessRequirementMap(missing=drop), ResourceRequirementMap(missing=drop), ScatterFeatureRequirementMap(missing=drop), ToolTimeLimitRequirementMap(missing=drop), WorkReuseRequirementMap(missing=drop), ESGF_CWT_RequirementMap(missing=drop), OGCAPIRequirementMap(missing=drop), WPS1RequirementMap(missing=drop), UnknownRequirementMap(missing=drop), # allows anything, must be last
]
[docs]class CWLHintsItem(OneOfKeywordSchema, PermissiveMappingSchema): # validators of individual requirements define which one applies # in case of ambiguity, 'discriminator' distinguish between them using their 'example' values in 'class' field
[docs] discriminator = "class"
[docs] _one_of = [ BuiltinRequirementClass(missing=drop), CUDARequirementClass(missing=drop), DockerRequirementClass(missing=drop), DockerGpuRequirementClass(missing=drop), InitialWorkDirRequirementClass(missing=drop), InlineJavascriptRequirementClass(missing=drop), InplaceUpdateRequirementClass(missing=drop), LoadListingRequirementClass(missing=drop), NetworkAccessRequirementClass(missing=drop), ResourceRequirementClass(missing=drop), ScatterFeatureRequirementClass(missing=drop), ToolTimeLimitRequirementClass(missing=drop), WorkReuseRequirementClass(missing=drop), ESGF_CWT_RequirementClass(missing=drop), OGCAPIRequirementClass(missing=drop), WPS1RequirementClass(missing=drop), UnknownRequirementClass(missing=drop), # allows anything, must be last
]
[docs]class CWLHintsList(ExtendedSequenceSchema):
[docs] hint = CWLHintsItem()
[docs]class CWLHints(OneOfKeywordSchema):
[docs] _one_of = [ CWLHintsMap(), CWLHintsList(),
]
[docs]class CWLArguments(ExtendedSequenceSchema):
[docs] argument = ExtendedSchemaNode(String())
[docs]class CWLTypeString(ExtendedSchemaNode):
[docs] schema_type = String
[docs] description = "Field type definition."
[docs] example = "float"
[docs] validator = OneOf(PACKAGE_TYPE_POSSIBLE_VALUES)
[docs]class CWLTypeSymbolValues(OneOfKeywordSchema):
[docs] _one_of = [ ExtendedSchemaNode(Float()), ExtendedSchemaNode(Integer()), ExtendedSchemaNode(String()),
]
[docs]class CWLTypeSymbols(ExtendedSequenceSchema):
[docs] symbol = CWLTypeSymbolValues()
[docs]class CWLTypeArray(ExtendedMappingSchema):
[docs] type = ExtendedSchemaNode(String(), example=PACKAGE_ARRAY_BASE, validator=OneOf([PACKAGE_ARRAY_BASE]))
[docs] items = CWLTypeString(title="CWLTypeArrayItems", validator=OneOf(PACKAGE_ARRAY_ITEMS))
[docs]class CWLTypeEnum(ExtendedMappingSchema):
[docs] type = ExtendedSchemaNode(String(), example=PACKAGE_ENUM_BASE, validator=OneOf(PACKAGE_CUSTOM_TYPES))
[docs] symbols = CWLTypeSymbols(summary="Allowed values composing the enum.")
[docs]class CWLTypeBase(OneOfKeywordSchema):
[docs] _one_of = [ CWLTypeString(summary="CWL type as literal value."), CWLTypeArray(summary="CWL type as list of items."), CWLTypeEnum(summary="CWL type as enum of values."),
]
[docs]class CWLTypeList(ExtendedSequenceSchema):
[docs] type = CWLTypeBase()
[docs]class CWLType(OneOfKeywordSchema):
[docs] title = "CWL Type"
[docs] _one_of = [ CWLTypeBase(summary="CWL type definition."), CWLTypeList(summary="Combination of allowed CWL types."),
]
[docs]class AnyLiteralList(ExtendedSequenceSchema):
[docs] default = AnyLiteralType()
[docs]class CWLDefault(OneOfKeywordSchema):
[docs] _one_of = [ AnyLiteralType(), AnyLiteralList(),
]
[docs]class CWLInputObject(PermissiveMappingSchema):
[docs] type = CWLType()
[docs] default = CWLDefault(missing=drop, description="Default value of input if not provided for task execution.")
[docs] inputBinding = PermissiveMappingSchema(missing=drop, title="Input Binding", description="Defines how to specify the input for the command.")
[docs]class CWLTypeStringList(ExtendedSequenceSchema):
[docs] description = "List of allowed direct CWL type specifications as strings."
[docs] type = CWLType()
[docs]class CWLInputType(OneOfKeywordSchema):
[docs] description = "CWL type definition of the input."
[docs] _one_of = [ CWLTypeString(summary="Direct CWL type string specification."), CWLTypeStringList(summary="List of allowed CWL type strings."), CWLInputObject(summary="CWL type definition with parameters."),
]
[docs]class CWLInputMap(PermissiveMappingSchema):
[docs] input_id = CWLInputType(variable="{input-id}", title="CWLInputDefinition", description=IO_INFO_IDS.format(first="CWL", second="WPS", what="input") + " (Note: '{input-id}' is a variable corresponding for each identifier)")
[docs]class CWLInputItem(CWLInputObject):
[docs] id = AnyIdentifier(description=IO_INFO_IDS.format(first="CWL", second="WPS", what="input"))
[docs]class CWLInputList(ExtendedSequenceSchema):
[docs] input = CWLInputItem(title="Input", description=f"Input specification. {CWL_DOC_MESSAGE}")
[docs]class CWLInputEmpty(EmptyMappingSchema): pass
[docs]class CWLInputsDefinition(OneOfKeywordSchema):
[docs] _one_of = [ CWLInputList(description="Package inputs defined as items."), CWLInputMap(description="Package inputs defined as mapping."), CWLInputEmpty(description="Package inputs as empty mapping when it takes no arguments."),
]
[docs]class OutputBinding(PermissiveMappingSchema):
[docs] glob = ExtendedSchemaNode(String(), missing=drop, description="Glob pattern to find the output on disk or mounted docker volume.")
[docs]class CWLOutputObject(PermissiveMappingSchema):
[docs] type = CWLType()
# 'outputBinding' should usually be there most of the time (if not always) to retrieve file, # but can technically be omitted in some very specific use-cases such as output literal or output is std logs
[docs] outputBinding = OutputBinding( missing=drop, description="Defines how to retrieve the output result from the command."
)
[docs]class CWLOutputType(OneOfKeywordSchema):
[docs] _one_of = [ CWLTypeString(summary="Direct CWL type string specification."), CWLTypeStringList(summary="List of allowed CWL type strings."), CWLOutputObject(summary="CWL type definition with parameters."),
]
[docs]class CWLOutputMap(ExtendedMappingSchema):
[docs] output_id = CWLOutputType(variable="{output-id}", title="CWLOutputDefinition", description=IO_INFO_IDS.format(first="CWL", second="WPS", what="output") + " (Note: '{output-id}' is a variable corresponding for each identifier)")
[docs]class CWLOutputItem(CWLOutputObject):
[docs] id = AnyIdentifier(description=IO_INFO_IDS.format(first="CWL", second="WPS", what="output"))
[docs]class CWLOutputList(ExtendedSequenceSchema):
[docs] input = CWLOutputItem(description=f"Output specification. {CWL_DOC_MESSAGE}")
[docs]class CWLOutputsDefinition(OneOfKeywordSchema):
[docs] _one_of = [ CWLOutputList(description="Package outputs defined as items."), CWLOutputMap(description="Package outputs defined as mapping."),
]
[docs]class CWLCommandParts(ExtendedSequenceSchema):
[docs] cmd = ExtendedSchemaNode(String())
[docs]class CWLCommand(OneOfKeywordSchema):
[docs] _one_of = [ ExtendedSchemaNode(String(), title="String command."), CWLCommandParts(title="Command Parts")
]
[docs]class CWLVersion(Version):
[docs] description = "CWL version of the described application package."
[docs] example = CWL_VERSION
[docs] validator = SemanticVersion(v_prefix=True, rc_suffix=False)
[docs]class CWLIdentifier(ProcessIdentifier):
[docs] description = ( "Reference to the process identifier. If CWL is provided within a process deployment payload, this can be "
"omitted. If used in a deployment with only CWL details, this information is required." )
[docs]class CWLIntentURL(URL):
[docs] description = ( "Identifier URL to a concept for the type of computational operation accomplished by this Process "
"(see example operations: http://edamontology.org/operation_0004)." )
[docs]class CWLIntent(ExtendedSequenceSchema):
[docs] item = CWLIntentURL()
[docs]class CWLBase(ExtendedMappingSchema):
[docs] cwlVersion = CWLVersion()
[docs]class CWLScatterMulti(ExtendedSequenceSchema):
[docs] id = CWLIdentifier("")
[docs]class CWLScatter(OneOfKeywordSchema):