Skip to content

Latest commit

 

History

History
58 lines (53 loc) · 4.64 KB

OGC-API-Common.md

File metadata and controls

58 lines (53 loc) · 4.64 KB
Raw

OGC API Common

https://docs.ogc.org/is/19-072/19-072.html

Requirements

requirement applicable description
/req/core/http ✔️ All operations are over HTTP(S)
/req/core/query-param-name-unknown ❌ Needs to be implemented, correct implementation in the handling of query params
/req/core/query-param-value-invalid ❌ Needs to be implemented, see /req/core/query-param-name-unknown
/req/core/query-param-capitalization ❌ Needs to be implemented, see /req/core/query-param-name-unknown
/req/core/query-param-list-delimiter ❌ Needs to be implemented, see /req/core/query-param-name-unknown
/req/core/query-param-list-escape ❌ Needs to be implemented, see /req/core/query-param-name-unknown
/req/core/query-param-list-empty ❌ Needs to be implemented, see /req/core/query-param-name-unknown
/req/core/query-param-value-boolean ❌ Needs to be implemented, see /req/core/query-param-name-unknown
/req/core/query-param-value-integer ❌ Needs to be implemented, see /req/core/query-param-name-unknown
/req/core/query-param-value-decimal ❌ Needs to be implemented, see /req/core/query-param-name-unknown
/req/core/query-param-value-double ❌ Needs to be implemented, see /req/core/query-param-name-unknown
/req/landing-page/root-op ✔️ Returns the landing page
/req/landing-page/root-success ❌ Needs to be implemented
/req/landing-page/api-definition-op ❌ Needs to be implemented
/req/landing-page/api-definition-success ❌ Needs to be implemented
/req/landing-page/conformance-op ❌ Needs to be implemented
/req/landing-page/conformance-success ❌ Needs to be implemented
/req/html/definition ❌ Needs to be implemented, text/html response for LandingPage and Conformance documents
/req/html/content ❌ Needs to be implemented, returns HTML5 document
/req/json/definition ❌ Needs to be implemented, application/json response for LandingPage and Conformance documents
/req/json/content ❌ Needs to be implemented, LandingPage and Conformance documents need to conform to the correct json schem
/req/oas30/oas-definition-1 ❕ both JSON and HTML version of the API definition need to be available. The response header application/vnd.oai.openapi+json;version=3.0 needs to be implemented for the OAS doc
/req/oas30/oas-definition-2 ✔️ document conform OAS 3.0
/req/oas30/oas-impl ✔️ no missing or incomplete api operations
/req/oas30/completeness ❕ response objects need to be defined
/req/oas30/exceptions-codes ✔️ yes
/req/oas30/security ✔️ nonapplicable

Recommendations

recommendation applicable description
/rec/core/link-header ❕ Needs to be decided and if so what to link
/per/core/additional-status-codes ❕ Needs to be decided and if so what what kind of additional status codes
/rec/core/problem-details ❌ Needs to be implemented
/per/core/query-param-name-specified ❕ nonapplicable
/per/core/query-param-name-tolerance ❕ won't do
/per/core/query-param-value-specified ❌ Needs to be implemented
/per/core/query-param-value-tolerance ❕ won't do
/rec/core/etag ❌ Needs to be implemented
/rec/core/cross-origin ❌ Needs to be implemented
/rec/core/string-i18n ❌ Needs to be implemented
/rec/core/html ❌ Needs to be implemented, need to think about how to visualise the original input vs the transformed output
/rec/core/json ✔️ yes
/rec/core/query-param-capitalization ✔️ yes
/rec/core/query-param-value-special ✔️ oke
/rec/landing-page/api-definition-op ❌ Needs to be implemented, /api SHOULD be implementend. MAY use -f parameter to satisfy this requiremen
/rec/landing-page/api-definition-oas ✔️ yes
/rec/html/schema-org ❌ Needs to be implemented, text/html responses SHOULD include schema.org annotations
/rec/json/problem-details ❌ Needs to be implemented, error respones need to set content-type: application/problem+json and structured following this JSON schema