weaver.wps_restapi.swagger_definitions

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

Module Contents

weaver.wps_restapi.swagger_definitions.ViewInfo

weaver.wps_restapi.swagger_definitions.API_TITLE = Weaver REST API

weaver.wps_restapi.swagger_definitions.API_INFO

weaver.wps_restapi.swagger_definitions.API_DOCS

weaver.wps_restapi.swagger_definitions.DOC_URL

weaver.wps_restapi.swagger_definitions.CWL_VERSION = v1.1

weaver.wps_restapi.swagger_definitions.CWL_REPO_URL = https://github.com/common-workflow-language

weaver.wps_restapi.swagger_definitions.CWL_BASE_URL = https://www.commonwl.org

weaver.wps_restapi.swagger_definitions.CWL_SPEC_URL

weaver.wps_restapi.swagger_definitions.CWL_USER_GUIDE_URL

weaver.wps_restapi.swagger_definitions.CWL_CMD_TOOL_URL

weaver.wps_restapi.swagger_definitions.CWL_WORKFLOW_URL

weaver.wps_restapi.swagger_definitions.CWL_DOC_MESSAGE

weaver.wps_restapi.swagger_definitions.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.

weaver.wps_restapi.swagger_definitions.OGC_API_REPO_URL = https://github.com/opengeospatial/ogcapi-processes

weaver.wps_restapi.swagger_definitions.OGC_API_SCHEMA_URL = https://raw.githubusercontent.com/opengeospatial/ogcapi-processes

weaver.wps_restapi.swagger_definitions.SCHEMA_EXAMPLE_DIR

weaver.wps_restapi.swagger_definitions.EXAMPLES

weaver.wps_restapi.swagger_definitions.path

weaver.wps_restapi.swagger_definitions.TAG_API = API

weaver.wps_restapi.swagger_definitions.TAG_JOBS = Jobs

weaver.wps_restapi.swagger_definitions.TAG_VISIBILITY = Visibility

weaver.wps_restapi.swagger_definitions.TAG_BILL_QUOTE = Billing & Quoting

weaver.wps_restapi.swagger_definitions.TAG_PROVIDERS = Providers

weaver.wps_restapi.swagger_definitions.TAG_PROCESSES = Processes

weaver.wps_restapi.swagger_definitions.TAG_GETCAPABILITIES = GetCapabilities

weaver.wps_restapi.swagger_definitions.TAG_DESCRIBEPROCESS = DescribeProcess

weaver.wps_restapi.swagger_definitions.TAG_EXECUTE = Execute

weaver.wps_restapi.swagger_definitions.TAG_DISMISS = Dismiss

weaver.wps_restapi.swagger_definitions.TAG_STATUS = Status

weaver.wps_restapi.swagger_definitions.TAG_DEPLOY = Deploy

weaver.wps_restapi.swagger_definitions.TAG_RESULTS = Results

weaver.wps_restapi.swagger_definitions.TAG_EXCEPTIONS = Exceptions

weaver.wps_restapi.swagger_definitions.TAG_LOGS = Logs

weaver.wps_restapi.swagger_definitions.TAG_WPS = WPS

weaver.wps_restapi.swagger_definitions.TAG_DEPRECATED = Deprecated Endpoints

weaver.wps_restapi.swagger_definitions.api_frontpage_service

weaver.wps_restapi.swagger_definitions.api_openapi_ui_service

weaver.wps_restapi.swagger_definitions.api_swagger_ui_service

weaver.wps_restapi.swagger_definitions.api_redoc_ui_service

weaver.wps_restapi.swagger_definitions.api_versions_service

weaver.wps_restapi.swagger_definitions.api_conformance_service

weaver.wps_restapi.swagger_definitions.openapi_json_service

weaver.wps_restapi.swagger_definitions.quotes_service

weaver.wps_restapi.swagger_definitions.quote_service

weaver.wps_restapi.swagger_definitions.bills_service

weaver.wps_restapi.swagger_definitions.bill_service

weaver.wps_restapi.swagger_definitions.jobs_service

weaver.wps_restapi.swagger_definitions.job_service

weaver.wps_restapi.swagger_definitions.job_results_service

weaver.wps_restapi.swagger_definitions.job_exceptions_service

weaver.wps_restapi.swagger_definitions.job_outputs_service

weaver.wps_restapi.swagger_definitions.job_inputs_service

weaver.wps_restapi.swagger_definitions.job_logs_service

weaver.wps_restapi.swagger_definitions.processes_service

weaver.wps_restapi.swagger_definitions.process_service

weaver.wps_restapi.swagger_definitions.process_quotes_service

weaver.wps_restapi.swagger_definitions.process_quote_service

weaver.wps_restapi.swagger_definitions.process_visibility_service

weaver.wps_restapi.swagger_definitions.process_package_service

weaver.wps_restapi.swagger_definitions.process_payload_service

weaver.wps_restapi.swagger_definitions.process_jobs_service

weaver.wps_restapi.swagger_definitions.process_job_service

weaver.wps_restapi.swagger_definitions.process_results_service

weaver.wps_restapi.swagger_definitions.process_inputs_service

weaver.wps_restapi.swagger_definitions.process_outputs_service

weaver.wps_restapi.swagger_definitions.process_exceptions_service

weaver.wps_restapi.swagger_definitions.process_logs_service

weaver.wps_restapi.swagger_definitions.providers_service

weaver.wps_restapi.swagger_definitions.provider_service

weaver.wps_restapi.swagger_definitions.provider_processes_service

weaver.wps_restapi.swagger_definitions.provider_process_service

weaver.wps_restapi.swagger_definitions.provider_jobs_service

weaver.wps_restapi.swagger_definitions.provider_job_service

weaver.wps_restapi.swagger_definitions.provider_results_service

weaver.wps_restapi.swagger_definitions.provider_inputs_service

weaver.wps_restapi.swagger_definitions.provider_outputs_service

weaver.wps_restapi.swagger_definitions.provider_logs_service

weaver.wps_restapi.swagger_definitions.provider_exceptions_service

weaver.wps_restapi.swagger_definitions.job_result_service

weaver.wps_restapi.swagger_definitions.process_result_service

weaver.wps_restapi.swagger_definitions.provider_result_service

