Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "invalid query parameter value" exception type. #482

Merged
merged 3 commits into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/access-control-expose-headers
label:: /rec/core/access-control-expose-headers

If the server is intended to be accessed from the browser and if Cross-origin resource sharing is supported, the `Access-Control-Expose-Headers` header SHOULD be used and the header SHOULD contain the value `location` to enable the browser to access the `location` header of the response.
====
1 change: 1 addition & 0 deletions core/recommendations/core/REC_api-definition-oas.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/api-definition-oas
label:: /rec/core/api-definition-oas

If the API definition document is defined using the OpenAPI Specification 3.0, the document SHOULD conform to the <<rc_oas30,OpenAPI Specification 3.0 requirements class>>.
====
1 change: 1 addition & 0 deletions core/recommendations/core/REC_content-length.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/content-length
label:: /rec/core/content-length

The server SHOULD include the HTTP 1.1 `Content-Length` header in all responses.
====
1 change: 1 addition & 0 deletions core/recommendations/core/REC_cross-origin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/cross-origin
label:: /rec/core/cross-origin

If the server is intended to be accessed from the browser, cross-origin requests SHOULD be supported. Note that support can also be added in a proxy layer on top of the server.
====
1 change: 1 addition & 0 deletions core/recommendations/core/REC_html.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/html
label:: /rec/core/html

To support browsing an implementation of OGC API - Processes with a web browser and to enable search engines to crawl and index a process, implementations SHOULD consider to support an HTML encoding.
====
1 change: 1 addition & 0 deletions core/recommendations/core/REC_http-head.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/http-head
label:: /rec/core/http-head

The server SHOULD support the HTTP 1.1 method HEAD for all resources that support the method GET.
====
1 change: 1 addition & 0 deletions core/recommendations/core/REC_job-links.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/job-links
label:: /rec/core/job-links

[.component,class=part]
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/job-results-async-many-json-prefer-minimal
label:: /rec/core/job-results-async-many-json-prefer-minimal

[.component,class=conditions]
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/job-results-async-many-json-prefer-none
label:: /rec/core/job-results-async-many-json-prefer-none

[.component,class=conditions]
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/job-results-async-many-json-prefer-representation
label:: /rec/core/job-results-async-many-json-prefer-representation

[.component,class=conditions]
--
Expand Down
1 change: 1 addition & 0 deletions core/recommendations/core/REC_job-status.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/job-status
label:: /rec/core/job-status

[.component,class=part]
--
Expand Down
1 change: 1 addition & 0 deletions core/recommendations/core/REC_link-header.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/link-header
label:: /rec/core/link-header

[.component,class=part]
--
Expand Down
1 change: 1 addition & 0 deletions core/recommendations/core/REC_ogc-process-description.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/ogc-process-description
label:: /rec/core/ogc-process-description

Implementations SHOULD consider supporting the <<ogc_process_description,OGC process description>>.
====
1 change: 1 addition & 0 deletions core/recommendations/core/REC_problem-details.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/problem-details
label:: /rec/core/problem-details

A server SHOULD include a "Problem Details" report in an error response in accordance with https://datatracker.ietf.org/doc/html/rfc7807[RFC 7807].
====
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/process-execute-handle-prefer
label:: /rec/core/process-execute-handle-prefer

A client that accompanies an execute request with the HTTP https://datatracker.ietf.org/doc/html/rfc7240#section-2[`Prefer`] header asserting a https://tools.ietf.org/html/rfc7240#section-4.1[`respond-async`] preference and/or a https://tools.ietf.org/html/rfc7240#section-4.3[`wait`] preference SHOULD be prepared to receive either an asynchronous or a synchronous response.
====
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/process-execute-handle-return-preference
label:: /rec/core/process-execute-handle-return-preference

A client that accompanies an execute request with the HTTP https://datatracker.ietf.org/doc/html/rfc7240#section-2[`Prefer`] header asserting a https://tools.ietf.org/html/rfc7240#section-4.2[`return`] preference SHOULD be prepared to receive output values either:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/process-execute-honor-prefer
label:: /rec/core/process-execute-honor-prefer

[.component,class=part]
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/process-execute-honor-prefer-return
label:: /rec/core/process-execute-honor-prefer-return

