"""
This module should contain any and every definitions in use to build the swagger UI,
so that one can update the swagger without touching any other files after the initial integration
"""
# pylint: disable=C0103,invalid-name
import os
from typing import TYPE_CHECKING
import yaml
from colander import DateTime, Email, OneOf, Range, Regex, drop, required
from cornice import Service
from dateutil import parser as dateparser
from weaver import __meta__
from weaver.config import WEAVER_CONFIGURATION_EMS
from weaver.execute import (
EXECUTE_CONTROL_OPTION_ASYNC,
EXECUTE_CONTROL_OPTIONS,
EXECUTE_MODE_ASYNC,
EXECUTE_MODE_OPTIONS,
EXECUTE_RESPONSE_DOCUMENT,
EXECUTE_RESPONSE_OPTIONS,
EXECUTE_TRANSMISSION_MODE_OPTIONS,
EXECUTE_TRANSMISSION_MODE_REFERENCE
)
from weaver.formats import (
ACCEPT_LANGUAGE_EN_CA,
ACCEPT_LANGUAGE_EN_US,
ACCEPT_LANGUAGES,
CONTENT_TYPE_ANY,
CONTENT_TYPE_APP_JSON,
CONTENT_TYPE_APP_XML,
CONTENT_TYPE_TEXT_HTML,
CONTENT_TYPE_TEXT_PLAIN,
CONTENT_TYPE_TEXT_XML
)
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_WPS1,
CWL_REQUIREMENT_INIT_WORKDIR,
PACKAGE_ARRAY_BASE,
PACKAGE_ARRAY_ITEMS,
PACKAGE_CUSTOM_TYPES,
PACKAGE_ENUM_BASE,
PACKAGE_TYPE_POSSIBLE_VALUES
)
from weaver.sort import JOB_SORT_VALUES, QUOTE_SORT_VALUES, SORT_CREATED, SORT_ID, SORT_PROCESS
from weaver.status import JOB_STATUS_CATEGORIES, STATUS_ACCEPTED, STATUS_COMPLIANT_OGC
from weaver.visibility import VISIBILITY_PUBLIC, VISIBILITY_VALUES
from weaver.wps_restapi.colander_extras import (
AllOfKeywordSchema,
AnyOfKeywordSchema,
ExtendedBoolean as Boolean,
ExtendedFloat as Float,
ExtendedInteger as Integer,
ExtendedMappingSchema,
ExtendedSchemaNode,
ExtendedSequenceSchema,
ExtendedString as String,
NotKeywordSchema,
OneOfCaseInsensitive,
OneOfKeywordSchema,
PermissiveMappingSchema,
SchemeURL,
SemanticVersion,
StringRange,
XMLObject
)
from weaver.wps_restapi.utils import wps_restapi_base_path
if TYPE_CHECKING:
from weaver.typedefs import DatetimeIntervalType, SettingsType, TypedDict
[docs] ViewInfo = TypedDict("ViewInfo", {"name": str, "pattern": str})
[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": "{} documentation".format(__meta__.__title__),
"url": __meta__.__documentation_url__
}
[docs]DOC_URL = "{}/en/latest".format(__meta__.__documentation_url__)
[docs]CWL_REPO_URL = "https://github.com/common-workflow-language"
[docs]CWL_BASE_URL = "https://www.commonwl.org"
[docs]CWL_SPEC_URL = "{}/#Specification".format(CWL_BASE_URL)
[docs]CWL_USER_GUIDE_URL = "{}/user_guide".format(CWL_BASE_URL)
[docs]CWL_WORKFLOW_URL = "{}/{}/Workflow.html".format(CWL_BASE_URL, CWL_VERSION)
[docs]CWL_DOC_MESSAGE = (
"Note that multiple formats are supported and not all specification variants or parameters "
"are presented here. Please refer to official CWL documentation for more details "
"({}).".format(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."
)
[docs]OGC_API_REPO_URL = "https://github.com/opengeospatial/ogcapi-processes"
[docs]OGC_API_SCHEMA_URL = "https://raw.githubusercontent.com/opengeospatial/ogcapi-processes"
[docs]DATETIME_INTERVAL_CLOSED_SYMBOL = "/"
[docs]DATETIME_INTERVAL_OPEN_START_SYMBOL = "../"
[docs]DATETIME_INTERVAL_OPEN_END_SYMBOL = "/.."
#########################################################
# Examples
#########################################################
# load examples by file names as keys
[docs]SCHEMA_EXAMPLE_DIR = os.path.join(os.path.dirname(__file__), "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") 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_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_EXCEPTIONS = "Exceptions"
[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]openapi_json_service = Service(name="openapi_json", path="/json")
[docs]quotes_service = Service(name="quotes", path="/quotations")
[docs]quote_service = Service(name="quote", path=quotes_service.path + "/{quote_id}")
[docs]bills_service = Service(name="bills", path="/bills")
[docs]bill_service = Service(name="bill", path=bills_service.path + "/{bill_id}")
[docs]jobs_service = Service(name="jobs", path="/jobs")
[docs]job_service = Service(name="job", path=jobs_service.path + "/{job_id}")
[docs]job_results_service = Service(name="job_results", path=job_service.path + "/results")
[docs]job_exceptions_service = Service(name="job_exceptions", path=job_service.path + "/exceptions")
[docs]job_outputs_service = Service(name="job_outputs", path=job_service.path + "/outputs")
[docs]job_logs_service = Service(name="job_logs", path=job_service.path + "/logs")
[docs]processes_service = Service(name="processes", path="/processes")
[docs]process_service = Service(name="process", path=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_visibility_service = Service(name="process_visibility", path=process_service.path + "/visibility")
[docs]process_package_service = Service(name="process_package", path=process_service.path + "/package")
[docs]process_payload_service = Service(name="process_payload", path=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_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_execution_service = Service(name="process_execution", path=process_service.path + "/execution")
[docs]providers_service = Service(name="providers", path="/providers")
[docs]provider_service = Service(name="provider", path=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_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_exceptions_service = Service(name="provider_exceptions",
path=provider_service.path + process_exceptions_service.path)
# backward compatibility deprecated routes
[docs]job_result_service = Service(name="job_result", path=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)
#########################################################
# Generic schemas
#########################################################
[docs]class SLUG(ExtendedSchemaNode):
[docs] description = "Slug name pattern."
[docs] example = "some-object-slug-name"
[docs] pattern = "^[A-Za-z0-9]+(?:(-|_)[A-Za-z0-9]+)*$"
[docs]class URL(ExtendedSchemaNode):
[docs] description = "URL reference."
[docs]class DateTimeInterval(ExtendedSchemaNode):
[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 = r"(\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(\.\d+)?(([+-]\d\d:\d\d)|Z)?)"
[docs] regex_interval_closed = r"{i}\/{i}".format(i=regex_datetime)
[docs] regex_interval_open_start = r"\.\.\/{}".format(regex_datetime)
[docs] regex_interval_open_end = r"{}\/\.\.".format(regex_datetime)
[docs] pattern = "^{}|{}|{}|{}$".format(regex_datetime, regex_interval_closed,
regex_interval_open_start, regex_interval_open_end)
[docs]class S3Bucket(ExtendedSchemaNode):
[docs] description = "S3 bucket shorthand URL representation [s3://<bucket>/<job-uuid>/<output>.ext]"
[docs] pattern = r"^s3://\S+$"
[docs]class FileLocal(ExtendedSchemaNode):
[docs] description = "Local file reference."
[docs] validator = Regex(r"^(file://)?(?:/|[/?]\S+)$")
[docs]class FileURL(ExtendedSchemaNode):
[docs] description = "URL file reference."
[docs] validator = SchemeURL(schemes=["http", "https"])
[docs]class ReferenceURL(AnyOfKeywordSchema):
[docs] _any_of = [
FileURL(),
FileLocal(),
S3Bucket(),
]
[docs]class UUID(ExtendedSchemaNode):
[docs] description = "Unique identifier."
[docs] example = "a9d14bf4-84e0-449a-bac8-16e598efe807"
[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 Version(ExtendedSchemaNode):
# note: internally use LooseVersion, so don't be too strict about pattern
[docs] description = "Version string."
[docs] validator = SemanticVersion()
# FIXME: oneOf validator for supported languages (?)
]
]
"""Headers describing resulting response."""
[docs]class NoContent(ExtendedMappingSchema):
[docs] description = "Empty response body."
[docs]class KeywordList(ExtendedSequenceSchema):
[docs] keyword = ExtendedSchemaNode(String())
[docs]class Language(ExtendedSchemaNode):
[docs] example = ACCEPT_LANGUAGE_EN_CA
[docs] validator = OneOf(ACCEPT_LANGUAGES)
[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 LinkRelationship(ExtendedMappingSchema):
[docs] rel = SLUG(description="Relationship of the link to the current content.")
[docs]class LinkBase(LinkLanguage, MetadataBase):
[docs] href = URL(description="Hyperlink reference.")
[docs]class Link(LinkRelationship, LinkBase):
pass
[docs]class MetadataContent(OneOfKeywordSchema):
[docs] _one_of = [
Link(title="MetadataLink"),
MetadataValue(),
]
[docs]class LinkList(ExtendedSequenceSchema):
[docs] description = "List of links relative to the applicable object."
[docs]class LandingPage(ExtendedMappingSchema):
[docs] links = LinkList()
"allowed or supported formats was matched nor provided as input during job submission."
)
)
[docs]class AdditionalParameterValuesList(ExtendedSequenceSchema):
[docs] values = ExtendedSchemaNode(String())
[docs]class AdditionalParameter(ExtendedMappingSchema):
[docs] name = ExtendedSchemaNode(String())
[docs] values = AdditionalParameterValuesList()
[docs]class AdditionalParameterList(ExtendedSequenceSchema):
[docs] additionalParameter = AdditionalParameter()
[docs]class AdditionalParameters(ExtendedMappingSchema):
[docs] parameters = AdditionalParameterList()
[docs]class AdditionalParametersItem(AnyOfKeywordSchema):
[docs] _any_of = [
AdditionalParametersMeta(missind=drop),
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 name definition of the process.")
[docs] abstract = ExtendedSchemaNode(String(), missing=drop, description="Detailed explanation of the process operation.")
[docs] links = LinkList(missing=drop, description="References to endpoints with information related to the process.")
[docs]class DescriptionOWS(ExtendedMappingSchema):
[docs] owsContext = OWSContext(missing=drop)
[docs]class DescriptionType(DescriptionBase, DescriptionExtra):
pass
[docs]class MinOccursDefinition(OneOfKeywordSchema):
[docs] description = "Minimum amount of values required for this input."
[docs] _one_of = [
ExtendedSchemaNode(Integer(), validator=Range(min=0),
description="Positive integer."),
ExtendedSchemaNode(String(), validator=StringRange(min=0), pattern="^[0-9]+$",
description="Numerical string representing a positive integer."),
]
[docs]class MaxOccursDefinition(OneOfKeywordSchema):
[docs] description = "Maximum amount of values allowed for this input."
[docs] _one_of = [
ExtendedSchemaNode(Integer(), validator=Range(min=0),
description="Positive integer."),
ExtendedSchemaNode(String(), validator=StringRange(min=0), pattern="^[0-9]+$",
description="Numerical string representing a positive integer."),
ExtendedSchemaNode(String(), validator=OneOf(["unbounded"])),
]
[docs]class WithMinMaxOccurs(ExtendedMappingSchema):
[docs] minOccurs = MinOccursDefinition(missing=drop)
[docs] maxOccurs = MaxOccursDefinition(missing=drop)
[docs]class ProcessDescriptionType(DescriptionType, DescriptionOWS):
[docs] id = ProcessIdentifier()
[docs]class OutputIdentifierType(ExtendedMappingSchema):
[docs] id = AnyIdentifier(description=IO_INFO_IDS.format(first="WPS", second="CWL", what="output"))
[docs]class OutputDescriptionType(OutputIdentifierType, DescriptionType, InputOutputDescriptionMeta):
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 LiteralReference(ExtendedMappingSchema):
[docs] reference = ReferenceURL()
[docs]class NameReferenceType(ExtendedMappingSchema):
[docs] schema_ref = "{}/master/core/openapi/schemas/nameReferenceType.yaml".format(OGC_API_SCHEMA_URL)
[docs] name = ExtendedSchemaNode(String())
[docs] reference = ReferenceURL(missing=drop)
[docs]class DataTypeSchema(NameReferenceType):
[docs] description = "Type of the literal data representation."
[docs]class UomSchema(NameReferenceType):
[docs] title = "UnitOfMeasure"
[docs]class AllowedValuesList(ExtendedSequenceSchema):
[docs] allowedValues = ExtendedSchemaNode(String())
[docs]class AllowedValues(ExtendedMappingSchema):
[docs] allowedValues = AllowedValuesList()
[docs]class AllowedRange(ExtendedMappingSchema):
[docs] minimumValue = ExtendedSchemaNode(String(), missing=drop)
[docs] maximumValue = ExtendedSchemaNode(String(), missing=drop)
[docs] spacing = ExtendedSchemaNode(String(), missing=drop)
[docs] rangeClosure = ExtendedSchemaNode(String(), missing=drop,
validator=OneOf(["closed", "open", "open-closed", "closed-open"]))
[docs]class AllowedRangesList(ExtendedSequenceSchema):
[docs] allowedRanges = AllowedRange()
[docs]class AllowedRanges(ExtendedMappingSchema):
[docs] allowedRanges = AllowedRangesList()
[docs]class AnyValue(ExtendedMappingSchema):
[docs] anyValue = ExtendedSchemaNode(Boolean(), missing=drop, default=True)
[docs]class ValuesReference(ExtendedMappingSchema):
[docs] valueReference = ReferenceURL()
[docs]class AnyLiteralType(OneOfKeywordSchema):
"""
.. seealso::
- :class:`AnyLiteralDataType`
- :class:`AnyLiteralValueType`
- :class:`AnyLiteralDefaultType`
"""
[docs] _one_of = [
ExtendedSchemaNode(Float()),
ExtendedSchemaNode(Integer()),
ExtendedSchemaNode(Boolean()),
ExtendedSchemaNode(String()),
]
[docs]class AnyLiteralDataType(ExtendedMappingSchema):
[docs] data = AnyLiteralType()
[docs]class AnyLiteralValueType(ExtendedMappingSchema):
[docs] value = AnyLiteralType()
[docs]class AnyLiteralDefaultType(ExtendedMappingSchema):
[docs] default = AnyLiteralType()
[docs]class LiteralDataDomainDefinition(ExtendedMappingSchema):
[docs] default = AnyLiteralDefaultType()
[docs] defaultValue = ExtendedSchemaNode(String(), missing=drop)
[docs] dataType = DataTypeSchema(missing=drop)
[docs] uom = UomSchema(missing=drop)
[docs]class LiteralDataDomainConstraints(OneOfKeywordSchema, LiteralDataDomainDefinition):
[docs] _one_of = [
AllowedValues,
AllowedRanges,
ValuesReference,
AnyValue, # must be last because it"s the most permissive (always valid, default)
]
[docs]class LiteralDataDomainList(ExtendedSequenceSchema):
[docs] literalDataDomain = LiteralDataDomainConstraints()
]
]
[docs]class LiteralOutputType(NotKeywordSchema, ExtendedMappingSchema):
]
[docs] literalDataDomains = LiteralDataDomainList(missing=drop)
[docs]class BoundingBoxOutputType(ExtendedMappingSchema):
[docs] supportedCRS = SupportedCRSList()
[docs]class ComplexOutputType(WithFormats):
pass
[docs]class OutputTypeDefinition(OneOfKeywordSchema):
[docs] _one_of = [
BoundingBoxOutputType,
ComplexOutputType, # should be 2nd to last because very permissive, but requires format at least
LiteralOutputType, # must be last because it's the most permissive (all can default if omitted)
]
[docs]class OutputType(AllOfKeywordSchema):
[docs] _all_of = [
OutputTypeDefinition(),
OutputDescriptionType(),
]
[docs]class OutputDescriptionList(ExtendedSequenceSchema):
[docs]class JobExecuteModeEnum(ExtendedSchemaNode):
[docs] title = "JobExecuteMode"
# no default to enforce required input as per OGC-API schemas
# https://github.com/opengeospatial/ogcapi-processes/blob/master/core/openapi/schemas/execute.yaml
# default = EXECUTE_MODE_AUTO
[docs] example = EXECUTE_MODE_ASYNC
[docs] validator = OneOf(EXECUTE_MODE_OPTIONS)
[docs]class JobControlOptionsEnum(ExtendedSchemaNode):
[docs] title = "JobControlOptions"
[docs] default = EXECUTE_CONTROL_OPTION_ASYNC
[docs] example = EXECUTE_CONTROL_OPTION_ASYNC
[docs] validator = OneOf(EXECUTE_CONTROL_OPTIONS)
[docs]class JobResponseOptionsEnum(ExtendedSchemaNode):
[docs] title = "JobResponseOptions"
# no default to enforce required input as per OGC-API schemas
# https://github.com/opengeospatial/ogcapi-processes/blob/master/core/openapi/schemas/execute.yaml
# default = EXECUTE_RESPONSE_DOCUMENT
[docs] example = EXECUTE_RESPONSE_DOCUMENT
[docs] validator = OneOf(EXECUTE_RESPONSE_OPTIONS)
[docs]class TransmissionModeEnum(ExtendedSchemaNode):
[docs] title = "TransmissionMode"
[docs] default = EXECUTE_TRANSMISSION_MODE_REFERENCE
[docs] example = EXECUTE_TRANSMISSION_MODE_REFERENCE
[docs] validator = OneOf(EXECUTE_TRANSMISSION_MODE_OPTIONS)
[docs]class JobStatusEnum(ExtendedSchemaNode):
[docs] default = STATUS_ACCEPTED
[docs] example = STATUS_ACCEPTED
[docs] validator = OneOf(JOB_STATUS_CATEGORIES[STATUS_COMPLIANT_OGC])
[docs]class JobSortEnum(ExtendedSchemaNode):
[docs] title = "JobSortingMethod"
[docs] validator = OneOf(JOB_SORT_VALUES)
[docs]class QuoteSortEnum(ExtendedSchemaNode):
[docs] title = "QuoteSortingMethod"
[docs] validator = OneOf(QUOTE_SORT_VALUES)
[docs]class LaunchJobQuerystring(ExtendedMappingSchema):
[docs]class VisibilityValue(ExtendedSchemaNode):
[docs] validator = OneOf(VISIBILITY_VALUES)
[docs] example = VISIBILITY_PUBLIC
[docs]class JobAccess(VisibilityValue):
pass
[docs]class Visibility(ExtendedMappingSchema):
[docs] value = VisibilityValue()
#########################################################
# Path parameter definitions
#########################################################
[docs]class ProcessPath(ExtendedMappingSchema):
# FIXME: support versioning with <id:tag> (https://github.com/crim-ca/weaver/issues/107)
[docs] process_id = AnyIdentifier(description="Process identifier.", example="jsonarray2netcdf")
[docs]class ProviderPath(ExtendedMappingSchema):
[docs] provider_id = AnyIdentifier(description="Remote provider identifier.", example="hummingbird")
[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]class VersionsEndpoint(ExtendedMappingSchema):
[docs]class OpenAPIEndpoint(ExtendedMappingSchema):
[docs]class SwaggerUIEndpoint(ExtendedMappingSchema):
pass
[docs]class RedocUIEndpoint(ExtendedMappingSchema):
pass
[docs]class OWSNamespace(XMLObject):
[docs] namespace = "http://www.opengis.net/ows/1.1"
[docs]class WPSNamespace(XMLObject):
[docs] namespace = "http://www.opengis.net/wps/1.0.0"
[docs]class XMLNamespace(XMLObject):
[docs]class XMLReferenceAttribute(ExtendedSchemaNode, XMLObject):
[docs]class MimeTypeAttribute(ExtendedSchemaNode, XMLObject):
[docs] example = CONTENT_TYPE_APP_JSON
[docs]class EncodingAttribute(ExtendedSchemaNode, XMLObject):
[docs]class OWSVersion(ExtendedSchemaNode, OWSNamespace):
[docs]class OWSAcceptVersions(ExtendedSequenceSchema, OWSNamespace):
[docs] description = "Accepted versions to produce the response."
[docs] name = "AcceptVersions"
[docs]class OWSLanguage(ExtendedSchemaNode, OWSNamespace):
[docs] description = "Desired language to produce the response."
[docs] default = ACCEPT_LANGUAGE_EN_US
[docs] example = ACCEPT_LANGUAGE_EN_CA
[docs]class OWSLanguageAttribute(OWSLanguage):
[docs] description = "RFC-4646 language code of the human-readable text."
[docs]class OWSService(ExtendedSchemaNode, OWSNamespace):
[docs] description = "Desired service to produce the response (SHOULD be 'WPS')."
[docs] default = ACCEPT_LANGUAGE_EN_US
[docs] example = ACCEPT_LANGUAGE_EN_CA
[docs]class WPSServiceAttribute(ExtendedSchemaNode, XMLObject):
[docs]class WPSVersionAttribute(ExtendedSchemaNode, XMLObject):
[docs]class WPSLanguageAttribute(ExtendedSchemaNode, XMLNamespace):
[docs] default = ACCEPT_LANGUAGE_EN_US
[docs] example = ACCEPT_LANGUAGE_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]class WPSOperationGetNoContent(ExtendedMappingSchema):
[docs] description = "No content body provided (GET requests)."
[docs]class WPSOperationPost(ExtendedMappingSchema):
[docs] schema_ref = "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_ref = "http://schemas.opengis.net/wps/1.0.0/wpsGetCapabilities_request.xsd"
[docs] name = "GetCapabilities"
[docs] title = "GetCapabilities"
[docs]class OWSIdentifier(ExtendedSchemaNode, OWSNamespace):
[docs]class OWSIdentifierList(ExtendedSequenceSchema, OWSNamespace):
[docs]class OWSTitle(ExtendedSchemaNode, OWSNamespace):
[docs]class OWSAbstract(ExtendedSchemaNode, OWSNamespace):
[docs]class WPSDescribeProcessPost(WPSOperationPost, WPSNamespace):
[docs] schema_ref = "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"
)
# FIXME: missing details about 'DataInputs'
[docs]class WPSExecutePost(WPSOperationPost, WPSNamespace):
[docs] schema_ref = "http://schemas.opengis.net/wps/1.0.0/wpsExecute_request.xsd"
[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 WPSEndpointGet(ExtendedMappingSchema):
[docs] querystring = WPSParameters()
[docs] body = WPSOperationGetNoContent(missing=drop)
[docs]class WPSEndpointPost(ExtendedMappingSchema):
[docs] body = WPSRequestBody()
[docs]class XMLBooleanAttribute(ExtendedSchemaNode, XMLObject):
[docs]class XMLString(ExtendedSchemaNode, XMLObject):
[docs]class OWSString(ExtendedSchemaNode, OWSNamespace):
[docs]class OWSKeywordList(ExtendedSequenceSchema, OWSNamespace):
[docs] keyword = OWSString(name="Keyword", title="OWSKeyword", example="Weaver")
[docs]class OWSType(ExtendedMappingSchema, OWSNamespace):
[docs] additionalProperties = {
"codeSpace": {
"type": "string",
"example": "ISOTC211/19115",
"xml": {"attribute": True}
}
}
[docs]class OWSPhone(ExtendedMappingSchema, OWSNamespace):
[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] 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 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]class WPSDescriptionType(ExtendedMappingSchema, OWSNamespace):
[docs] schema_ref = "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]class OWSServiceIdentification(WPSDescriptionType, OWSNamespace):
[docs] name = "ServiceIdentification"
[docs] title = "ServiceIdentification"
[docs] keywords = OWSKeywordList(name="Keywords")
[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] example = "GetCapabilities"
[docs] validator = OneOf(["GetCapabilities", "DescribeProcess", "Execute"])
[docs]class OperationLink(ExtendedSchemaNode, XMLObject):
[docs] example = "http://schema-example.com/wps"
[docs]class OperationRequest(ExtendedMappingSchema, OWSNamespace):
[docs]class OWS_HTTP(ExtendedMappingSchema, OWSNamespace):
[docs] get = OperationRequest(name="Get", title="OWSGet")
[docs] post = OperationRequest(name="Post", title="OWSPost")
[docs]class OWS_DCP(ExtendedMappingSchema, OWSNamespace):
[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]class ProcessVersion(ExtendedSchemaNode, WPSNamespace):
[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] lang = OWSLanguage(name="Language")
[docs]class WPSLanguageSpecification(ExtendedMappingSchema, WPSNamespace):
[docs] default = OWSLanguage(name="Default")
[docs] supported = WPSLanguagesType(name="Supported")
[docs]class WPSResponseBaseType(PermissiveMappingSchema, WPSNamespace):
[docs] schema_ref = "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_ref = "http://schemas.opengis.net/wps/1.0.0/common/ProcessVersion.xsd"
[docs] description = "Release version of this Process."
[docs] name = "processVersion"
[docs]class WPSLiteralData(WPSLiteralInputType):
[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 WPSComplexData(ExtendedMappingSchema, XMLObject):
[docs] data = WPSComplexInputType(name="ComplexData")
]
[docs]class WPSMinOccursAttribute(MinOccursDefinition, XMLObject):
[docs]class WPSMaxOccursAttribute(MinOccursDefinition, XMLObject):
]
[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]class ProcessOutputs(ExtendedSequenceSchema, WPSNamespace):
[docs] name = "ProcessOutputs"
[docs] title = "ProcessOutputs"
[docs] output = WPSOutputDescriptionType()
[docs]class WPSGetCapabilities(WPSResponseBaseType):
[docs] schema_ref = "http://schemas.opengis.net/wps/1.0.0/wpsGetCapabilities_response.xsd"
[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] outputs = ProcessOutputs()
[docs]class WPSProcessDescriptionList(ExtendedSequenceSchema, WPSNamespace):
[docs] name = "ProcessDescriptions"
[docs] title = "ProcessDescriptions"
[docs] description = "Listing of process description for every requested identifier."
[docs] process = WPSProcessDescriptionType()
[docs]class WPSDescribeProcess(WPSResponseBaseType):
[docs] schema_ref = "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] name = "statusLocation"
[docs]class WPSServiceInstanceAttribute(ExtendedSchemaNode, XMLObject):
[docs] name = "serviceInstance"
[docs]class CreationTimeAttribute(ExtendedSchemaNode, XMLObject):
[docs]class WPSStatusSuccess(ExtendedSchemaNode, WPSNamespace):
[docs] name = "ProcessSucceeded"
[docs] title = "ProcessSucceeded"
[docs]class WPSStatusFailed(ExtendedSchemaNode, WPSNamespace):
[docs] title = "ProcessFailed"
[docs]class WPSStatus(ExtendedMappingSchema, WPSNamespace):
[docs] creationTime = CreationTimeAttribute()
[docs] status_success = WPSStatusSuccess(missing=drop)
[docs] status_failed = WPSStatusFailed(missing=drop)
[docs]class WPSProcessSummary(ExtendedMappingSchema, WPSNamespace):
[docs] identifier = OWSIdentifier()
[docs] abstract = OWSAbstract(missing=drop)
[docs]class WPSOutputBase(ExtendedMappingSchema):
[docs] identifier = OWSIdentifier()
[docs] abstract = OWSAbstract(missing=drop)
[docs]class WPSOutputDefinitionItem(WPSOutputBase, WPSNamespace):
# 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]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):
# use different title to avoid OpenAPI schema definition clash with 'Output' of 'WPSOutputDefinitions'
[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_ref = "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] 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]class OWSExceptionLocatorAttribute(ExtendedSchemaNode, XMLObject):
[docs]class OWSExceptionText(ExtendedSchemaNode, OWSNamespace):
[docs] schema_type = String
[docs] name = "ExceptionText"
[docs]class OWSException(ExtendedMappingSchema, OWSNamespace):
[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] body = WPSXMLSuccessBodySchema()
[docs]class ErrorWPSResponse(ExtendedMappingSchema):
[docs] description = "Unhandled error occurred on WPS endpoint."
[docs] body = WPSException()
[docs]class ProviderEndpoint(ProviderPath):
[docs]class ProviderProcessEndpoint(ProviderPath, ProcessPath):
[docs]class ProcessEndpoint(ProcessPath):
[docs]class ProcessPackageEndpoint(ProcessPath):
[docs]class ProcessPayloadEndpoint(ProcessPath):
[docs]class ProcessVisibilityGetEndpoint(ProcessPath):
[docs]class ProcessVisibilityPutEndpoint(ProcessPath):
[docs] body = Visibility()
[docs]class ProviderJobEndpoint(ProviderPath, ProcessPath, JobPath):
[docs]class JobEndpoint(JobPath):
[docs]class ProcessOutputsEndpoint(ProcessPath, JobPath):
[docs]class ProviderOutputsEndpoint(ProviderPath, ProcessPath, JobPath):
[docs]class JobOutputsEndpoint(JobPath):
[docs]class ProcessResultEndpoint(ProcessOutputsEndpoint):
[docs]class ProviderResultEndpoint(ProviderOutputsEndpoint):
[docs]class JobResultEndpoint(JobOutputsEndpoint):
[docs]class ProcessResultsEndpoint(ProcessPath, JobPath):
[docs]class ProviderResultsEndpoint(ProviderPath, ProcessPath, JobPath):
[docs]class JobResultsEndpoint(ProviderPath, ProcessPath, JobPath):
[docs]class ProviderExceptionsEndpoint(ProviderPath, ProcessPath, JobPath):
[docs]class JobExceptionsEndpoint(JobPath):
[docs]class ProcessExceptionsEndpoint(ProcessPath, JobPath):
[docs]class ProviderLogsEndpoint(ProviderPath, ProcessPath, JobPath):
[docs]class JobLogsEndpoint(JobPath):
[docs]class ProcessLogsEndpoint(ProcessPath, JobPath):
##################################################################
# These classes define schemas for requests that feature a body
##################################################################
[docs]class CreateProviderRequestBody(ExtendedMappingSchema):
[docs] id = AnyIdentifier()
[docs] url = URL(description="Endpoint where to query the provider.")
[docs] public = ExtendedSchemaNode(Boolean())
[docs]class OutputDataType(OutputIdentifierType):
[docs]class Output(OutputDataType):
[docs] transmissionMode = TransmissionModeEnum(missing=drop)
[docs]class OutputList(ExtendedSequenceSchema):
[docs]class ProviderSummarySchema(ExtendedMappingSchema):
"""WPS provider summary definition."""
[docs] id = ExtendedSchemaNode(String())
[docs] url = URL(description="Endpoint of the provider.")
[docs] title = ExtendedSchemaNode(String())
[docs] abstract = ExtendedSchemaNode(String())
[docs] public = ExtendedSchemaNode(Boolean())
[docs]class ProviderCapabilitiesSchema(ExtendedMappingSchema):
"""WPS provider capabilities."""
[docs] id = ExtendedSchemaNode(String())
[docs] url = URL(description="WPS GetCapabilities URL of the provider.")
[docs] title = ExtendedSchemaNode(String())
[docs] abstract = ExtendedSchemaNode(String())
[docs] type = ExtendedSchemaNode(String())
[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 ProcessSummary(ProcessDescriptionType, ProcessDescriptionMeta):
"""WPS process definition."""
[docs] version = Version(missing=drop)
[docs] jobControlOptions = JobControlOptionsList(missing=[])
[docs] outputTransmission = TransmissionModeList(missing=[])
[docs] processDescriptionURL = URL(description="Process description endpoint.",
missing=drop, title="processDescriptionURL")
[docs]class ProcessSummaryList(ExtendedSequenceSchema):
[docs] processSummary = ProcessSummary()
[docs]class ProcessCollection(ExtendedMappingSchema):
[docs] processes = ProcessSummaryList()
[docs]class ProcessInfo(ExtendedMappingSchema):
[docs] executeEndpoint = URL(description="Endpoint where the process can be executed from.", missing=drop)
[docs]class Process(ProcessInfo, ProcessDescriptionType, ProcessDescriptionMeta):
[docs] outputs = OutputDescriptionList(description="Outputs definition of the process.")
[docs] visibility = VisibilityValue(missing=drop)
[docs]class ProcessDeployment(ProcessDescriptionType, ProcessDeployMeta):
# allowed undefined I/O during deploy because of reference from owsContext or executionUnit
[docs] outputs = OutputDescriptionList(
missing=drop, title="DeploymentInputs",
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 "
"overrides (see '{}/package.html#correspondence-between-cwl-and-wps-fields')".format(DOC_URL))
[docs] visibility = VisibilityValue(missing=drop)
[docs]class ProcessOutputDescriptionSchema(ExtendedMappingSchema):
"""WPS process output definition."""
[docs] dataType = ExtendedSchemaNode(String())
[docs] defaultValue = ExtendedMappingSchema()
[docs] id = ExtendedSchemaNode(String())
[docs] abstract = ExtendedSchemaNode(String())
[docs] title = ExtendedSchemaNode(String())
[docs]class JobStatusInfo(ExtendedMappingSchema):
[docs] jobID = UUID(example="a9d14bf4-84e0-449a-bac8-16e598efe807", description="ID of the 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.")
# note: using String instead of Time because timedelta object cannot be directly handled (missing parts at parsing)
[docs] duration = ExtendedSchemaNode(String(), missing=drop,
description="Duration since the start of the process execution.")
[docs] runningSeconds = ExtendedSchemaNode(Integer(), 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 prompted for updated status details.")
[docs] percentCompleted = ExtendedSchemaNode(Integer(), example=0, validator=Range(min=0, max=100),
description="Completion percentage of the job as indicated by the process.")
[docs] links = LinkList(missing=drop)
[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,
ExtendedSchemaNode(String(), description="Job ID."),
]
[docs]class JobCollection(ExtendedSequenceSchema):
[docs] item = JobEntrySchema()
[docs]class CreatedJobStatusSchema(ExtendedMappingSchema):
[docs] status = ExtendedSchemaNode(String(), example=STATUS_ACCEPTED)
[docs] location = ExtendedSchemaNode(String(), example="http://{host}/weaver/processes/{my-process-id}/jobs/{my-job-id}")
[docs] jobID = UUID(description="ID of the created job.")
[docs]class CreatedQuotedJobStatusSchema(CreatedJobStatusSchema):
[docs] bill = UUID(description="ID of the created bill.")
[docs]class GetPagingJobsSchema(ExtendedMappingSchema):
[docs] limit = ExtendedSchemaNode(Integer(), missing=10, default=10, validator=Range(min=0, max=10000))
[docs] page = ExtendedSchemaNode(Integer(), validator=Range(min=0))
[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,
GetGroupedJobsSchema,
]
[docs] total = ExtendedSchemaNode(Integer(),
description="Total number of matched jobs regardless of grouping or paging result.")
[docs]class DismissedJobSchema(ExtendedMappingSchema):
[docs] status = JobStatusEnum()
[docs] jobID = UUID(description="ID of the job.")
[docs] message = ExtendedSchemaNode(String(), example="Job dismissed.")
[docs] percentCompleted = ExtendedSchemaNode(Integer(), example=0)
[docs]class AlternateQuotation(ExtendedMappingSchema):
[docs] id = UUID(description="Quote ID.")
[docs] title = ExtendedSchemaNode(String(), description="Name of the quotation.", missing=drop)
[docs] description = ExtendedSchemaNode(String(), description="Description of the quotation.", missing=drop)
[docs] price = ExtendedSchemaNode(Float(), description="Process execution price.")
[docs] currency = ExtendedSchemaNode(String(), description="Currency code in ISO-4217 format.")
[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] details = ExtendedSchemaNode(String(), description="Details of the quotation.", missing=drop)
[docs] estimatedTime = ExtendedSchemaNode(String(), description="Estimated process execution duration.", missing=drop)
[docs]class AlternateQuotationList(ExtendedSequenceSchema):
[docs] step = AlternateQuotation(description="Quote of a workflow step process.")
# 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(Format):
pass
[docs]class Reference(ExtendedMappingSchema):
[docs] href = ReferenceURL(description="Endpoint of the reference.")
[docs] body = ExtendedSchemaNode(String(), missing=drop)
[docs] bodyReference = ReferenceURL(missing=drop)
[docs]class AnyType(OneOfKeywordSchema):
"""Permissive variants that we attempt to parse automatically."""
[docs] _one_of = [
# literal data with 'data' key
AnyLiteralDataType(),
# same with 'value' key (OGC specification)
AnyLiteralValueType(),
# HTTP references with various keywords
LiteralReference(),
Reference(),
]
"""
Default value to be looked for uses key 'value' to conform to OGC API standard.
We still look for 'href', 'data' and 'reference' to remain back-compatible.
"""
[docs]class Execute(ExtendedMappingSchema):
# permit unspecified inputs for processes that could technically allow no-inputs definition (CWL),
# but very unlikely/unusual in real world scenarios (possible case: constant endpoint fetcher?)
[docs] mode = JobExecuteModeEnum()
[docs] notification_email = ExtendedSchemaNode(
String(),
missing=drop,
validator=Email(),
description="Optionally send a notification email when the job is done.")
[docs] response = JobResponseOptionsEnum()
[docs]class Quotation(ExtendedMappingSchema):
[docs] id = UUID(description="Quote ID.")
[docs] title = ExtendedSchemaNode(String(), description="Name of the quotation.", missing=drop)
[docs] description = ExtendedSchemaNode(String(), description="Description of the quotation.", missing=drop)
[docs] processId = UUID(description="Corresponding process ID.")
[docs] price = ExtendedSchemaNode(Float(), description="Process execution price.")
[docs] currency = ExtendedSchemaNode(String(), description="Currency code in ISO-4217 format.")
[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 = UUID(description="User id that requested the quote.")
[docs] details = ExtendedSchemaNode(String(), description="Details of the quotation.", missing=drop)
[docs] estimatedTime = ExtendedSchemaNode(DateTime(), missing=drop,
description="Estimated duration of the process execution.")
[docs] processParameters = Execute(title="ProcessExecuteParameters")
[docs] alternativeQuotations = AlternateQuotationList(missing=drop)
[docs]class QuoteProcessListSchema(ExtendedSequenceSchema):
[docs] step = Quotation(description="Quote of a workflow step process.")
[docs]class QuoteSchema(ExtendedMappingSchema):
[docs] id = UUID(description="Quote ID.")
[docs] process = AnyIdentifier(description="Corresponding process ID.")
[docs] steps = QuoteProcessListSchema(description="Child processes and prices.")
[docs] total = ExtendedSchemaNode(Float(), description="Total of the quote including step processes.")
[docs]class QuotationList(ExtendedSequenceSchema):
[docs] quote = ExtendedSchemaNode(String(), description="Quote ID.")
[docs]class QuotationListSchema(ExtendedMappingSchema):
[docs] quotations = QuotationList()
[docs]class BillSchema(ExtendedMappingSchema):
[docs] id = UUID(description="Bill ID.")
[docs] title = ExtendedSchemaNode(String(), description="Name of the bill.")
[docs] description = ExtendedSchemaNode(String(), missing=drop)
[docs] price = ExtendedSchemaNode(Float(), description="Price associated to the bill.")
[docs] currency = ExtendedSchemaNode(String(), description="Currency code in ISO-4217 format.")
[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] quotationId = UUID(description="Corresponding quote ID.", missing=drop)
[docs]class BillList(ExtendedSequenceSchema):
[docs] bill = ExtendedSchemaNode(String(), description="Bill ID.")
[docs]class BillListSchema(ExtendedMappingSchema):
[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] 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 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] title = "RequirementClass"
[docs] description = "CWL requirement class specification."
[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] description = (
"Docker requirement with GPU-enabled support (https://github.com/NVIDIA/nvidia-docker). "
"The instance must have the NVIDIA toolkit installed to use this feature."
)
[docs]class DockerGpuRequirementMap(ExtendedMappingSchema):
[docs] req = DockerGpuRequirementSpecification(name=CWL_REQUIREMENT_APP_DOCKER_GPU)
[docs]class DockerGpuRequirementClass(DockerGpuRequirementSpecification):
[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 DirectoryListing(PermissiveMappingSchema):
[docs] entry = ExtendedSchemaNode(String(), missing=drop)
[docs]class InitialWorkDirListing(ExtendedSequenceSchema):
[docs] listing = DirectoryListing()
[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 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):
[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 = AnyIdentifier(description="ESGF-CWT provider endpoint.")
[docs]class ESGF_CWT_RequirementMap(ExtendedMappingSchema):
[docs] req = ESGF_CWT_RequirementSpecification(name=CWL_REQUIREMENT_APP_ESGF_CWT)
[docs]class ESGF_CWT_RequirementClass(ESGF_CWT_RequirementSpecification):
[docs] _class = RequirementClass(example=CWL_REQUIREMENT_APP_ESGF_CWT, validator=OneOf([CWL_REQUIREMENT_APP_ESGF_CWT]))
[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 = AnyIdentifier(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 UnknownRequirementClass(PermissiveMappingSchema):
[docs] _class = RequirementClass(example="UnknownRequirement")
[docs]class CWLRequirementsMap(AnyOfKeywordSchema):
[docs] _any_of = [
DockerRequirementMap(missing=drop),
DockerGpuRequirementMap(missing=drop),
InitialWorkDirRequirementMap(missing=drop),
PermissiveMappingSchema(missing=drop),
]
[docs]class CWLRequirementsItem(OneOfKeywordSchema):
[docs] _one_of = [
DockerRequirementClass(missing=drop),
DockerGpuRequirementClass(missing=drop),
InitialWorkDirRequirementClass(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),
DockerRequirementMap(missing=drop),
DockerGpuRequirementMap(missing=drop),
InitialWorkDirRequirementMap(missing=drop),
ESGF_CWT_RequirementMap(missing=drop),
WPS1RequirementMap(missing=drop),
]
[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),
DockerRequirementClass(missing=drop),
DockerGpuRequirementClass(missing=drop),
InitialWorkDirRequirementClass(missing=drop),
ESGF_CWT_RequirementClass(missing=drop),
WPS1RequirementClass(missing=drop),
UnknownRequirementClass(missing=drop), # allows anything, must be last
]
[docs]class CWLHintsList(ExtendedSequenceSchema):
[docs]class CWLHints(OneOfKeywordSchema):
[docs] _one_of = [
CWLHintsMap(),
CWLHintsList(),
]
[docs]class CWLArguments(ExtendedSequenceSchema):
[docs] argument = ExtendedSchemaNode(String())
[docs]class CWLTypeString(ExtendedSchemaNode):
# in this case it is ok to use 'name' because target fields receiving it will
# cause issues against builtin 'type' of Python reserved keyword
[docs] description = "Field type definition."
[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]class CWLType(OneOfKeywordSchema):
[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 CWLTypeStringList(ExtendedSequenceSchema):
[docs] description = "List of allowed direct CWL type specifications as strings."
]
]
[docs]class OutputBinding(PermissiveMappingSchema):
[docs] glob = ExtendedSchemaNode(String(), missing=drop,
description="Glob pattern the will find the output on disk or mounted docker volume.")
[docs]class CWLOutputObject(PermissiveMappingSchema):
# '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="CWLOutputIdentifierType",
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]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] validator = SemanticVersion(v_prefix=True, rc_suffix=False)
[docs]class CWL(PermissiveMappingSchema):
[docs] cwlVersion = CWLVersion()
[docs] requirements = CWLRequirements(description="Explicit requirement to execute the application package.", missing=drop)
[docs] hints = CWLHints(description="Non-failing additional hints that can help resolve extra requirements.", missing=drop)
[docs] baseCommand = CWLCommand(description="Command called in the docker image or on shell according to requirements "
"and hints specifications. Can be omitted if already defined in the "
"docker image.", missing=drop)
[docs] arguments = CWLArguments(description="Base arguments passed to the command.", missing=drop)
[docs] outputs = CWLOutputsDefinition(description="All outputs produced by the Application Package.")
[docs]class Unit(ExtendedMappingSchema):
[docs] unit = CWL(description="Execution unit definition as CWL package specification. " + CWL_DOC_MESSAGE)
[docs]class ProcessOutputDescriptionList(ExtendedSequenceSchema):
[docs]class ProcessDescriptionSchema(ExtendedMappingSchema):
[docs] label = ExtendedSchemaNode(String())
[docs] description = ExtendedSchemaNode(String())
[docs] outputs = ProcessOutputDescriptionList()
[docs]class UndeploymentResult(ExtendedMappingSchema):
[docs]class DeploymentResult(ExtendedMappingSchema):
[docs] processSummary = ProcessSummary()
[docs]class ProcessDescriptionBodySchema(ExtendedMappingSchema):
[docs] process = ProcessDescriptionSchema()
[docs]class ProcessesSchema(ExtendedSequenceSchema):
[docs] provider_processes_service = ProcessInputDescriptionSchema()
[docs]class JobOutputValue(OneOfKeywordSchema):
[docs] _one_of = [
Reference(tilte="JobOutputReference"),
AnyLiteralDataType(title="JobOutputLiteral")
]
[docs]class JobOutput(AllOfKeywordSchema):
[docs] _all_of = [
OutputDataType(),
JobOutputValue(),
]
[docs]class JobOutputList(ExtendedSequenceSchema):
[docs] title = "JobOutputList"
[docs] output = JobOutput(description="Job output result with specific keyword according to represented format.")
# implement only literal part of:
# https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/inlineOrRefData.yaml
[docs]class ResultLiteral(AnyLiteralValueType, LiteralDataDomainDefinition):
# value = <AnyLiteralValueType>
pass
[docs]class ResultLiteralList(ExtendedSequenceSchema):
[docs] result = ResultLiteral()
[docs]class ResultReference(ExtendedMappingSchema):
[docs] href = ReferenceURL(description="Result file reference.")
[docs]class ResultReferenceList(ExtendedSequenceSchema):
[docs] result = ResultReference()
[docs]class ResultData(OneOfKeywordSchema):
[docs] schema_ref = "{}/master/core/openapi/schemas/result.yaml".format(OGC_API_SCHEMA_URL)
[docs] _one_of = [
# must place formatted value first since both value/format fields are simultaneously required
# other classes require only one of the two, and therefore are more permissive during schema validation
ValueFormatted(description="Result formatted content value."),
ValueFormattedList(description="Result formatted content of multiple values."),
ResultReference(description="Result reference location."),
ResultReferenceList(description="Result locations for multiple references."),
ResultLiteral(description="Result literal value."),
ResultLiteralList(description="Result list of literal values."),
]
[docs]class Result(ExtendedMappingSchema):
"""Result outputs obtained from a successful process job execution."""
[docs] example_ref = "{}/master/core/examples/json/Result.json".format(OGC_API_SCHEMA_URL)
[docs] output_id = ResultData(
variable="<output-id>", title="Output Identifier",
description=(
"Resulting value of the output that conforms to 'OGC-API - Processes' standard. "
"(Note: '<output-id>' is a variable corresponding for each output identifier of the process)"
)
)
[docs]class JobOutputsSchema(ExtendedMappingSchema):
[docs] outputs = JobOutputList()
[docs] links = LinkList(missing=drop)
[docs]class JobException(ExtendedMappingSchema):
# note: test fields correspond exactly to 'owslib.wps.WPSException', they are deserialized as is
[docs] Code = ExtendedSchemaNode(String())
[docs] Locator = ExtendedSchemaNode(String(), default=None)
[docs] Text = ExtendedSchemaNode(String())
[docs]class JobExceptionsSchema(ExtendedSequenceSchema):
[docs] exceptions = JobException()
[docs]class JobLogsSchema(ExtendedSequenceSchema):
[docs] log = ExtendedSchemaNode(String())
[docs]class FrontpageParameterSchema(ExtendedMappingSchema):
[docs] name = ExtendedSchemaNode(String(), example="api")
[docs] enabled = ExtendedSchemaNode(Boolean(), example=True)
[docs] url = URL(description="Referenced parameter endpoint.", example="https://weaver-host", missing=drop)
[docs] doc = ExtendedSchemaNode(String(), example="https://weaver-host/api", missing=drop)
[docs]class FrontpageParameters(ExtendedSequenceSchema):
[docs] parameter = FrontpageParameterSchema()
[docs]class FrontpageSchema(ExtendedMappingSchema):
[docs] message = ExtendedSchemaNode(String(), default="Weaver Information", example="Weaver Information")
[docs] configuration = ExtendedSchemaNode(String(), default="default", example="default")
[docs] parameters = FrontpageParameters()
[docs]class SwaggerJSONSpecSchema(ExtendedMappingSchema):
pass
[docs]class SwaggerUISpecSchema(ExtendedMappingSchema):
pass
[docs]class VersionsSpecSchema(ExtendedMappingSchema):
[docs] name = ExtendedSchemaNode(String(), description="Identification name of the current item.", example="weaver")
[docs] type = ExtendedSchemaNode(String(), description="Identification type of the current item.", example="api")
[docs] version = Version(description="Version of the current item.", example="0.1.0")
[docs]class VersionsList(ExtendedSequenceSchema):
[docs] version = VersionsSpecSchema()
[docs]class VersionsSchema(ExtendedMappingSchema):
[docs] versions = VersionsList()
#################################################################
# Local Processes schemas
#################################################################
[docs]class PackageBody(ExtendedMappingSchema):
pass
[docs]class ExecutionUnit(OneOfKeywordSchema):
[docs] _one_of = [
Reference(name="Reference", title="Reference", description="Execution Unit reference."),
Unit(name="Unit", title="Unit", description="Execution Unit definition."),
]
[docs]class ExecutionUnitList(ExtendedSequenceSchema):
[docs] unit = ExecutionUnit(
name="ExecutionUnit",
title="ExecutionUnit",
description="Definition of the Application Package to execute."
)
[docs]class ProcessOfferingBase(ExtendedMappingSchema):
[docs] processVersion = Version(title="processVersion", missing=drop)
[docs] jobControlOptions = JobControlOptionsList(missing=drop)
[docs] outputTransmission = TransmissionModeList(missing=drop)
[docs]class ProcessOffering(ProcessOfferingBase):
[docs]class ProcessDeploymentOffering(ProcessOfferingBase):
[docs] process = ProcessDeployment()
[docs]class ProcessDescriptionChoiceType(OneOfKeywordSchema):
[docs] _one_of = [
Reference(),
ProcessDeploymentOffering()
]
[docs]class Deploy(ExtendedMappingSchema):
[docs] processDescription = ProcessDescriptionChoiceType()
[docs] executionUnit = ExecutionUnitList()
[docs] deploymentProfileName = URL(missing=drop)
[docs] owsContext = OWSContext(missing=drop)
[docs]class PostProcessesEndpoint(ExtendedMappingSchema):
[docs] body = Deploy(title="Deploy")
[docs]class PostProcessJobsEndpoint(ProcessPath):
[docs]class GetJobsQueries(ExtendedMappingSchema):
[docs] detail = ExtendedSchemaNode(Boolean(), description="Provide job details instead of IDs.",
default=False, example=True, missing=drop)
[docs] groups = ExtendedSchemaNode(String(),
description="Comma-separated list of grouping fields with which to list jobs.",
default=False, example="process,service", missing=drop)
[docs] page = ExtendedSchemaNode(Integer(), missing=0, default=0, validator=Range(min=0))
[docs] limit = ExtendedSchemaNode(Integer(), missing=10, default=10, validator=Range(min=0, max=10000))
[docs] datetime = DateTimeInterval(missing=drop, default=None)
[docs] status = JobStatusEnum(missing=drop, default=None)
[docs] process = AnyIdentifier(missing=drop)
[docs] provider = ExtendedSchemaNode(String(), missing=drop, default=None)
[docs] sort = JobSortEnum(missing=drop)
[docs] access = JobAccess(missing=drop, default=None)
[docs] notification_email = ExtendedSchemaNode(String(), missing=drop, validator=Email())
[docs]class GetJobsRequest(ExtendedMappingSchema):
[docs] querystring = GetJobsQueries()
[docs]class GetJobsEndpoint(GetJobsRequest):
pass
[docs]class GetProcessJobsEndpoint(GetJobsRequest, ProcessPath):
pass
[docs]class GetProviderJobsEndpoint(GetJobsRequest, ProviderPath, ProcessPath):
pass
[docs]class GetProcessJobEndpoint(ProcessPath):
[docs]class DeleteProcessJobEndpoint(ProcessPath):
[docs]class BillsEndpoint(ExtendedMappingSchema):
[docs]class BillEndpoint(BillPath):
[docs]class ProcessQuotesEndpoint(ProcessPath):
[docs]class ProcessQuoteEndpoint(ProcessPath, QuotePath):
[docs]class GetQuotesQueries(ExtendedMappingSchema):
[docs] page = ExtendedSchemaNode(Integer(), missing=drop, default=0)
[docs] limit = ExtendedSchemaNode(Integer(), missing=10, default=10, validator=Range(min=0, max=10000))
[docs] process = AnyIdentifier(missing=None)
[docs] sort = QuoteSortEnum(missing=drop)
[docs]class QuotesEndpoint(ExtendedMappingSchema):
[docs] querystring = GetQuotesQueries()
[docs]class QuoteEndpoint(QuotePath):
[docs]class PostProcessQuote(ProcessPath, QuotePath):
[docs] body = NoContent()
[docs]class PostQuote(QuotePath):
[docs] body = NoContent()
[docs]class PostProcessQuoteRequestEndpoint(ProcessPath, QuotePath):
[docs] body = QuoteProcessParametersSchema()
# ################################################################
# Provider Processes schemas
# ################################################################
[docs]class GetProviders(ExtendedMappingSchema):
[docs]class PostProvider(ExtendedMappingSchema):
[docs] body = CreateProviderRequestBody()
[docs]class GetProviderProcesses(ExtendedMappingSchema):
[docs]class GetProviderProcess(ExtendedMappingSchema):
[docs]class PostProviderProcessJobRequest(ExtendedMappingSchema):
"""Launching a new process request definition."""
[docs] querystring = LaunchJobQuerystring()
# ################################################################
# Responses schemas
# ################################################################
[docs]class ErrorDetail(ExtendedMappingSchema):
[docs] code = ExtendedSchemaNode(Integer(), description="HTTP status code.", example=400)
[docs] status = ExtendedSchemaNode(String(), description="HTTP status detail.", example="400 Bad Request")
[docs]class OWSErrorCode(ExtendedSchemaNode):
[docs] example = "InvalidParameterValue"
[docs] description = "OWS error code."
[docs]class OWSExceptionResponse(ExtendedMappingSchema):
"""Error content in XML format"""
[docs] description = "OWS formatted exception."
[docs] code = OWSErrorCode(example="NoSuchProcess")
[docs] locator = ExtendedSchemaNode(String(), example="identifier",
description="Indication of the element that caused the error.")
[docs] message = ExtendedSchemaNode(String(), example="Invalid process ID.",
description="Specific description of the error.")
[docs]class ErrorJsonResponseBodySchema(ExtendedMappingSchema):
[docs] code = OWSErrorCode()
[docs] description = ExtendedSchemaNode(String(), description="Detail about the cause of error.")
[docs] error = ErrorDetail(missing=drop)
[docs] exception = OWSExceptionResponse(missing=drop)
[docs]class UnprocessableEntityResponseSchema(ExtendedMappingSchema):
[docs] description = "Wrong format of given parameters."
[docs] body = ErrorJsonResponseBodySchema()
[docs]class ForbiddenProcessAccessResponseSchema(ExtendedMappingSchema):
[docs] description = "Referenced process is not accessible."
[docs] body = ErrorJsonResponseBodySchema()
[docs]class ForbiddenProviderAccessResponseSchema(ExtendedMappingSchema):
[docs] description = "Referenced provider is not accessible."
[docs] body = ErrorJsonResponseBodySchema()
[docs]class InternalServerErrorResponseSchema(ExtendedMappingSchema):
[docs] description = "Unhandled internal server error."
[docs] body = ErrorJsonResponseBodySchema()
[docs]class OkGetSwaggerJSONResponse(ExtendedMappingSchema):
[docs] body = SwaggerJSONSpecSchema(description="OpenAPI JSON schema of Weaver API.")
[docs]class OkGetSwaggerUIResponse(ExtendedMappingSchema):
[docs] body = SwaggerUISpecSchema(description="Swagger UI of Weaver API.")
[docs]class OkGetRedocUIResponse(ExtendedMappingSchema):
[docs] body = SwaggerUISpecSchema(description="Redoc UI of Weaver API.")
[docs]class OkGetVersionsResponse(ExtendedMappingSchema):
[docs] body = VersionsSchema()
[docs]class OkGetProvidersListResponse(ExtendedMappingSchema):
[docs] body = ProvidersSchema()
[docs]class OkGetProviderCapabilitiesSchema(ExtendedMappingSchema):
[docs] body = ProviderCapabilitiesSchema()
[docs]class NoContentDeleteProviderSchema(ExtendedMappingSchema):
[docs] body = NoContent()
[docs]class NotImplementedDeleteProviderResponse(ExtendedMappingSchema):
[docs] description = "Provider removal not supported using referenced storage."
[docs]class OkGetProviderProcessesSchema(ExtendedMappingSchema):
[docs] body = ProcessesSchema()
[docs]class GetProcessesQuery(ExtendedMappingSchema):
[docs] providers = ExtendedSchemaNode(
Boolean(), example=True, default=False, missing=drop,
description="List local processes as well as all sub-processes of all registered providers. "
"Applicable only for Weaver in {} mode, false otherwise.".format(WEAVER_CONFIGURATION_EMS))
[docs] detail = ExtendedSchemaNode(
Boolean(), example=True, default=True, missing=drop,
description="Return summary details about each process, or simply their IDs."
)
[docs]class GetProcessesEndpoint(ExtendedMappingSchema):
[docs] querystring = GetProcessesQuery()
[docs]class OkGetProcessesListResponse(ExtendedMappingSchema):
[docs] body = ProcessCollection()
[docs]class OkPostProcessDeployBodySchema(ExtendedMappingSchema):
[docs] deploymentDone = ExtendedSchemaNode(Boolean(), default=False, example=True,
description="Indicates if the process was successfully deployed.")
[docs] processSummary = ProcessSummary(missing=drop, description="Deployed process summary if successful.")
[docs] failureReason = ExtendedSchemaNode(String(), missing=drop,
description="Description of deploy failure if applicable.")
[docs]class OkPostProcessesResponse(ExtendedMappingSchema):
[docs] body = OkPostProcessDeployBodySchema()
[docs]class BadRequestGetProcessInfoResponse(ExtendedMappingSchema):
[docs] description = "Missing process identifier."
[docs] body = NoContent()
[docs]class OkGetProcessInfoResponse(ExtendedMappingSchema):
[docs] body = ProcessOffering()
[docs]class OkGetProcessPackageSchema(ExtendedMappingSchema):
[docs] body = NoContent()
[docs]class OkGetProcessPayloadSchema(ExtendedMappingSchema):
[docs] body = NoContent()
[docs]class ProcessVisibilityResponseBodySchema(ExtendedMappingSchema):
[docs] value = VisibilityValue()
[docs]class OkGetProcessVisibilitySchema(ExtendedMappingSchema):
[docs] body = ProcessVisibilityResponseBodySchema()
[docs]class OkPutProcessVisibilitySchema(ExtendedMappingSchema):
[docs] body = ProcessVisibilityResponseBodySchema()
[docs]class ForbiddenVisibilityUpdateResponseSchema(ExtendedMappingSchema):
[docs] description = "Visibility value modification not allowed."
[docs] body = ErrorJsonResponseBodySchema()
[docs]class OkDeleteProcessUndeployBodySchema(ExtendedMappingSchema):
[docs] deploymentDone = ExtendedSchemaNode(Boolean(), default=False, example=True,
description="Indicates if the process was successfully undeployed.")
[docs] identifier = ExtendedSchemaNode(String(), example="workflow")
[docs] failureReason = ExtendedSchemaNode(String(), missing=drop,
description="Description of undeploy failure if applicable.")
[docs]class OkDeleteProcessResponse(ExtendedMappingSchema):
[docs] body = OkDeleteProcessUndeployBodySchema()
[docs]class OkGetProviderProcessDescriptionResponse(ExtendedMappingSchema):
[docs] body = ProcessDescriptionBodySchema()
[docs]class CreatedPostProvider(ExtendedMappingSchema):
[docs] body = ProviderSummarySchema()
[docs]class NotImplementedPostProviderResponse(ExtendedMappingSchema):
[docs] description = "Provider registration not supported using referenced storage."
[docs]class CreatedLaunchJobResponse(ExtendedMappingSchema):
[docs] body = CreatedJobStatusSchema()
[docs]class OkGetProcessJobResponse(ExtendedMappingSchema):
[docs] body = JobStatusInfo()
[docs]class OkDeleteProcessJobResponse(ExtendedMappingSchema):
[docs] body = DismissedJobSchema()
[docs]class OkGetQueriedJobsResponse(ExtendedMappingSchema):
[docs] body = GetQueriedJobsSchema()
[docs]class OkDismissJobResponse(ExtendedMappingSchema):
[docs] body = DismissedJobSchema()
[docs]class OkGetJobStatusResponse(ExtendedMappingSchema):
[docs] body = JobStatusInfo()
[docs]class NotFoundJobResponseSchema(ExtendedMappingSchema):
[docs] description = "Job reference UUID cannot be found."
[docs] examples = {
"JobNotFound": {
"summary": "Example response when specified job reference cannot be found.",
"value": EXAMPLES["job_not_found.json"]
}
}
[docs] body = ErrorJsonResponseBodySchema()
[docs]class OkGetJobOutputsResponse(ExtendedMappingSchema):
[docs] body = JobOutputsSchema()
[docs]class RedirectResultResponse(ExtendedMappingSchema):
[docs]class OkGetJobResultsResponse(ExtendedMappingSchema):
[docs]class CreatedQuoteExecuteResponse(ExtendedMappingSchema):
[docs] body = CreatedQuotedJobStatusSchema()
[docs]class CreatedQuoteRequestResponse(ExtendedMappingSchema):
[docs] body = QuoteSchema()
[docs]class OkGetQuoteInfoResponse(ExtendedMappingSchema):
[docs] body = QuoteSchema()
[docs]class OkGetQuoteListResponse(ExtendedMappingSchema):
[docs] body = QuotationListSchema()
[docs]class OkGetBillDetailResponse(ExtendedMappingSchema):
[docs] body = BillSchema()
[docs]class OkGetBillListResponse(ExtendedMappingSchema):
[docs] body = BillListSchema()
[docs]class OkGetJobExceptionsResponse(ExtendedMappingSchema):
[docs] body = JobExceptionsSchema()
[docs]class OkGetJobLogsResponse(ExtendedMappingSchema):
[docs] body = JobLogsSchema()
[docs]get_api_frontpage_responses = {
"200": OkGetFrontpageResponse(description="success"),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_openapi_json_responses = {
"200": OkGetSwaggerJSONResponse(description="success"),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_api_swagger_ui_responses = {
"200": OkGetSwaggerUIResponse(description="success"),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_api_redoc_ui_responses = {
"200": OkGetRedocUIResponse(description="success"),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_api_versions_responses = {
"200": OkGetVersionsResponse(description="success"),
"500": InternalServerErrorResponseSchema(),
}
}
[docs]get_processes_responses = {
"200": OkGetProcessesListResponse(description="success", examples={
"ProcessesList": {
"summary": "Listing of local processes registered in Weaver.",
"value": EXAMPLES["local_process_listing.json"],
}
}),
"500": InternalServerErrorResponseSchema(),
}
[docs]post_processes_responses = {
"201": OkPostProcessesResponse(description="success"),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_process_responses = {
"200": OkGetProcessInfoResponse(description="success", examples={
"ProcessDescription": {
"summary": "Description of a local process registered in Weaver.",
"value": EXAMPLES["local_process_description.json"],
}
}),
"400": BadRequestGetProcessInfoResponse(),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_process_package_responses = {
"200": OkGetProcessPackageSchema(description="success", examples={
"PackageCWL": {
"summary": "CWL Application Package definition of the local process.",
"value": EXAMPLES["local_process_package.json"],
}
}),
"403": ForbiddenProcessAccessResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_process_payload_responses = {
"200": OkGetProcessPayloadSchema(description="success", examples={
"Payload": {
"summary": "Payload employed during process deployment and registration.",
"value": EXAMPLES["local_process_payload.json"],
}
}),
"403": ForbiddenProcessAccessResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_process_visibility_responses = {
"200": OkGetProcessVisibilitySchema(description="success"),
"403": ForbiddenProcessAccessResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]put_process_visibility_responses = {
"200": OkPutProcessVisibilitySchema(description="success"),
"403": ForbiddenVisibilityUpdateResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]delete_process_responses = {
"200": OkDeleteProcessResponse(description="success"),
"403": ForbiddenProcessAccessResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_providers_list_responses = {
"200": OkGetProvidersListResponse(description="success", examples={
"ProviderList": {
"summary": "Listing of registered remote providers.",
"value": EXAMPLES["provider_listing.json"],
}
}),
"403": ForbiddenProviderAccessResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_provider_responses = {
"200": OkGetProviderCapabilitiesSchema(description="success", examples={
"ProviderDescription": {
"summary": "Description of a registered remote WPS provider.",
"value": EXAMPLES["provider_description.json"],
}
}),
"403": ForbiddenProviderAccessResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]delete_provider_responses = {
"204": NoContentDeleteProviderSchema(description="success"),
"403": ForbiddenProviderAccessResponseSchema(),
"500": InternalServerErrorResponseSchema(),
"501": NotImplementedDeleteProviderResponse(),
}
[docs]get_provider_processes_responses = {
"200": OkGetProviderProcessesSchema(description="success"),
"403": ForbiddenProviderAccessResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_provider_process_responses = {
"200": OkGetProviderProcessDescriptionResponse(description="success", examples={
"ProviderProcessWPS": {
"summary": "Description of a remote WPS provider process converted to OGC-API Processes format.",
"value": EXAMPLES["provider_process_description.json"]
}
}),
"403": ForbiddenProviderAccessResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]post_provider_responses = {
"201": CreatedPostProvider(description="success"),
"400": ExtendedMappingSchema(description=OWSMissingParameterValue.description),
"403": ForbiddenProviderAccessResponseSchema(),
"500": InternalServerErrorResponseSchema(),
"501": NotImplementedPostProviderResponse(),
}
[docs]post_provider_process_job_responses = {
"201": CreatedLaunchJobResponse(description="success"),
"403": ForbiddenProviderAccessResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]post_process_jobs_responses = {
"201": CreatedLaunchJobResponse(description="success"),
"403": ForbiddenProviderAccessResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_all_jobs_responses = {
"200": OkGetQueriedJobsResponse(description="success", examples={
"JobListing": {
"summary": "Job ID listing with default queries.",
"value": EXAMPLES["jobs_listing.json"]
}
}),
"422": UnprocessableEntityResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_single_job_status_responses = {
"200": OkGetJobStatusResponse(description="success", examples={
"JobStatusSuccess": {
"summary": "Successful job status response.",
"value": EXAMPLES["job_status_success.json"]},
"JobStatusFailure": {
"summary": "Failed job status response.",
"value": EXAMPLES["job_status_failed.json"],
}
}),
"404": NotFoundJobResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]delete_job_responses = {
"200": OkDismissJobResponse(description="success"),
"404": NotFoundJobResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
}
[docs]get_job_outputs_responses = {
"200": OkGetJobOutputsResponse(description="success", examples={
"JobOutputs": {
"summary": "Obtained job outputs values following process execution.",
"value": EXAMPLES["job_outputs.json"],
}
}),
"404": NotFoundJobResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_result_redirect_responses = {
"308": RedirectResultResponse(description="Redirects '/result' (without 's') to corresponding '/results' path."),
}
[docs]get_job_results_responses = {
"200": OkGetJobResultsResponse(description="success", examples={
"JobResults": {
"summary": "Obtained job results.",
"value": EXAMPLES["job_results.json"],
}
}),
"404": NotFoundJobResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_exceptions_responses = {
"200": OkGetJobExceptionsResponse(description="success", examples={
"JobExceptions": {
"summary": "Job exceptions that occurred during failing process execution.",
"value": EXAMPLES["job_exceptions.json"],
}
}),
"404": NotFoundJobResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_logs_responses = {
"200": OkGetJobLogsResponse(description="success", examples={
"JobLogs": {
"summary": "Job logs registered and captured throughout process execution.",
"value": EXAMPLES["job_logs.json"],
}
}),
"404": NotFoundJobResponseSchema(),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_quote_list_responses = {
"200": OkGetQuoteListResponse(description="success"),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_quote_responses = {
"200": OkGetQuoteInfoResponse(description="success"),
"500": InternalServerErrorResponseSchema(),
}
[docs]post_quotes_responses = {
"201": CreatedQuoteRequestResponse(description="success"),
"500": InternalServerErrorResponseSchema(),
}
[docs]post_quote_responses = {
"201": CreatedQuoteExecuteResponse(description="success"),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_bill_list_responses = {
"200": OkGetBillListResponse(description="success"),
"500": InternalServerErrorResponseSchema(),
}
[docs]get_bill_responses = {
"200": OkGetBillDetailResponse(description="success"),
"500": InternalServerErrorResponseSchema(),
}
[docs]wps_responses = {
"200": OkWPSResponse(examples={
"GetCapabilities": {
"summary": "GetCapabilities example response.",
"value": EXAMPLES["wps_getcapabilities.xml"]
},
"DescribeProcess": {
"summary": "DescribeProcess example response.",
"value": EXAMPLES["wps_describeprocess.xml"]
},
"Execute": {
"summary": "Execute example response.",
"value": EXAMPLES["wps_execute_response.xml"]
}
}),
"400": ErrorWPSResponse(examples={
"MissingParameterError": {
"summary": "Error report in case of missing request parameter.",
"value": EXAMPLES["wps_missing_parameter.xml"],
}
}),
"500": ErrorWPSResponse(),
}
#################################################################
# Utility methods
#################################################################
[docs]def service_api_route_info(service_api, settings):
# type: (Service, SettingsType) -> ViewInfo
api_base = wps_restapi_base_path(settings)
return {"name": service_api.name, "pattern": "{base}{path}".format(base=api_base, path=service_api.path)}
[docs]def datetime_interval_parser(datetime_interval):
# type: (str) -> DatetimeIntervalType
"""This function parses a given datetime or interval into a dictionary that will be easy for database process."""
parsed_datetime = {}
if datetime_interval.startswith(DATETIME_INTERVAL_OPEN_START_SYMBOL):
datetime_interval = datetime_interval.replace(DATETIME_INTERVAL_OPEN_START_SYMBOL, "")
parsed_datetime["before"] = dateparser.parse(datetime_interval)
elif datetime_interval.endswith(DATETIME_INTERVAL_OPEN_END_SYMBOL):
datetime_interval = datetime_interval.replace(DATETIME_INTERVAL_OPEN_END_SYMBOL, "")
parsed_datetime["after"] = dateparser.parse(datetime_interval)
elif DATETIME_INTERVAL_CLOSED_SYMBOL in datetime_interval:
datetime_interval = datetime_interval.split(DATETIME_INTERVAL_CLOSED_SYMBOL)
parsed_datetime["after"] = dateparser.parse(datetime_interval[0])
parsed_datetime["before"] = dateparser.parse(datetime_interval[-1])
else:
parsed_datetime["match"] = dateparser.parse(datetime_interval)
return parsed_datetime