class weaver.wps_restapi.swagger_definitions.SLUG(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

description = Slug name pattern.

example = some-object-slug-name

pattern = ^[A-Za-z0-9]+(?:(-|_)[A-Za-z0-9]+)*$

class weaver.wps_restapi.swagger_definitions.URL(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

description = URL reference.

format = url

class weaver.wps_restapi.swagger_definitions.S3Bucket(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

description = S3 bucket shorthand URL representation [s3://<bucket>/<job-uuid>/<output>.ext]

pattern = ^s3://\S+$

class weaver.wps_restapi.swagger_definitions.FileLocal(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

description = Local file reference.

format = file

validator

class weaver.wps_restapi.swagger_definitions.FileURL(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

description = URL file reference.

format = url

validator

class weaver.wps_restapi.swagger_definitions.ReferenceURL(*args, **kwargs)

Allows specifying all mapping schemas that can be matched for an underlying schema definition. Corresponds to the anyOf specifier of OpenAPI specification.

Contrary to OneOfKeywordSchema that MUST be validated with exactly one schema, this definition will continue parsing all possibilities and apply validated sub-schemas on top of each other. Not all schemas have to be valid like in the case of AllOfKeywordSchema to succeed, as long as at least one of them is valid.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class RequiredType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class RequiredFields(ExtendedMappingSchema):
    field_str = ExtendedSchemaNode(String())
    field_int = ExtendedSchemaNode(Integer())

class AnyRequired(AnyKeywordSchema):
    _any_of = [RequiredItem(), RequiredType(), RequiredFields()]

# following is valid because their individual parts have all required sub-fields, result is their composition
AnyRequired().deserialize({"type": "test", "item": "valid"})     # result: {"type": "test", "item": "valid"}

# following is also valid because even though 'item' is missing, the 'type' is present
AnyRequired().deserialize({"type": "test"})                      # result: {"type": "test"}

# following is invalid because every one of the sub-field of individual parts are missing
AnyRequired().deserialize({"type": "test"})

# following is invalid because fields of 'RequiredFields' are only partially fulfilled
AnyRequired().deserialize({"field_str": "str"})

# following is valid because although fields of 'RequiredFields' are not all fulfilled, 'RequiredType' is valid
AnyRequired().deserialize({"field_str": "str", "type": "str"})  # result: {"type": "test"}

# following is invalid because 'RequiredFields' field 'field_int' is incorrect schema type
AnyRequired().deserialize({"field_str": "str", "field_int": "str"})

# following is valid, but result omits 'type' because its schema-type is incorrect, while others are valid
AnyRequired().deserialize({"field_str": "str", "field_int": 1, "items": "fields", "type": 1})
# result: {"field_str": "str", "field_int": 1, "items": "fields"}

Warning

Because valid items are applied on top of each other by merging fields during combinations, conflicting field names of any valid schema will contain only the final valid parsing during deserialization.

See also

• OneOfKeywordSchema

• AllOfKeywordSchema

• NotKeywordSchema

_any_of

class weaver.wps_restapi.swagger_definitions.UUID(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

description = Unique identifier.

example = a9d14bf4-84e0-449a-bac8-16e598efe807

format = uuid

title = UUID

class weaver.wps_restapi.swagger_definitions.AnyIdentifier(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

class weaver.wps_restapi.swagger_definitions.ProcessIdentifier(*args, **kwargs)

Allows specifying all mapping schemas that can be matched for an underlying schema definition. Corresponds to the anyOf specifier of OpenAPI specification.

Contrary to OneOfKeywordSchema that MUST be validated with exactly one schema, this definition will continue parsing all possibilities and apply validated sub-schemas on top of each other. Not all schemas have to be valid like in the case of AllOfKeywordSchema to succeed, as long as at least one of them is valid.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class RequiredType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class RequiredFields(ExtendedMappingSchema):
    field_str = ExtendedSchemaNode(String())
    field_int = ExtendedSchemaNode(Integer())

class AnyRequired(AnyKeywordSchema):
    _any_of = [RequiredItem(), RequiredType(), RequiredFields()]

# following is valid because their individual parts have all required sub-fields, result is their composition
AnyRequired().deserialize({"type": "test", "item": "valid"})     # result: {"type": "test", "item": "valid"}

# following is also valid because even though 'item' is missing, the 'type' is present
AnyRequired().deserialize({"type": "test"})                      # result: {"type": "test"}

# following is invalid because every one of the sub-field of individual parts are missing
AnyRequired().deserialize({"type": "test"})

# following is invalid because fields of 'RequiredFields' are only partially fulfilled
AnyRequired().deserialize({"field_str": "str"})

# following is valid because although fields of 'RequiredFields' are not all fulfilled, 'RequiredType' is valid
AnyRequired().deserialize({"field_str": "str", "type": "str"})  # result: {"type": "test"}

# following is invalid because 'RequiredFields' field 'field_int' is incorrect schema type
AnyRequired().deserialize({"field_str": "str", "field_int": "str"})

# following is valid, but result omits 'type' because its schema-type is incorrect, while others are valid
AnyRequired().deserialize({"field_str": "str", "field_int": 1, "items": "fields", "type": 1})
# result: {"field_str": "str", "field_int": 1, "items": "fields"}

Warning

Because valid items are applied on top of each other by merging fields during combinations, conflicting field names of any valid schema will contain only the final valid parsing during deserialization.

See also

• OneOfKeywordSchema

• AllOfKeywordSchema

• NotKeywordSchema

description = Process identifier.

_any_of

class weaver.wps_restapi.swagger_definitions.Version(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

description = Version string.

example = 1.2.3

validator

class weaver.wps_restapi.swagger_definitions.ContentTypeHeader(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

name = Content-Type

schema_type

class weaver.wps_restapi.swagger_definitions.AcceptHeader(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

name = Accept

schema_type

validator

missing

default

class weaver.wps_restapi.swagger_definitions.AcceptLanguageHeader(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

name = Accept-Language

schema_type

missing

default

class weaver.wps_restapi.swagger_definitions.JsonHeader(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

content_type

class weaver.wps_restapi.swagger_definitions.HtmlHeader(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

content_type

class weaver.wps_restapi.swagger_definitions.XmlHeader(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

content_type

class weaver.wps_restapi.swagger_definitions.RequestContentTypeHeader(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.ResponseContentTypeHeader(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.RequestHeaders(*args, **kwargs)

Headers that can indicate how to adjust the behavior and/or result the be provided in the response.

accept

accept_language

class weaver.wps_restapi.swagger_definitions.ResponseHeaders(*args, **kwargs)

Headers describing resulting response.

class weaver.wps_restapi.swagger_definitions.RedirectHeaders(*args, **kwargs)

Headers describing resulting response.

Location

class weaver.wps_restapi.swagger_definitions.NoContent(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = Empty response body.

default

class weaver.wps_restapi.swagger_definitions.KeywordList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

keyword

class weaver.wps_restapi.swagger_definitions.Language(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

example

validator

class weaver.wps_restapi.swagger_definitions.ValueLanguage(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

lang

class weaver.wps_restapi.swagger_definitions.LinkLanguage(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

hreflang

class weaver.wps_restapi.swagger_definitions.MetadataBase(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

type

title

class weaver.wps_restapi.swagger_definitions.MetadataRole(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

role

class weaver.wps_restapi.swagger_definitions.LinkRelationship(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

rel

class weaver.wps_restapi.swagger_definitions.LinkBase(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

href

class weaver.wps_restapi.swagger_definitions.Link(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.MetadataValue(*args, **kwargs)

Allows specifying specific schema conditions that fails underlying schema definition validation if present.

This is equivalent to OpenAPI object mapping with additionalProperties: false, but is more explicit in the definition of invalid or conflicting field names with explicit definitions during deserialization.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class MappingWithType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class MappingWithoutType(NotKeywordSchema, RequiredItem):
    _not = [MappingWithType()]

# following will raise invalid error even if 'item' is valid because 'type' is also present
MappingWithoutType().deserialize({"type": "invalid", "item": "valid"})

See also

• OneOfKeywordSchema

• AllOfKeywordSchema

• AnyOfKeywordSchema

_not

value

class weaver.wps_restapi.swagger_definitions.MetadataContent(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.Metadata(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

class weaver.wps_restapi.swagger_definitions.MetadataList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

metadata

class weaver.wps_restapi.swagger_definitions.LinkList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

description = List of links relative to the applicable object.

title = Links

link

class weaver.wps_restapi.swagger_definitions.LandingPage(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

links

class weaver.wps_restapi.swagger_definitions.Format(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

title = Format

mimeType

schema

encoding

class weaver.wps_restapi.swagger_definitions.FormatDefault(*args, **kwargs)

Format for process input are assumed plain text if the MIME-type was omitted and is not one of the known formats by this instance. When executing a job, the best match will be used to run the process, and will fallback to the default as last resort.

mimeType

class weaver.wps_restapi.swagger_definitions.FormatExtra(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

maximumMegabytes

class weaver.wps_restapi.swagger_definitions.FormatDescription(*args, **kwargs)

Format for process input are assumed plain text if the MIME-type was omitted and is not one of the known formats by this instance. When executing a job, the best match will be used to run the process, and will fallback to the default as last resort.

default

class weaver.wps_restapi.swagger_definitions.FormatMedia(*args, **kwargs)

Format employed for reference results respecting ‘OGC-API - Processes’ schemas.

schema_ref

mediaType

schema

encoding

class weaver.wps_restapi.swagger_definitions.FormatDescriptionList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

format

class weaver.wps_restapi.swagger_definitions.AdditionalParameterValuesList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

values

class weaver.wps_restapi.swagger_definitions.AdditionalParameter(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name

values

class weaver.wps_restapi.swagger_definitions.AdditionalParameterList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

additionalParameter

class weaver.wps_restapi.swagger_definitions.AdditionalParametersMeta(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.AdditionalParameters(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

parameters

class weaver.wps_restapi.swagger_definitions.AdditionalParametersItem(*args, **kwargs)

Allows specifying all mapping schemas that can be matched for an underlying schema definition. Corresponds to the anyOf specifier of OpenAPI specification.

Contrary to OneOfKeywordSchema that MUST be validated with exactly one schema, this definition will continue parsing all possibilities and apply validated sub-schemas on top of each other. Not all schemas have to be valid like in the case of AllOfKeywordSchema to succeed, as long as at least one of them is valid.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class RequiredType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class RequiredFields(ExtendedMappingSchema):
    field_str = ExtendedSchemaNode(String())
    field_int = ExtendedSchemaNode(Integer())

class AnyRequired(AnyKeywordSchema):
    _any_of = [RequiredItem(), RequiredType(), RequiredFields()]

# following is valid because their individual parts have all required sub-fields, result is their composition
AnyRequired().deserialize({"type": "test", "item": "valid"})     # result: {"type": "test", "item": "valid"}

# following is also valid because even though 'item' is missing, the 'type' is present
AnyRequired().deserialize({"type": "test"})                      # result: {"type": "test"}

# following is invalid because every one of the sub-field of individual parts are missing
AnyRequired().deserialize({"type": "test"})

# following is invalid because fields of 'RequiredFields' are only partially fulfilled
AnyRequired().deserialize({"field_str": "str"})

# following is valid because although fields of 'RequiredFields' are not all fulfilled, 'RequiredType' is valid
AnyRequired().deserialize({"field_str": "str", "type": "str"})  # result: {"type": "test"}

# following is invalid because 'RequiredFields' field 'field_int' is incorrect schema type
AnyRequired().deserialize({"field_str": "str", "field_int": "str"})

# following is valid, but result omits 'type' because its schema-type is incorrect, while others are valid
AnyRequired().deserialize({"field_str": "str", "field_int": 1, "items": "fields", "type": 1})
# result: {"field_str": "str", "field_int": 1, "items": "fields"}

Warning

Because valid items are applied on top of each other by merging fields during combinations, conflicting field names of any valid schema will contain only the final valid parsing during deserialization.

See also

• OneOfKeywordSchema

• AllOfKeywordSchema

• NotKeywordSchema

_any_of

class weaver.wps_restapi.swagger_definitions.AdditionalParametersList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

additionalParameter

class weaver.wps_restapi.swagger_definitions.Content(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

href

class weaver.wps_restapi.swagger_definitions.Offering(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

code

content

class weaver.wps_restapi.swagger_definitions.OWSContext(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = OGC Web Service definition from an URL reference.

title = owsContext

offering

class weaver.wps_restapi.swagger_definitions.DescriptionBase(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

title

abstract

links

class weaver.wps_restapi.swagger_definitions.DescriptionOWS(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

owsContext

class weaver.wps_restapi.swagger_definitions.DescriptionExtra(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

additionalParameters

class weaver.wps_restapi.swagger_definitions.DescriptionType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.ProcessDescriptionMeta(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

keywords

metadata

class weaver.wps_restapi.swagger_definitions.ProcessDeployMeta(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

keywords

metadata

class weaver.wps_restapi.swagger_definitions.InputOutputDescriptionMeta(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.MinOccursDefinition(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

description = Minimum amount of values required for this input.

title = MinOccurs

example = 1

_one_of

class weaver.wps_restapi.swagger_definitions.MaxOccursDefinition(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

description = Maximum amount of values allowed for this input.

title = MaxOccurs

example = 1

_one_of

class weaver.wps_restapi.swagger_definitions.WithMinMaxOccurs(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

minOccurs

maxOccurs

class weaver.wps_restapi.swagger_definitions.ProcessDescriptionType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

id

class weaver.wps_restapi.swagger_definitions.InputIdentifierType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

id

class weaver.wps_restapi.swagger_definitions.OutputIdentifierType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

id

class weaver.wps_restapi.swagger_definitions.InputDescriptionType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.OutputDescriptionType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.WithFormats(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

formats

class weaver.wps_restapi.swagger_definitions.ComplexInputType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.SupportedCRS(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

crs

default

class weaver.wps_restapi.swagger_definitions.SupportedCRSList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

crs

class weaver.wps_restapi.swagger_definitions.BoundingBoxInputType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

supportedCRS

class weaver.wps_restapi.swagger_definitions.LiteralReference(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

reference

class weaver.wps_restapi.swagger_definitions.NameReferenceType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

schema_ref

name

reference

class weaver.wps_restapi.swagger_definitions.DataTypeSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = Type of the literal data representation.

title = DataType

class weaver.wps_restapi.swagger_definitions.UomSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

title = UnitOfMeasure

class weaver.wps_restapi.swagger_definitions.AllowedValuesList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

allowedValues

class weaver.wps_restapi.swagger_definitions.AllowedValues(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

allowedValues

class weaver.wps_restapi.swagger_definitions.AllowedRange(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

minimumValue

maximumValue

spacing

rangeClosure

class weaver.wps_restapi.swagger_definitions.AllowedRangesList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

allowedRanges

class weaver.wps_restapi.swagger_definitions.AllowedRanges(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

allowedRanges

class weaver.wps_restapi.swagger_definitions.AnyValue(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

anyValue

class weaver.wps_restapi.swagger_definitions.ValuesReference(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

valueReference

class weaver.wps_restapi.swagger_definitions.AnyLiteralType(*args, **kwargs)

• AnyLiteralDataType

• AnyLiteralValueType

• AnyLiteralDefaultType

_one_of

class weaver.wps_restapi.swagger_definitions.AnyLiteralDataType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

data

class weaver.wps_restapi.swagger_definitions.AnyLiteralValueType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

value

class weaver.wps_restapi.swagger_definitions.AnyLiteralDefaultType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

default

class weaver.wps_restapi.swagger_definitions.LiteralDataDomainDefinition(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

default

defaultValue

dataType

uom

class weaver.wps_restapi.swagger_definitions.LiteralDataDomainConstraints(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.LiteralDataDomainList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

literalDataDomain

class weaver.wps_restapi.swagger_definitions.LiteralInputType(*args, **kwargs)

Allows specifying specific schema conditions that fails underlying schema definition validation if present.

This is equivalent to OpenAPI object mapping with additionalProperties: false, but is more explicit in the definition of invalid or conflicting field names with explicit definitions during deserialization.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class MappingWithType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class MappingWithoutType(NotKeywordSchema, RequiredItem):
    _not = [MappingWithType()]

# following will raise invalid error even if 'item' is valid because 'type' is also present
MappingWithoutType().deserialize({"type": "invalid", "item": "valid"})

See also

• OneOfKeywordSchema

• AllOfKeywordSchema

• AnyOfKeywordSchema

_not

literalDataDomains

class weaver.wps_restapi.swagger_definitions.InputTypeDefinition(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.InputType(*args, **kwargs)

Allows specifying all mapping schemas that can be matched for an underlying schema definition. Corresponds to the anyOf specifier of OpenAPI specification.

Contrary to OneOfKeywordSchema that MUST be validated with exactly one schema, this definition will continue parsing all possibilities and apply validated sub-schemas on top of each other. Not all schemas have to be valid like in the case of AllOfKeywordSchema to succeed, as long as at least one of them is valid.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class RequiredType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class RequiredFields(ExtendedMappingSchema):
    field_str = ExtendedSchemaNode(String())
    field_int = ExtendedSchemaNode(Integer())

class AnyRequired(AnyKeywordSchema):
    _any_of = [RequiredItem(), RequiredType(), RequiredFields()]

# following is valid because their individual parts have all required sub-fields, result is their composition
AnyRequired().deserialize({"type": "test", "item": "valid"})     # result: {"type": "test", "item": "valid"}

# following is also valid because even though 'item' is missing, the 'type' is present
AnyRequired().deserialize({"type": "test"})                      # result: {"type": "test"}

# following is invalid because every one of the sub-field of individual parts are missing
AnyRequired().deserialize({"type": "test"})

# following is invalid because fields of 'RequiredFields' are only partially fulfilled
AnyRequired().deserialize({"field_str": "str"})

# following is valid because although fields of 'RequiredFields' are not all fulfilled, 'RequiredType' is valid
AnyRequired().deserialize({"field_str": "str", "type": "str"})  # result: {"type": "test"}

# following is invalid because 'RequiredFields' field 'field_int' is incorrect schema type
AnyRequired().deserialize({"field_str": "str", "field_int": "str"})

# following is valid, but result omits 'type' because its schema-type is incorrect, while others are valid
AnyRequired().deserialize({"field_str": "str", "field_int": 1, "items": "fields", "type": 1})
# result: {"field_str": "str", "field_int": 1, "items": "fields"}

Warning

Because valid items are applied on top of each other by merging fields during combinations, conflicting field names of any valid schema will contain only the final valid parsing during deserialization.

See also

• OneOfKeywordSchema

• AllOfKeywordSchema

• NotKeywordSchema

_any_of

class weaver.wps_restapi.swagger_definitions.InputTypeList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

input

class weaver.wps_restapi.swagger_definitions.LiteralOutputType(*args, **kwargs)

Allows specifying specific schema conditions that fails underlying schema definition validation if present.

This is equivalent to OpenAPI object mapping with additionalProperties: false, but is more explicit in the definition of invalid or conflicting field names with explicit definitions during deserialization.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class MappingWithType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class MappingWithoutType(NotKeywordSchema, RequiredItem):
    _not = [MappingWithType()]

# following will raise invalid error even if 'item' is valid because 'type' is also present
MappingWithoutType().deserialize({"type": "invalid", "item": "valid"})

See also

• OneOfKeywordSchema

• AllOfKeywordSchema

• AnyOfKeywordSchema

_not

literalDataDomains

class weaver.wps_restapi.swagger_definitions.BoundingBoxOutputType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

supportedCRS

class weaver.wps_restapi.swagger_definitions.ComplexOutputType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.OutputTypeDefinition(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.OutputType(*args, **kwargs)

Allows specifying all mapping schemas that can be matched for an underlying schema definition. Corresponds to the anyOf specifier of OpenAPI specification.

Contrary to OneOfKeywordSchema that MUST be validated with exactly one schema, this definition will continue parsing all possibilities and apply validated sub-schemas on top of each other. Not all schemas have to be valid like in the case of AllOfKeywordSchema to succeed, as long as at least one of them is valid.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class RequiredType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class RequiredFields(ExtendedMappingSchema):
    field_str = ExtendedSchemaNode(String())
    field_int = ExtendedSchemaNode(Integer())

class AnyRequired(AnyKeywordSchema):
    _any_of = [RequiredItem(), RequiredType(), RequiredFields()]

# following is valid because their individual parts have all required sub-fields, result is their composition
AnyRequired().deserialize({"type": "test", "item": "valid"})     # result: {"type": "test", "item": "valid"}

# following is also valid because even though 'item' is missing, the 'type' is present
AnyRequired().deserialize({"type": "test"})                      # result: {"type": "test"}

# following is invalid because every one of the sub-field of individual parts are missing
AnyRequired().deserialize({"type": "test"})

# following is invalid because fields of 'RequiredFields' are only partially fulfilled
AnyRequired().deserialize({"field_str": "str"})

# following is valid because although fields of 'RequiredFields' are not all fulfilled, 'RequiredType' is valid
AnyRequired().deserialize({"field_str": "str", "type": "str"})  # result: {"type": "test"}

# following is invalid because 'RequiredFields' field 'field_int' is incorrect schema type
AnyRequired().deserialize({"field_str": "str", "field_int": "str"})

# following is valid, but result omits 'type' because its schema-type is incorrect, while others are valid
AnyRequired().deserialize({"field_str": "str", "field_int": 1, "items": "fields", "type": 1})
# result: {"field_str": "str", "field_int": 1, "items": "fields"}

Warning

Because valid items are applied on top of each other by merging fields during combinations, conflicting field names of any valid schema will contain only the final valid parsing during deserialization.

See also

• OneOfKeywordSchema

• AllOfKeywordSchema

• NotKeywordSchema

_any_of

class weaver.wps_restapi.swagger_definitions.OutputDescriptionList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

output

class weaver.wps_restapi.swagger_definitions.JobExecuteModeEnum(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

title = JobExecuteMode

example

validator

class weaver.wps_restapi.swagger_definitions.JobControlOptionsEnum(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

title = JobControlOptions

default

example

validator

class weaver.wps_restapi.swagger_definitions.JobResponseOptionsEnum(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

title = JobResponseOptions

example

validator

class weaver.wps_restapi.swagger_definitions.TransmissionModeEnum(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

title = TransmissionMode

default

example

validator

class weaver.wps_restapi.swagger_definitions.JobStatusEnum(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

title = JobStatus

default

example

validator

class weaver.wps_restapi.swagger_definitions.JobSortEnum(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

title = JobSortingMethod

default

example

validator

class weaver.wps_restapi.swagger_definitions.QuoteSortEnum(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

title = QuoteSortingMethod

default

example

validator

class weaver.wps_restapi.swagger_definitions.LaunchJobQuerystring(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

tags

class weaver.wps_restapi.swagger_definitions.VisibilityValue(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

validator

example

class weaver.wps_restapi.swagger_definitions.Visibility(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

value

class weaver.wps_restapi.swagger_definitions.ProcessPath(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

process_id

class weaver.wps_restapi.swagger_definitions.ProviderPath(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

provider_id

class weaver.wps_restapi.swagger_definitions.JobPath(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

job_id

class weaver.wps_restapi.swagger_definitions.BillPath(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

bill_id

class weaver.wps_restapi.swagger_definitions.QuotePath(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

quote_id

class weaver.wps_restapi.swagger_definitions.ResultPath(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

result_id

class weaver.wps_restapi.swagger_definitions.FrontpageEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.VersionsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ConformanceEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.OpenAPIEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.SwaggerUIEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.RedocUIEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.OWSNamespace

Object that provides mapping to known XML extensions for OpenAPI schema definition.

Name of the schema definition in the OpenAPI will use :prop:`prefix` and the schema class name. Prefix can be omitted from the schema definition name by setting it to colander.drop. The value of title provided as option or

See also

• https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#user-content-xml-object

• https://swagger.io/docs/specification/data-models/representing-xml/

prefix = ows

namespace = http://www.opengis.net/ows/1.1

class weaver.wps_restapi.swagger_definitions.WPSNamespace

Object that provides mapping to known XML extensions for OpenAPI schema definition.

Name of the schema definition in the OpenAPI will use :prop:`prefix` and the schema class name. Prefix can be omitted from the schema definition name by setting it to colander.drop. The value of title provided as option or

See also

• https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#user-content-xml-object

• https://swagger.io/docs/specification/data-models/representing-xml/

prefix = wps

namespace = http://www.opengis.net/wps/1.0.0

class weaver.wps_restapi.swagger_definitions.XMLNamespace

Object that provides mapping to known XML extensions for OpenAPI schema definition.

Name of the schema definition in the OpenAPI will use :prop:`prefix` and the schema class name. Prefix can be omitted from the schema definition name by setting it to colander.drop. The value of title provided as option or

See also

• https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#user-content-xml-object

• https://swagger.io/docs/specification/data-models/representing-xml/

prefix = xml

class weaver.wps_restapi.swagger_definitions.XMLReferenceAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

attribute = True

name = href

prefix = xlink

format = url

class weaver.wps_restapi.swagger_definitions.MimeTypeAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

attribute = True

name = mimeType

prefix

example

class weaver.wps_restapi.swagger_definitions.EncodingAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

attribute = True

name = encoding

prefix

example = UTF-8

class weaver.wps_restapi.swagger_definitions.OWSVersion(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = Version

default = 1.0.0

example = 1.0.0

class weaver.wps_restapi.swagger_definitions.OWSAcceptVersions(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

description = Accepted versions to produce the response.

name = AcceptVersions

item

class weaver.wps_restapi.swagger_definitions.OWSLanguage(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

description = Desired language to produce the response.

schema_type

name = Language

default

example

class weaver.wps_restapi.swagger_definitions.OWSLanguageAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

description = RFC-4646 language code of the human-readable text.

name = language

attribute = True

class weaver.wps_restapi.swagger_definitions.OWSService(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

description = Desired service to produce the response (SHOULD be 'WPS').

schema_type

name = service

attribute = True

default

example

class weaver.wps_restapi.swagger_definitions.WPSServiceAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = service

attribute = True

default = WPS

example = WPS

class weaver.wps_restapi.swagger_definitions.WPSVersionAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = version

attribute = True

default = 1.0.0

example = 1.0.0

class weaver.wps_restapi.swagger_definitions.WPSLanguageAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = lang

attribute = True

default

example

class weaver.wps_restapi.swagger_definitions.WPSParameters(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

service

request

version

identifier

data_inputs

class weaver.wps_restapi.swagger_definitions.WPSOperationGetNoContent(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = No content body provided (GET requests).

default

class weaver.wps_restapi.swagger_definitions.WPSOperationPost(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

schema_ref = http://schemas.opengis.net/wps/1.0.0/common/RequestBaseType.xsd

accepted_versions

language

service

class weaver.wps_restapi.swagger_definitions.WPSGetCapabilitiesPost(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

schema_ref = http://schemas.opengis.net/wps/1.0.0/wpsGetCapabilities_request.xsd

name = GetCapabilities

title = GetCapabilities

class weaver.wps_restapi.swagger_definitions.OWSIdentifier(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = Identifier

class weaver.wps_restapi.swagger_definitions.OWSIdentifierList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

name = Identifiers

item

class weaver.wps_restapi.swagger_definitions.OWSTitle(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = Title

class weaver.wps_restapi.swagger_definitions.OWSAbstract(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = Abstract

class weaver.wps_restapi.swagger_definitions.OWSMetadataLink(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_name = Metadata

schema_type

attribute = True

name = Metadata

prefix = xlink

example = WPS

wrapped = False

class weaver.wps_restapi.swagger_definitions.OWSMetadata(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

schema_type

name = Metadata

title

class weaver.wps_restapi.swagger_definitions.WPSDescribeProcessPost(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

schema_ref = http://schemas.opengis.net/wps/1.0.0/wpsDescribeProcess_request.xsd

name = DescribeProcess

title = DescribeProcess

identifier

class weaver.wps_restapi.swagger_definitions.WPSExecuteDataInputs(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = XML data inputs provided for WPS POST request (Execute).

name = DataInputs

title = DataInputs

class weaver.wps_restapi.swagger_definitions.WPSExecutePost(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

schema_ref = http://schemas.opengis.net/wps/1.0.0/wpsExecute_request.xsd

name = Execute

title = Execute

identifier

dataInputs

class weaver.wps_restapi.swagger_definitions.WPSRequestBody(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

examples

class weaver.wps_restapi.swagger_definitions.WPSHeaders(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

accept

class weaver.wps_restapi.swagger_definitions.WPSEndpointGet(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

querystring

body

class weaver.wps_restapi.swagger_definitions.WPSEndpointPost(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.XMLBooleanAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

attribute = True

class weaver.wps_restapi.swagger_definitions.XMLString(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

class weaver.wps_restapi.swagger_definitions.OWSString(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

class weaver.wps_restapi.swagger_definitions.OWSKeywordList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

title = OWSKeywords

keyword

class weaver.wps_restapi.swagger_definitions.OWSType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

schema_type

name = Type

example = theme

additionalProperties

class weaver.wps_restapi.swagger_definitions.OWSPhone(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = Phone

voice

facsimile

class weaver.wps_restapi.swagger_definitions.OWSAddress(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = Address

delivery_point

city

country

admin_area

postal_code

email

class weaver.wps_restapi.swagger_definitions.OWSContactInfo(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = ContactInfo

phone

address

class weaver.wps_restapi.swagger_definitions.OWSServiceContact(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = ServiceContact

individual

position

contact

class weaver.wps_restapi.swagger_definitions.OWSServiceProvider(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = Details about the institution providing the service.

name = ServiceProvider

title = ServiceProvider

provider_name

provider_site

contact

class weaver.wps_restapi.swagger_definitions.WPSDescriptionType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

schema_ref = http://schemas.opengis.net/wps/1.0.0/common/DescriptionType.xsd

name = DescriptionType

_title

abstract

metadata

class weaver.wps_restapi.swagger_definitions.OWSServiceIdentification(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = ServiceIdentification

title = ServiceIdentification

keywords

type

svc_type

svc_type_ver1

svc_type_ver2

fees

access

provider

class weaver.wps_restapi.swagger_definitions.OWSOperationName(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

attribute = True

name = name

example = GetCapabilities

validator

class weaver.wps_restapi.swagger_definitions.OperationLink(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

attribute = True

name = href

prefix = xlink

example = http://schema-example.com/wps

class weaver.wps_restapi.swagger_definitions.OperationRequest(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

href

class weaver.wps_restapi.swagger_definitions.OWS_HTTP(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

get

post

class weaver.wps_restapi.swagger_definitions.OWS_DCP(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

http

https

class weaver.wps_restapi.swagger_definitions.Operation(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name

dcp

class weaver.wps_restapi.swagger_definitions.OperationsMetadata(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

name = OperationsMetadata

op

class weaver.wps_restapi.swagger_definitions.ProcessVersion(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

attribute = True

class weaver.wps_restapi.swagger_definitions.OWSProcessSummary(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

version

identifier

_title

abstract

class weaver.wps_restapi.swagger_definitions.WPSProcessOfferings(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

name = ProcessOfferings

title = ProcessOfferings

process

class weaver.wps_restapi.swagger_definitions.WPSLanguagesType(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

title = LanguagesType

wrapped = False

lang

class weaver.wps_restapi.swagger_definitions.WPSLanguageSpecification(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = Languages

title = Languages

default

supported

class weaver.wps_restapi.swagger_definitions.WPSResponseBaseType(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

schema_ref = http://schemas.opengis.net/wps/1.0.0/common/ResponseBaseType.xsd

service

version

lang

class weaver.wps_restapi.swagger_definitions.WPSProcessVersion(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_ref = http://schemas.opengis.net/wps/1.0.0/common/ProcessVersion.xsd

schema_type

description = Release version of this Process.

name = processVersion

attribute = True

class weaver.wps_restapi.swagger_definitions.WPSInputDescriptionType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

identifier

_title

abstract

metadata

class weaver.wps_restapi.swagger_definitions.WPSLiteralInputType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.WPSLiteralData(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = LiteralData

class weaver.wps_restapi.swagger_definitions.WPSCRSsType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

crs

class weaver.wps_restapi.swagger_definitions.WPSSupportedCRS(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

crs

class weaver.wps_restapi.swagger_definitions.WPSSupportedCRSType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = SupportedCRSsType

default

supported

class weaver.wps_restapi.swagger_definitions.WPSBoundingBoxData(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

data

class weaver.wps_restapi.swagger_definitions.WPSFormatDefinition(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

mime_type

encoding

schema

class weaver.wps_restapi.swagger_definitions.WPSFileFormat(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = Format

format

class weaver.wps_restapi.swagger_definitions.WPSFormatList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

format

class weaver.wps_restapi.swagger_definitions.WPSComplexInputType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

max_mb

defaults

supported

class weaver.wps_restapi.swagger_definitions.WPSComplexData(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

data

class weaver.wps_restapi.swagger_definitions.WPSInputFormChoice(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

title = InputFormChoice

_one_of

class weaver.wps_restapi.swagger_definitions.WPSMinOccursAttribute(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

name = minOccurs

attribute = True

class weaver.wps_restapi.swagger_definitions.WPSMaxOccursAttribute(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

name = maxOccurs

prefix

attribute = True

class weaver.wps_restapi.swagger_definitions.WPSDataInputDescription(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

min_occurs

max_occurs

class weaver.wps_restapi.swagger_definitions.WPSDataInputItem(*args, **kwargs)

Allows specifying all the required partial mapping schemas for an underlying complete schema definition. Corresponds to the allOf specifier of OpenAPI specification.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class RequiredType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class AllRequired(AnyKeywordSchema):
    _all_of = [RequiredItem(), RequiredType()]

Value parsed with schema this definition will be valid only when every since one of the sub-schemas is valid. Any sub-schema raising an invalid error for any reason with make the whole schema validation fail.

See also

• OneOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_all_of

class weaver.wps_restapi.swagger_definitions.WPSDataInputs(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

name = DataInputs

title = DataInputs

input

class weaver.wps_restapi.swagger_definitions.WPSOutputDescriptionType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = OutputDescriptionType

title = OutputDescriptionType

identifier

_title

abstract

metadata

class weaver.wps_restapi.swagger_definitions.ProcessOutputs(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

name = ProcessOutputs

title = ProcessOutputs

output

class weaver.wps_restapi.swagger_definitions.WPSGetCapabilities(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

schema_ref = http://schemas.opengis.net/wps/1.0.0/wpsGetCapabilities_response.xsd

name = Capabilities

title = Capabilities

svc

ops

offering

languages

class weaver.wps_restapi.swagger_definitions.WPSProcessDescriptionType(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

name = ProcessDescriptionType

description = Description of the requested process by identifier.

store

status

inputs

outputs

class weaver.wps_restapi.swagger_definitions.WPSProcessDescriptionList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

name = ProcessDescriptions

title = ProcessDescriptions

description = Listing of process description for every requested identifier.

wrapped = False

process

class weaver.wps_restapi.swagger_definitions.WPSDescribeProcess(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

schema_ref = http://schemas.opengis.net/wps/1.0.0/wpsDescribeProcess_response.xsd

name = DescribeProcess

title = DescribeProcess

process

class weaver.wps_restapi.swagger_definitions.WPSStatusLocationAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = statusLocation

prefix

attribute = True

format = file

class weaver.wps_restapi.swagger_definitions.WPSServiceInstanceAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = serviceInstance

prefix

attribute = True

format = url

class weaver.wps_restapi.swagger_definitions.CreationTimeAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = creationTime

title = CreationTime

prefix

attribute = True

class weaver.wps_restapi.swagger_definitions.WPSStatusSuccess(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = ProcessSucceeded

title = ProcessSucceeded

class weaver.wps_restapi.swagger_definitions.WPSStatusFailed(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = ProcessFailed

title = ProcessFailed

class weaver.wps_restapi.swagger_definitions.WPSStatus(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = Status

title = Status

creationTime

status_success

status_failed

class weaver.wps_restapi.swagger_definitions.WPSProcessSummary(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = Process

title = Process

identifier

_title

abstract

class weaver.wps_restapi.swagger_definitions.WPSOutputBase(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

identifier

_title

abstract

class weaver.wps_restapi.swagger_definitions.WPSOutputDefinitionItem(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = Output

title = OutputDefinition

class weaver.wps_restapi.swagger_definitions.WPSOutputDefinitions(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

name = OutputDefinitions

title = OutputDefinitions

out_def

class weaver.wps_restapi.swagger_definitions.WPSOutputLiteral(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

data = []

class weaver.wps_restapi.swagger_definitions.WPSReference(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

href

mimeType

encoding

class weaver.wps_restapi.swagger_definitions.WPSOutputReference(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

title = OutputReference

reference

class weaver.wps_restapi.swagger_definitions.WPSOutputData(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.WPSDataOutputItem(*args, **kwargs)

Allows specifying all the required partial mapping schemas for an underlying complete schema definition. Corresponds to the allOf specifier of OpenAPI specification.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class RequiredType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class AllRequired(AnyKeywordSchema):
    _all_of = [RequiredItem(), RequiredType()]

Value parsed with schema this definition will be valid only when every since one of the sub-schemas is valid. Any sub-schema raising an invalid error for any reason with make the whole schema validation fail.

See also

• OneOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

name = Output

title = DataOutput

_all_of

class weaver.wps_restapi.swagger_definitions.WPSProcessOutputs(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

name = ProcessOutputs

title = ProcessOutputs

output

class weaver.wps_restapi.swagger_definitions.WPSExecuteResponse(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

schema_ref = http://schemas.opengis.net/wps/1.0.0/wpsExecute_response.xsd

name = ExecuteResponse

title = ExecuteResponse

location

svc_loc

process

status

inputs

out_def

outputs

class weaver.wps_restapi.swagger_definitions.WPSXMLSuccessBodySchema(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.OWSExceptionCodeAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = exceptionCode

title = Exception

attribute = True

class weaver.wps_restapi.swagger_definitions.OWSExceptionLocatorAttribute(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = locator

attribute = True

class weaver.wps_restapi.swagger_definitions.OWSExceptionText(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

name = ExceptionText

class weaver.wps_restapi.swagger_definitions.OWSException(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = Exception

title = Exception

code

locator

text

class weaver.wps_restapi.swagger_definitions.OWSExceptionReport(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name = ExceptionReport

title = ExceptionReport

exception

class weaver.wps_restapi.swagger_definitions.WPSException(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

report

class weaver.wps_restapi.swagger_definitions.OkWPSResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = WPS operation successful

header

body

class weaver.wps_restapi.swagger_definitions.ErrorWPSResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = Unhandled error occurred on WPS endpoint.

header

body

class weaver.wps_restapi.swagger_definitions.ProviderEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProviderProcessEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProcessEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProcessPackageEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProcessPayloadEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProcessVisibilityGetEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProcessVisibilityPutEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.ProviderJobEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.JobEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProcessInputsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProviderInputsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.JobInputsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProcessOutputsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProviderOutputsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.JobOutputsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProcessResultEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

deprecated = True

header

class weaver.wps_restapi.swagger_definitions.ProviderResultEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

deprecated = True

header

class weaver.wps_restapi.swagger_definitions.JobResultEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

deprecated = True

header

class weaver.wps_restapi.swagger_definitions.ProcessResultsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProviderResultsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.JobResultsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProviderExceptionsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.JobExceptionsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProcessExceptionsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProviderLogsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.JobLogsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProcessLogsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.CreateProviderRequestBody(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

id

url

public

class weaver.wps_restapi.swagger_definitions.InputDataType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.OutputDataType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

format

class weaver.wps_restapi.swagger_definitions.Output(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

transmissionMode

class weaver.wps_restapi.swagger_definitions.OutputList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

output

class weaver.wps_restapi.swagger_definitions.ProviderSummarySchema(*args, **kwargs)

WPS provider summary definition.

id

url

title

abstract

public

class weaver.wps_restapi.swagger_definitions.ProviderCapabilitiesSchema(*args, **kwargs)

WPS provider capabilities.

id

url

title

abstract

contact

type

class weaver.wps_restapi.swagger_definitions.TransmissionModeList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

transmissionMode

class weaver.wps_restapi.swagger_definitions.JobControlOptionsList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

jobControlOption

class weaver.wps_restapi.swagger_definitions.ExceptionReportType(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

code

description

class weaver.wps_restapi.swagger_definitions.ProcessSummary(*args, **kwargs)

WPS process definition.

version

jobControlOptions

outputTransmission

processDescriptionURL

class weaver.wps_restapi.swagger_definitions.ProcessSummaryList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

processSummary

class weaver.wps_restapi.swagger_definitions.ProcessCollection(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

processes

class weaver.wps_restapi.swagger_definitions.ProcessInfo(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

executeEndpoint

class weaver.wps_restapi.swagger_definitions.Process(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

inputs

outputs

visibility

class weaver.wps_restapi.swagger_definitions.ProcessDeployment(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

inputs

outputs

visibility

class weaver.wps_restapi.swagger_definitions.ProcessOutputDescriptionSchema(*args, **kwargs)

WPS process output definition.

dataType

defaultValue

id

abstract

title

class weaver.wps_restapi.swagger_definitions.JobStatusInfo(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

jobID

status

message

created

started

finished

duration

runningSeconds

expirationDate

estimatedCompletion

nextPoll

percentCompleted

links

class weaver.wps_restapi.swagger_definitions.JobEntrySchema(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.JobCollection(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

item

class weaver.wps_restapi.swagger_definitions.CreatedJobStatusSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

status

location

jobID

class weaver.wps_restapi.swagger_definitions.CreatedQuotedJobStatusSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

bill

class weaver.wps_restapi.swagger_definitions.GetPagingJobsSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

jobs

limit

page

class weaver.wps_restapi.swagger_definitions.JobCategoryFilters(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

category

class weaver.wps_restapi.swagger_definitions.GroupedJobsCategorySchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

category

jobs

count

class weaver.wps_restapi.swagger_definitions.GroupedCategoryJobsSchema(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

job_group_category_item

class weaver.wps_restapi.swagger_definitions.GetGroupedJobsSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

groups

class weaver.wps_restapi.swagger_definitions.GetQueriedJobsSchema(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

total

class weaver.wps_restapi.swagger_definitions.DismissedJobSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

status

jobID

message

percentCompleted

class weaver.wps_restapi.swagger_definitions.QuoteProcessParametersSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

inputs

outputs

mode

response

class weaver.wps_restapi.swagger_definitions.AlternateQuotation(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

id

title

description

price

currency

expire

created

details

estimatedTime

class weaver.wps_restapi.swagger_definitions.AlternateQuotationList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

step

class weaver.wps_restapi.swagger_definitions.DataEncodingAttributes(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.Reference(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

title = Reference

href

format

body

bodyReference

class weaver.wps_restapi.swagger_definitions.AnyType(*args, **kwargs)

Permissive variants that we attempt to parse automatically.

_one_of

class weaver.wps_restapi.swagger_definitions.Input(*args, **kwargs)

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.

class weaver.wps_restapi.swagger_definitions.InputList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

input

class weaver.wps_restapi.swagger_definitions.Execute(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

inputs

outputs

mode

notification_email

response

class weaver.wps_restapi.swagger_definitions.Quotation(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

id

title

description

processId

price

currency

expire

created

userId

details

estimatedTime

processParameters

alternativeQuotations

class weaver.wps_restapi.swagger_definitions.QuoteProcessListSchema(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

step

class weaver.wps_restapi.swagger_definitions.QuoteSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

id

process

steps

total

class weaver.wps_restapi.swagger_definitions.QuotationList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

quote

class weaver.wps_restapi.swagger_definitions.QuotationListSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

quotations

class weaver.wps_restapi.swagger_definitions.BillSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

id

title

description

price

currency

created

userId

quotationId

class weaver.wps_restapi.swagger_definitions.BillList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

bill

class weaver.wps_restapi.swagger_definitions.BillListSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

bills

class weaver.wps_restapi.swagger_definitions.SupportedValues(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.DefaultValues(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.CWLClass(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

name = class

title = Class

schema_type

example = CommandLineTool

validator

description = CWL class specification. This is used to differentiate between single Application Package (AP)definitions and Workflow that chains multiple packages.

class weaver.wps_restapi.swagger_definitions.RequirementClass(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

name = class

title = RequirementClass

schema_type

description = CWL requirement class specification.

class weaver.wps_restapi.swagger_definitions.DockerRequirementSpecification(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

dockerPull

class weaver.wps_restapi.swagger_definitions.DockerRequirementMap(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

DockerRequirement

class weaver.wps_restapi.swagger_definitions.DockerRequirementClass(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

_class

class weaver.wps_restapi.swagger_definitions.DockerGpuRequirementSpecification(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

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.

class weaver.wps_restapi.swagger_definitions.DockerGpuRequirementMap(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

req

class weaver.wps_restapi.swagger_definitions.DockerGpuRequirementClass(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

title

_class

class weaver.wps_restapi.swagger_definitions.DirectoryListing(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

entry

class weaver.wps_restapi.swagger_definitions.InitialWorkDirListing(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

listing

class weaver.wps_restapi.swagger_definitions.InitialWorkDirRequirementSpecification(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

listing

class weaver.wps_restapi.swagger_definitions.InitialWorkDirRequirementMap(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

req

class weaver.wps_restapi.swagger_definitions.InitialWorkDirRequirementClass(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

_class

class weaver.wps_restapi.swagger_definitions.BuiltinRequirementSpecification(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

title

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).

process

class weaver.wps_restapi.swagger_definitions.BuiltinRequirementMap(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

req

class weaver.wps_restapi.swagger_definitions.BuiltinRequirementClass(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

_class

class weaver.wps_restapi.swagger_definitions.ESGF_CWT_RequirementSpecification(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

title

description = Hint indicating that the Application Package corresponds to an ESGF-CWT provider processthat should be remotely executed and monitored by this instance. (note: can only be an 'hint' as it is unofficial CWL specification).

process

provider

class weaver.wps_restapi.swagger_definitions.ESGF_CWT_RequirementMap(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

req

class weaver.wps_restapi.swagger_definitions.ESGF_CWT_RequirementClass(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

_class

class weaver.wps_restapi.swagger_definitions.WPS1RequirementSpecification(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

title

description = Hint indicating that the Application Package corresponds to a WPS-1 provider processthat should be remotely executed and monitored by this instance. (note: can only be an 'hint' as it is unofficial CWL specification).

process

provider

class weaver.wps_restapi.swagger_definitions.WPS1RequirementMap(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

req

class weaver.wps_restapi.swagger_definitions.WPS1RequirementClass(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

_class

class weaver.wps_restapi.swagger_definitions.UnknownRequirementClass(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

_class

class weaver.wps_restapi.swagger_definitions.CWLRequirementsMap(*args, **kwargs)

Allows specifying all mapping schemas that can be matched for an underlying schema definition. Corresponds to the anyOf specifier of OpenAPI specification.

Contrary to OneOfKeywordSchema that MUST be validated with exactly one schema, this definition will continue parsing all possibilities and apply validated sub-schemas on top of each other. Not all schemas have to be valid like in the case of AllOfKeywordSchema to succeed, as long as at least one of them is valid.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class RequiredType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class RequiredFields(ExtendedMappingSchema):
    field_str = ExtendedSchemaNode(String())
    field_int = ExtendedSchemaNode(Integer())

class AnyRequired(AnyKeywordSchema):
    _any_of = [RequiredItem(), RequiredType(), RequiredFields()]

# following is valid because their individual parts have all required sub-fields, result is their composition
AnyRequired().deserialize({"type": "test", "item": "valid"})     # result: {"type": "test", "item": "valid"}

# following is also valid because even though 'item' is missing, the 'type' is present
AnyRequired().deserialize({"type": "test"})                      # result: {"type": "test"}

# following is invalid because every one of the sub-field of individual parts are missing
AnyRequired().deserialize({"type": "test"})

# following is invalid because fields of 'RequiredFields' are only partially fulfilled
AnyRequired().deserialize({"field_str": "str"})

# following is valid because although fields of 'RequiredFields' are not all fulfilled, 'RequiredType' is valid
AnyRequired().deserialize({"field_str": "str", "type": "str"})  # result: {"type": "test"}

# following is invalid because 'RequiredFields' field 'field_int' is incorrect schema type
AnyRequired().deserialize({"field_str": "str", "field_int": "str"})

# following is valid, but result omits 'type' because its schema-type is incorrect, while others are valid
AnyRequired().deserialize({"field_str": "str", "field_int": 1, "items": "fields", "type": 1})
# result: {"field_str": "str", "field_int": 1, "items": "fields"}

Warning

Because valid items are applied on top of each other by merging fields during combinations, conflicting field names of any valid schema will contain only the final valid parsing during deserialization.

See also

• OneOfKeywordSchema

• AllOfKeywordSchema

• NotKeywordSchema

_any_of

class weaver.wps_restapi.swagger_definitions.CWLRequirementsItem(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.CWLRequirementsList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

requirement

class weaver.wps_restapi.swagger_definitions.CWLRequirements(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.CWLHintsMap(*args, **kwargs)

Allows specifying all mapping schemas that can be matched for an underlying schema definition. Corresponds to the anyOf specifier of OpenAPI specification.

Contrary to OneOfKeywordSchema that MUST be validated with exactly one schema, this definition will continue parsing all possibilities and apply validated sub-schemas on top of each other. Not all schemas have to be valid like in the case of AllOfKeywordSchema to succeed, as long as at least one of them is valid.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class RequiredType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class RequiredFields(ExtendedMappingSchema):
    field_str = ExtendedSchemaNode(String())
    field_int = ExtendedSchemaNode(Integer())

class AnyRequired(AnyKeywordSchema):
    _any_of = [RequiredItem(), RequiredType(), RequiredFields()]

# following is valid because their individual parts have all required sub-fields, result is their composition
AnyRequired().deserialize({"type": "test", "item": "valid"})     # result: {"type": "test", "item": "valid"}

# following is also valid because even though 'item' is missing, the 'type' is present
AnyRequired().deserialize({"type": "test"})                      # result: {"type": "test"}

# following is invalid because every one of the sub-field of individual parts are missing
AnyRequired().deserialize({"type": "test"})

# following is invalid because fields of 'RequiredFields' are only partially fulfilled
AnyRequired().deserialize({"field_str": "str"})

# following is valid because although fields of 'RequiredFields' are not all fulfilled, 'RequiredType' is valid
AnyRequired().deserialize({"field_str": "str", "type": "str"})  # result: {"type": "test"}

# following is invalid because 'RequiredFields' field 'field_int' is incorrect schema type
AnyRequired().deserialize({"field_str": "str", "field_int": "str"})

# following is valid, but result omits 'type' because its schema-type is incorrect, while others are valid
AnyRequired().deserialize({"field_str": "str", "field_int": 1, "items": "fields", "type": 1})
# result: {"field_str": "str", "field_int": 1, "items": "fields"}

Warning

Because valid items are applied on top of each other by merging fields during combinations, conflicting field names of any valid schema will contain only the final valid parsing during deserialization.

See also

• OneOfKeywordSchema

• AllOfKeywordSchema

• NotKeywordSchema

_any_of

class weaver.wps_restapi.swagger_definitions.CWLHintsItem(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

discriminator = class

_one_of

class weaver.wps_restapi.swagger_definitions.CWLHintsList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

hint

class weaver.wps_restapi.swagger_definitions.CWLHints(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.CWLArguments(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

argument

class weaver.wps_restapi.swagger_definitions.CWLTypeString(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

title = Type

description = Field type definition.

example = float

validator

class weaver.wps_restapi.swagger_definitions.CWLTypeSymbolValues(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.CWLTypeSymbols(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

symbol

class weaver.wps_restapi.swagger_definitions.CWLTypeArray(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

type

items

class weaver.wps_restapi.swagger_definitions.CWLTypeEnum(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

type

symbols

class weaver.wps_restapi.swagger_definitions.CWLTypeBase(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.CWLTypeList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

type

class weaver.wps_restapi.swagger_definitions.CWLType(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

title = CWL Type

_one_of

class weaver.wps_restapi.swagger_definitions.AnyLiteralList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

default

class weaver.wps_restapi.swagger_definitions.CWLDefault(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.CWLInputObject(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

type

default

inputBinding

class weaver.wps_restapi.swagger_definitions.CWLTypeStringList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

description = List of allowed direct CWL type specifications as strings.

type

class weaver.wps_restapi.swagger_definitions.CWLInputType(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

description = CWL type definition of the input.

_one_of

class weaver.wps_restapi.swagger_definitions.CWLInputMap(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

input_id

class weaver.wps_restapi.swagger_definitions.CWLInputItem(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

id

class weaver.wps_restapi.swagger_definitions.CWLInputList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

input

class weaver.wps_restapi.swagger_definitions.CWLInputsDefinition(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.OutputBinding(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

glob

class weaver.wps_restapi.swagger_definitions.CWLOutputObject(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

type

outputBinding

class weaver.wps_restapi.swagger_definitions.CWLOutputType(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.CWLOutputMap(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

output_id

class weaver.wps_restapi.swagger_definitions.CWLOutputItem(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

id

class weaver.wps_restapi.swagger_definitions.CWLOutputList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

input

class weaver.wps_restapi.swagger_definitions.CWLOutputsDefinition(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.CWLCommandParts(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

cmd

class weaver.wps_restapi.swagger_definitions.CWLCommand(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.CWLVersion(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

description = CWL version of the described application package.

example

validator

class weaver.wps_restapi.swagger_definitions.CWL(*args, **kwargs)

Object schema that will allow any unknown field to remain present in the resulting deserialization.

This type is useful for defining a dictionary where some field names are not known in advance, or when more optional keys that don’t need to all be exhaustively provided in the schema are acceptable.

When doing schema deserialization to validate it, unknown keys would normally be removed without this class (default behaviour is to ignore them). With this schema, content under an unknown key is preserved as it was received without any validation. Other fields that are explicitly specified with sub-schema nodes will still be validated as per usual behaviour.

Example:

class AnyKeyObject(PermissiveMappingSchema):
    known_key = SchemaNode(String())

AnyKeyObject().deserialize({"unknown": "kept", "known_key": "requirement"}))
# result: dictionary returned as is instead of removing 'unknown' entry
#         'known_key' is still validated with its string schema

Note

This class is only a shorthand definition of unknown keyword for convenience. All colander.MappingSchema support this natively.

cwlVersion

_class

requirements

hints

baseCommand

arguments

inputs

outputs

class weaver.wps_restapi.swagger_definitions.Unit(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

unit

class weaver.wps_restapi.swagger_definitions.ProcessInputDefaultValues(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

value

class weaver.wps_restapi.swagger_definitions.ProcessInputSupportedValues(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

value

class weaver.wps_restapi.swagger_definitions.ProcessInputDescriptionSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

id

title

dataType

abstract

minOccurs

maxOccurs

defaultValue

supportedValues

class weaver.wps_restapi.swagger_definitions.ProcessInputDescriptionList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

input

class weaver.wps_restapi.swagger_definitions.ProcessOutputDescriptionList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

input

class weaver.wps_restapi.swagger_definitions.ProcessDescriptionSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

id

label

description

inputs

outputs

class weaver.wps_restapi.swagger_definitions.UndeploymentResult(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

id

class weaver.wps_restapi.swagger_definitions.DeploymentResult(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

processSummary

class weaver.wps_restapi.swagger_definitions.ProcessDescriptionBodySchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

process

class weaver.wps_restapi.swagger_definitions.ProvidersSchema(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

providers_service

class weaver.wps_restapi.swagger_definitions.ProcessesSchema(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

provider_processes_service

class weaver.wps_restapi.swagger_definitions.JobOutputValue(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.JobOutput(*args, **kwargs)

Allows specifying all the required partial mapping schemas for an underlying complete schema definition. Corresponds to the allOf specifier of OpenAPI specification.

Example:

class RequiredItem(ExtendedMappingSchema):
    item = ExtendedSchemaNode(String())

class RequiredType(ExtendedMappingSchema):
    type = ExtendedSchemaNode(String())

class AllRequired(AnyKeywordSchema):
    _all_of = [RequiredItem(), RequiredType()]

Value parsed with schema this definition will be valid only when every since one of the sub-schemas is valid. Any sub-schema raising an invalid error for any reason with make the whole schema validation fail.

See also

• OneOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_all_of

class weaver.wps_restapi.swagger_definitions.JobOutputList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

title = JobOutputList

output

class weaver.wps_restapi.swagger_definitions.ResultLiteral(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.ResultLiteralList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

result

class weaver.wps_restapi.swagger_definitions.ValueFormatted(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

value

format

class weaver.wps_restapi.swagger_definitions.ValueFormattedList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

result

class weaver.wps_restapi.swagger_definitions.ResultReference(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

href

format

class weaver.wps_restapi.swagger_definitions.ResultReferenceList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

result

class weaver.wps_restapi.swagger_definitions.ResultData(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

schema_ref

_one_of

class weaver.wps_restapi.swagger_definitions.Result(*args, **kwargs)

Result outputs obtained from a successful process job execution.

example_ref

output_id

class weaver.wps_restapi.swagger_definitions.JobInputsSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

inputs

links

class weaver.wps_restapi.swagger_definitions.JobOutputsSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

outputs

links

class weaver.wps_restapi.swagger_definitions.JobException(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

Code

Locator

Text

class weaver.wps_restapi.swagger_definitions.JobExceptionsSchema(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

exceptions

class weaver.wps_restapi.swagger_definitions.JobLogsSchema(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

log

class weaver.wps_restapi.swagger_definitions.FrontpageParameterSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name

enabled

url

doc

class weaver.wps_restapi.swagger_definitions.FrontpageParameters(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

parameter

class weaver.wps_restapi.swagger_definitions.FrontpageSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

message

configuration

parameters

class weaver.wps_restapi.swagger_definitions.SwaggerJSONSpecSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.SwaggerUISpecSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.VersionsSpecSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

name

type

version

class weaver.wps_restapi.swagger_definitions.VersionsList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

version

class weaver.wps_restapi.swagger_definitions.VersionsSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

versions

class weaver.wps_restapi.swagger_definitions.ConformanceList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

conformance

class weaver.wps_restapi.swagger_definitions.ConformanceSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

conformsTo

class weaver.wps_restapi.swagger_definitions.PackageBody(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.ExecutionUnit(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.ExecutionUnitList(*args, **kwargs)

Combines DefaultSequenceSchema and DefaultSequenceSchema extensions so that default keyword is used first to resolve a missing sequence during deserialize() call, and then removes the node completely if no default was provided.

See also

• ExtendedSchemaNode

• ExtendedMappingSchema

unit

class weaver.wps_restapi.swagger_definitions.ProcessOfferingBase(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

process

processVersion

jobControlOptions

outputTransmission

class weaver.wps_restapi.swagger_definitions.ProcessOffering(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

process

class weaver.wps_restapi.swagger_definitions.ProcessDeploymentOffering(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

process

class weaver.wps_restapi.swagger_definitions.ProcessDescriptionChoiceType(*args, **kwargs)

Allows specifying multiple supported mapping schemas variants for an underlying schema definition. Corresponds to the oneOf specifier of OpenAPI specification.

Example:

class Variant1(MappingSchema):
    [...fields of Variant1...]

class Variant2(MappingSchema):
    [...fields of Variant2...]

class RequiredByBoth(MappingSchema):
    [...fields required by both Variant1 and Variant2...]

class OneOfWithRequiredFields(OneOfKeywordSchema, RequiredByBoth):
    _one_of = (Variant1, Variant2)
    [...alternatively, field required by all variants here...]

In the above example, the validation (ie: deserialize) process will succeed if only one of the _one_of variants’ validator completely succeed, and will fail if every variant fails validation execution. The operation will also fail if more than one validation succeeds.

Note

Class OneOfWithRequiredFields in the example is a shortcut variant to generate a specification that represents the pseudo-code oneOf([<list-of-objects-with-same-base>]).

The real OpenAPI method to implement the above very commonly occurring situation is as presented by the following pseudo-code:

oneOf[allOf[RequiredByBoth, Variant1], allOf[RequiredByBoth, Variant2]]

This is both painful to read and is a lot of extra code to write when you actually expand it all into classes (each oneOf/allOf is another class). Class OneOfKeywordSchema will actually simplify this by automatically making the allOf definitions for you if it detects other schema nodes than oneOf specified in the class bases. You can still do the full oneOf/allOf classes expansion manually though, it will result into the same specification.

Warning

When oneOf/allOf automatic expansion occurs during schema generation

Warning

When calling deserialize(), because the validation process requires exactly one of the variants to succeed to consider the whole object to evaluate as valid, it is important to insert more permissive validators later in the _one_of iterator (or validator keyword). For example, having a variant with all fields defined as optional (ie: with missing=drop) inserted as first item in _one_of will make it always succeed regardless of following variants (since an empty schema with everything dropped is valid for optional-only elements). This would have as side effect of potentially failing the validation if other object are also valid depending on the received schema because the schema cannot be discriminated between many. If this occurs, it means the your schemas are too permissive.

In the event that you have very similar schemas that can sometime match except one identifier (e.g.: field type defining the type of object), consider adding a validator to each sub-node with explicit values to solve the discrimination problem.

As a shortcut, the OpenAPI keyword discriminator can be provided to try matching as a last resort.

For example:

class Animal(ExtendedMappingSchema):
    name = ExtendedSchemaNode(String())
    type = ExtendedSchemaNode(String())  # with explicit definition, this shouldn't be here

    ## With explicit definitions, each below 'Animal' class should be defined as follows
    ## type = ExtendedSchemaNode(String(), validator=colander.OneOf(['<animal>']))

class Cat(Animal):
    [...]   # many **OPTIONAL** fields

class Dog(Animal):
    [...]   # many **OPTIONAL** fields

# With the discriminator keyword, following is possible
class SomeAnimal(OneOfMappingSchema):
    discriminator = {
        "propertyName": "type",     # correspond to 'type' of 'Animal'
        "mapping": {
            "cat": Cat, "dog": Dog  # map expected values to target schemas
        }
    }
    _one_of = [
        Cat(),
        Dog(),
    ]

Note

Keyword discriminator supports a map of key-string to schemas-type as presented in the example, and the key must be located at the top level of the mapping. If only discriminator = "<field>" is provided, the definition will be created automatically using the example (which should be only the matching value) of the corresponding field of each node within the _one_of mapping.

When multiple valid schemas are matched against the input data, the error will be raised and returned with corresponding erroneous elements for each sub-schema (fully listed).

See also

• AllOfKeywordSchema

• AnyOfKeywordSchema

• NotKeywordSchema

_one_of

class weaver.wps_restapi.swagger_definitions.Deploy(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

processDescription

immediateDeployment

executionUnit

deploymentProfileName

owsContext

class weaver.wps_restapi.swagger_definitions.PostProcessesEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.PostProcessJobsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.GetJobsQueries(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

detail

groups

page

limit

status

process

provider

sort

tags

class weaver.wps_restapi.swagger_definitions.GetJobsRequest(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

querystring

class weaver.wps_restapi.swagger_definitions.GetJobsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.GetProcessJobsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.GetProviderJobsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

class weaver.wps_restapi.swagger_definitions.GetProcessJobEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.DeleteProcessJobEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.BillsEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.BillEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProcessQuotesEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.ProcessQuoteEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.GetQuotesQueries(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

page

limit

process

sort

class weaver.wps_restapi.swagger_definitions.QuotesEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

querystring

class weaver.wps_restapi.swagger_definitions.QuoteEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.PostProcessQuote(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.PostQuote(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.PostProcessQuoteRequestEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.GetProviders(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.PostProvider(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.GetProviderProcesses(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.GetProviderProcess(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.PostProviderProcessJobRequest(*args, **kwargs)

Launching a new process request definition.

header

querystring

body

class weaver.wps_restapi.swagger_definitions.ErrorDetail(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

code

status

class weaver.wps_restapi.swagger_definitions.OWSErrorCode(*args, **kwargs)

Combines all colander.SchemaNode extensions so that default keyword is used first to resolve a missing field value during deserialize() call, and then removes the node completely if no default was provided, and evaluate variables as needed.

See also

• ExtendedMappingSchema

• ExtendedSequenceSchema

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

schema_type

example = InvalidParameterValue

description = OWS error code.

class weaver.wps_restapi.swagger_definitions.OWSExceptionResponse(*args, **kwargs)

Error content in XML format

description = OWS formatted exception.

code

locator

message

class weaver.wps_restapi.swagger_definitions.ErrorJsonResponseBodySchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

code

description

error

exception

class weaver.wps_restapi.swagger_definitions.ForbiddenProcessAccessResponseSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = Referenced process is not accessible.

header

body

class weaver.wps_restapi.swagger_definitions.ForbiddenProviderAccessResponseSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = Referenced provider is not accessible.

header

body

class weaver.wps_restapi.swagger_definitions.InternalServerErrorResponseSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = Unhandled internal server error.

header

body

class weaver.wps_restapi.swagger_definitions.OkGetFrontpageResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetSwaggerJSONResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetSwaggerUIResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetRedocUIResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetVersionsResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetConformanceResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetProvidersListResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetProviderCapabilitiesSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.NoContentDeleteProviderSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.NotImplementedDeleteProviderResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = Provider removal not supported using referenced storage.

class weaver.wps_restapi.swagger_definitions.OkGetProviderProcessesSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.GetProcessesQuery(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

providers

detail

class weaver.wps_restapi.swagger_definitions.GetProcessesEndpoint(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

querystring

class weaver.wps_restapi.swagger_definitions.OkGetProcessesListResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkPostProcessDeployBodySchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

deploymentDone

processSummary

failureReason

class weaver.wps_restapi.swagger_definitions.OkPostProcessesResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.BadRequestGetProcessInfoResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = Missing process identifier.

body

class weaver.wps_restapi.swagger_definitions.OkGetProcessInfoResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetProcessPackageSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetProcessPayloadSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.ProcessVisibilityResponseBodySchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

value

class weaver.wps_restapi.swagger_definitions.OkGetProcessVisibilitySchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkPutProcessVisibilitySchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.ForbiddenVisibilityUpdateResponseSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = Visibility value modification not allowed.

header

body

class weaver.wps_restapi.swagger_definitions.OkDeleteProcessUndeployBodySchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

deploymentDone

identifier

failureReason

class weaver.wps_restapi.swagger_definitions.OkDeleteProcessResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetProviderProcessDescriptionResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.CreatedPostProvider(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.NotImplementedPostProviderResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = Provider registration not supported using referenced storage.

class weaver.wps_restapi.swagger_definitions.CreatedLaunchJobResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetProcessJobResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkDeleteProcessJobResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetQueriedJobsResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkDismissJobResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetJobStatusResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.NotFoundJobResponseSchema(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

description = Job reference UUID cannot be found.

examples

header

body

class weaver.wps_restapi.swagger_definitions.OkGetJobInputsResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetJobOutputsResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.RedirectResultResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

class weaver.wps_restapi.swagger_definitions.OkGetJobResultsResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.CreatedQuoteExecuteResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.CreatedQuoteRequestResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetQuoteInfoResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetQuoteListResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetBillDetailResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetBillListResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetJobExceptionsResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

class weaver.wps_restapi.swagger_definitions.OkGetJobLogsResponse(*args, **kwargs)

Combines multiple extensions of colander.MappingSchema handle their corresponding keywords.

Resolution is done so that default keyword is used first to resolve a missing object during deserialize() call, and then removes the node completely if no default was provided.

See also

• DefaultSchemaNode

• DropableSchemaNode

• VariableSchemaNode

• ExtendedSchemaNode

• ExtendedSequenceSchema

• PermissiveMappingSchema

header

body

weaver.wps_restapi.swagger_definitions.get_api_frontpage_responses

weaver.wps_restapi.swagger_definitions.get_openapi_json_responses

weaver.wps_restapi.swagger_definitions.get_api_swagger_ui_responses

weaver.wps_restapi.swagger_definitions.get_api_redoc_ui_responses

weaver.wps_restapi.swagger_definitions.get_api_versions_responses

weaver.wps_restapi.swagger_definitions.get_api_conformance_responses

weaver.wps_restapi.swagger_definitions.get_processes_responses

weaver.wps_restapi.swagger_definitions.post_processes_responses

weaver.wps_restapi.swagger_definitions.get_process_responses

weaver.wps_restapi.swagger_definitions.get_process_package_responses

weaver.wps_restapi.swagger_definitions.get_process_payload_responses

weaver.wps_restapi.swagger_definitions.get_process_visibility_responses

weaver.wps_restapi.swagger_definitions.put_process_visibility_responses

weaver.wps_restapi.swagger_definitions.delete_process_responses

weaver.wps_restapi.swagger_definitions.get_providers_list_responses

weaver.wps_restapi.swagger_definitions.get_provider_responses

weaver.wps_restapi.swagger_definitions.delete_provider_responses

weaver.wps_restapi.swagger_definitions.get_provider_processes_responses

weaver.wps_restapi.swagger_definitions.get_provider_process_responses

weaver.wps_restapi.swagger_definitions.post_provider_responses

weaver.wps_restapi.swagger_definitions.post_provider_process_job_responses

weaver.wps_restapi.swagger_definitions.post_process_jobs_responses

weaver.wps_restapi.swagger_definitions.get_all_jobs_responses

weaver.wps_restapi.swagger_definitions.get_single_job_status_responses

weaver.wps_restapi.swagger_definitions.delete_job_responses

weaver.wps_restapi.swagger_definitions.get_job_inputs_responses

weaver.wps_restapi.swagger_definitions.get_job_outputs_responses

weaver.wps_restapi.swagger_definitions.get_result_redirect_responses

weaver.wps_restapi.swagger_definitions.get_job_results_responses

weaver.wps_restapi.swagger_definitions.get_exceptions_responses

weaver.wps_restapi.swagger_definitions.get_logs_responses

weaver.wps_restapi.swagger_definitions.get_quote_list_responses

weaver.wps_restapi.swagger_definitions.get_quote_responses

weaver.wps_restapi.swagger_definitions.post_quotes_responses

weaver.wps_restapi.swagger_definitions.post_quote_responses

weaver.wps_restapi.swagger_definitions.get_bill_list_responses

weaver.wps_restapi.swagger_definitions.get_bill_responses

weaver.wps_restapi.swagger_definitions.wps_responses

weaver.wps_restapi.swagger_definitions.service_api_route_info(service_api: cornice.Service, settings: weaver.typedefs.SettingsType) → ViewInfo