If an execute request *is accompanied* with the HTTP https://datatracker.ietf.org/doc/html/rfc7240#section-2[`Prefer`] header asserting a https://datatracker.ietf.org/doc/html/rfc7240#section-4.2[`return`] preference, then the server SHOULD honor that preference.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/process-execute-mode-auto
label:: /rec/core/process-execute-mode-auto

A client that requests a process be executed in `auto` mode SHOULD be prepared to receive either an asynchronous or a synchronous response.
====
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/process-execute-preference-applied
label:: /rec/core/process-execute-preference-applied

If an execute request is accompanied with the HTTP https://datatracker.ietf.org/doc/html/rfc7240#section-2[`Prefer`] header then, in the <<sc_execute_response,response>>, servers SHOULD include the HTTP https://datatracker.ietf.org/doc/html/rfc7240#section-3[`Preference-Applied`] response header as an indication as to which https://datatracker.ietf.org/doc/html/rfc7240#section-2['Prefer`] tokens were honored by the server.
====
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
====
[%metadata]
identifier:: /rec/core/process-execute-sync-many-json-prefer-minimal
label:: /rec/core/process-execute-sync-many-json-prefer-minimal

[.component,class=conditions]
--
. The <<sc_execution_mode,negotiated execution mode>> is synchronous.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
====
[%metadata]
identifier:: /rec/core/process-execute-sync-many-json-prefer-none
label:: /rec/core/process-execute-sync-many-json-prefer-none

[.component,class=conditions]
--
. The <<sc_execution_mode,negotiated execution mode>> is synchronous.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/process-execute-sync-many-json-prefer-representation
label:: /rec/core/process-execute-sync-many-json-prefer-representation

[.component,class=conditions]
--
Expand Down
1 change: 1 addition & 0 deletions core/recommendations/core/REC_process-list-next-1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/next-1
label:: /rec/core/next-1

If more processes summaries have been selected than returned in the response, a `200`-response SHOULD include a link to the next page (relation: `next`) of process summaries.
====
1 change: 1 addition & 0 deletions core/recommendations/core/REC_process-list-next-2.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/next-2
label:: /rec/core/next-2

Dereferencing a next page link (relation: `next`) SHOULD return additional process summaries from the set of selected process summaries that have not yet been returned.
====
1 change: 1 addition & 0 deletions core/recommendations/core/REC_process-list-next-3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/next-3
label:: /rec/core/next-3

The number of process summaries in a response to dereferencing a next page link (relation: `next`) SHOULD follow the same rules as for the response to the original query and again include a next page link (relation: `next`), if there are more process summaries in the selection that have not yet been returned.
====
1 change: 1 addition & 0 deletions core/recommendations/core/REC_test-process.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/core/test-process
label:: /rec/core/test-process

If a server implementing the OGC API - Processes - Part 1: Core is tested using CITE tests, the server SHOULD offer one of the following options:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,7 @@
====
[%metadata]
identifier:: /per/job-list/limit-default-minimum-maximum
label:: /per/job-list/limit-default-minimum-maximum

part:: The values for `minimum`, `maximum` and `default` in requirement `/req/job-list/limit-definition` are only examples and MAY be changed.
====
====
4 changes: 3 additions & 1 deletion core/recommendations/job-list/PER_jl-limit-response.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,7 @@
====
[%metadata]
identifier:: /per/job-list/limit-response
label:: /per/job-list/limit-response

part:: The server MAY return fewer jobs than requested (but not more).
====
====
2 changes: 2 additions & 0 deletions core/recommendations/job-list/PER_prev.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,7 @@
====
[%metadata]
identifier:: /per/job-list/prev
label:: /per/job-list/prev

part:: A response to dereferencing a next page link (relation: `next`) MAY include a previous page link (relation: `prev`) to the resource that included the next page link (relation: `next`).
====
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
====
[%metadata]
identifier:: /rec/job-list/access-control-job-list
label:: /rec/job-list/access-control-job-list

Servers implementing the conformance class 'Job List' SHOULD have an access control in place for the /jobs endpoint to prevent misuse of job-ids.
====
1 change: 1 addition & 0 deletions core/recommendations/job-list/REC_landing-page.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/job-list/job-list-landing-page
label:: /rec/job-list/job-list-landing-page

