Skip to content

Commit

Permalink
PB-1157 Add hreflang to specs
Browse files Browse the repository at this point in the history
  • Loading branch information
schtibe committed Dec 9, 2024
1 parent a98edc3 commit ebd0ba3
Show file tree
Hide file tree
Showing 3 changed files with 277 additions and 265 deletions.
4 changes: 4 additions & 0 deletions spec/components/schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1237,6 +1237,10 @@ components:
- GET
- POST
type: string
hreflang:
description: The language of the link target
example: de-CH
type: string
required:
- href
- rel
Expand Down
234 changes: 119 additions & 115 deletions spec/static/spec/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1443,6 +1443,10 @@ components:
- GET
- POST
type: string
hreflang:
description: The language of the link target
example: de-CH
type: string
required:
- href
- rel
Expand Down Expand Up @@ -1794,121 +1798,6 @@ components:
type: string
format: date-time
readOnly: true
parameters:
assetQuery:
description: >-
Query for properties in assets (e.g. mediatype). Use the JSON form of the assetQueryFilter used in POST.
in: query
name: assetQuery
required: false
schema:
type: string
bbox:
explode: false
in: query
name: bbox
required: false
schema:
$ref: "#/components/schemas/bbox"
style: form
collectionId:
description: Local identifier of a collection
in: path
name: collectionId
required: true
schema:
type: string
collectionsArray:
explode: false
in: query
name: collections
required: false
schema:
$ref: "#/components/schemas/collectionsArray"
datetime:
explode: false
in: query
name: datetime
required: false
schema:
$ref: "#/components/schemas/datetimeQuery"
example: 2018-02-12T00%3A00%3A00Z%2F2018-03-18T12%3A31%3A12Z
style: form
featureId:
description: Local identifier of a feature
in: path
name: featureId
required: true
schema:
type: string
assetObjectHref:
name: assetObjectHref
in: path
description: Full URL to asset object including protocol, host and path
required: true
schema:
type: string
ids:
description: >-
Array of Item ids to return. All other filter parameters that further restrict the number of search results are ignored
explode: false
in: query
name: ids
required: false
schema:
$ref: "#/components/schemas/ids"
limit:
explode: false
in: query
name: limit
required: false
schema:
$ref: "#/components/schemas/limit"
style: form
query:
description: Query for properties in items. Use the JSON form of the queryFilter used in POST.
in: query
name: query
required: false
schema:
type: string
IfNoneMatch:
name: If-None-Match
in: header
schema:
type: string
description: >-
The RFC7232 `If-None-Match` header field makes the GET request method conditional. It is composed of a comma separated list of ETags or value "*".
The server compares the client's ETags (sent with `If-None-Match`) with the ETag for its current version of the resource, and if both values match (that is, the resource has not changed), the server sends back a `304 Not Modified` status, without a body, which tells the client that the cached version of the response is still good to use (fresh).
example: "d01af8b8ebbf899e30095be8754b377ddb0f0ed0f7fddbc33ac23b0d1969736b"
IfMatch:
name: If-Match
in: header
schema:
type: string
description: >-
The RFC7232 `If-Match` header field makes the GET request method conditional. It is composed of a comma separated list of ETags or value "*".
The server compares the client's ETags (sent with `If-Match`) with the ETag for its current version of the resource, and if both values don't match (that is, the resource has changed), the server sends back a `412 Precondition Failed` status, without a body, which tells the client that the cached version of the response is not good to use anymore.
example: "d01af8b8ebbf899e30095be8754b377ddb0f0ed0f7fddbc33ac23b0d1969736b"
provider:
name: provider
in: query
description: Filter collections by the name of the provider. Supports partial and case-insensitive matching.
required: false
schema:
type: string
headers:
ETag:
schema:
type: string
description: >-
The RFC7232 ETag header field in a response provides the current entity- tag for the selected resource. An entity-tag is an opaque identifier for different versions of a resource over time, regardless whether multiple versions are valid at the same time. An entity-tag consists of an opaque quoted string, possibly prefixed by a weakness indicator.
example: "d01af8b8ebbf899e30095be8754b377ddb0f0ed0f7fddbc33ac23b0d1969736b"
required: true
responses:
Collection:
headers:
Expand Down Expand Up @@ -2114,3 +2003,118 @@ components:
example:
code: 500
description: "Internal server error"
parameters:
assetQuery:
description: >-
Query for properties in assets (e.g. mediatype). Use the JSON form of the assetQueryFilter used in POST.
in: query
name: assetQuery
required: false
schema:
type: string
bbox:
explode: false
in: query
name: bbox
required: false
schema:
$ref: "#/components/schemas/bbox"
style: form
collectionId:
description: Local identifier of a collection
in: path
name: collectionId
required: true
schema:
type: string
collectionsArray:
explode: false
in: query
name: collections
required: false
schema:
$ref: "#/components/schemas/collectionsArray"
datetime:
explode: false
in: query
name: datetime
required: false
schema:
$ref: "#/components/schemas/datetimeQuery"
example: 2018-02-12T00%3A00%3A00Z%2F2018-03-18T12%3A31%3A12Z
style: form
featureId:
description: Local identifier of a feature
in: path
name: featureId
required: true
schema:
type: string
assetObjectHref:
name: assetObjectHref
in: path
description: Full URL to asset object including protocol, host and path
required: true
schema:
type: string
ids:
description: >-
Array of Item ids to return. All other filter parameters that further restrict the number of search results are ignored
explode: false
in: query
name: ids
required: false
schema:
$ref: "#/components/schemas/ids"
limit:
explode: false
in: query
name: limit
required: false
schema:
$ref: "#/components/schemas/limit"
style: form
query:
description: Query for properties in items. Use the JSON form of the queryFilter used in POST.
in: query
name: query
required: false
schema:
type: string
IfNoneMatch:
name: If-None-Match
in: header
schema:
type: string
description: >-
The RFC7232 `If-None-Match` header field makes the GET request method conditional. It is composed of a comma separated list of ETags or value "*".
The server compares the client's ETags (sent with `If-None-Match`) with the ETag for its current version of the resource, and if both values match (that is, the resource has not changed), the server sends back a `304 Not Modified` status, without a body, which tells the client that the cached version of the response is still good to use (fresh).
example: "d01af8b8ebbf899e30095be8754b377ddb0f0ed0f7fddbc33ac23b0d1969736b"
IfMatch:
name: If-Match
in: header
schema:
type: string
description: >-
The RFC7232 `If-Match` header field makes the GET request method conditional. It is composed of a comma separated list of ETags or value "*".
The server compares the client's ETags (sent with `If-Match`) with the ETag for its current version of the resource, and if both values don't match (that is, the resource has changed), the server sends back a `412 Precondition Failed` status, without a body, which tells the client that the cached version of the response is not good to use anymore.
example: "d01af8b8ebbf899e30095be8754b377ddb0f0ed0f7fddbc33ac23b0d1969736b"
provider:
name: provider
in: query
description: Filter collections by the name of the provider. Supports partial and case-insensitive matching.
required: false
schema:
type: string
headers:
ETag:
schema:
type: string
description: >-
The RFC7232 ETag header field in a response provides the current entity- tag for the selected resource. An entity-tag is an opaque identifier for different versions of a resource over time, regardless whether multiple versions are valid at the same time. An entity-tag consists of an opaque quoted string, possibly prefixed by a weakness indicator.
example: "d01af8b8ebbf899e30095be8754b377ddb0f0ed0f7fddbc33ac23b0d1969736b"
required: true
Loading

0 comments on commit ebd0ba3

Please sign in to comment.