A link to the following resource SHOULD be added to the API landing page:

Expand Down
1 change: 1 addition & 0 deletions core/recommendations/job-list/REC_next-1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/job-list/next-1
label:: /rec/job-list/next-1

If more jobs have been selected than returned in the respose, a `200`-response SHOULD include a link to the next page (relation: `next`) of jobs.
====
Expand Down
1 change: 1 addition & 0 deletions core/recommendations/job-list/REC_next-2.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/job-list/next-2
label:: /rec/job-list/next-2

Dereferencing a next page link (relation: `next`) SHOULD return additional jobs from the set of selected jobs that have not yet been returned.
====
1 change: 1 addition & 0 deletions core/recommendations/job-list/REC_next-3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/job-list/next-3
label:: /rec/job-list/next-3

If there are more jobs in the selection that have not yet been returned, the number of jobs in a response to dereferencing a next page link (relation: `next`) SHOULD follow the same rules as for the response to the original query and again include a next page link (relation: `next`).
====
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /per/kvp-execute/boolean-input-value
label:: /per/kvp-execute/boolean-input-value

part:: The characteristics of a boolean-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2[`enum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.3[`const`]) that apply to any type.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /per/kvp-execute/complex-input-value
label:: /per/kvp-execute/complex-input-value

part:: The characteristics of a complex-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8[keywords for string-encoded data] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.3[`contentEncoding`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.5[`contentMediaType`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.6[`contentSchema`]).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /per/kvp-execute/numeric-input-value
label:: /per/kvp-execute/numeric-input-value

part:: The characteristics of a numeric input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1[`multipleOf`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2[`maximum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.3[`exclusiveMaximum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4[`minimum`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.5[`exclusiveMinimum`]).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /per/kvp-execute/string-input-value
label:: /per/kvp-execute/string-input-value

part:: The characteristics of a string-valued input parameter MAY include additional https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3[validation keywords] (i.e. https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1[`maxLength`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2[`minLength`], https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3[`pattern`]).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/ogc-process-description/format-key
label:: /rec/ogc-process-description/format-key

Servers SHOULD use the `format` key in the schema description of a process input or output (key: `schema`) to provide additional semantic context that can aid in the interpretation and validation of process input or output values in an <<sc_execute_process,execute>> request.
====
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/ogc-process-description/format-short-code
label:: /rec/ogc-process-description/format-short-code

In addition to the key values listed in <<format-key-values>>, servers SHOULD also accept the short codes.
====
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/ogc-process-description/format-value-registration
label:: /rec/ogc-process-description/format-value-registration

Servers wishing to extend this list of `format` key values, SHOULD officially register such values with the https://www.ogc.org/ogcna[OGC Naming Authority].
====
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /rec/ogc-process-description/process-links
label:: /rec/ogc-process-description/process-links

[.component,class=part]
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /req/callback/job-callback
label:: /req/callback/job-callback

The server SHALL support callback functions for jobs.
====
2 changes: 2 additions & 0 deletions core/requirements/core/REQ_api-definition-op.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
====
[%metadata]
identifier:: /req/core/api-definition-op
label:: /req/core/api-definition-op

The URIs of all API definitions referenced from the landing page
SHALL support the HTTP GET method.
====
2 changes: 2 additions & 0 deletions core/requirements/core/REQ_api-definition-success.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
====
[%metadata]
identifier:: /req/core/api-definition-success
label:: /req/core/api-definition-success

A successful execution of the operation to get the API definition document SHALL be reported as a
response with a HTTP status code `200`.

Expand Down
1 change: 1 addition & 0 deletions core/requirements/core/REQ_conformance-op.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /req/core/conformance-op
label:: /req/core/conformance-op

The server SHALL support the HTTP GET operation at the path `/conformance`.
====
1 change: 1 addition & 0 deletions core/requirements/core/REQ_conformance-success.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /req/core/conformance-success
label:: /req/core/conformance-success

A successful execution of the operation SHALL be reported as a response with a
HTTP status code `200`.
Expand Down
1 change: 1 addition & 0 deletions core/requirements/core/REQ_http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
====
[%metadata]
identifier:: /req/core/http
label:: /req/core/http

The server SHALL conform to <<rfc2616,HTTP 1.1>>.

Expand Down
Loading
Loading