Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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
973 changes: 324 additions & 649 deletions core/openapi/ogcapi-records-1-building-blocks.yaml

Large diffs are not rendered by default.

1,184 changes: 1,184 additions & 0 deletions core/openapi/ogcapi-records-1-example-all-in-one.yaml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,14 @@ paths:
operationId: describeCollection
parameters:
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/catalogId'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/bbox'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/datetime'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/limit'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/q'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/type'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/externalIds'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/ids'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/sortby'
responses:
'200':
$ref: 'ogcapi-records-1-building-blocks.yaml#/components/responses/Catalog'
Expand Down Expand Up @@ -170,7 +178,7 @@ paths:
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/limit'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/q'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/type'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/externalId'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/externalIds'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/ids'
- $ref: 'ogcapi-records-1-building-blocks.yaml#/components/parameters/sortby'
responses:
Expand Down
8 changes: 8 additions & 0 deletions core/openapi/ogcapi-records-1-example-ref-schema-repo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,14 @@ paths:
operationId: describeCollection
parameters:
- $ref: 'parameters/catalogId.yaml'
- $ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/parameters/bbox.yaml'
- $ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/parameters/datetime.yaml'
- $ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/parameters/limit.yaml'
- $ref: 'parameters/q.yaml'
- $ref: 'parameters/type.yaml'
- $ref: 'parameters/externalIds.yaml'
- $ref: 'parameters/ids.yaml'
- $ref: 'parameters/sortby.yaml'
responses:
'200':
$ref: 'responses/Catalog.yaml'
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/parameters/ids.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: ids
in: query
description:
description: |-
The optional ids parameter allows a specific list of records, identified
by their identifiers, to be fetched from a catalog. Only records whose
identifier matches one of the values listed for this parameter shall appear
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/parameters/profile.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: profile
in: query
description:
description: |-
One or more identifiers that provide information about additional
semantics (constraints, conventions, extensions), in addition to
those defined by the media type, that are associated with the
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/responses/BadRequest.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description:
description: |-
A client error occurred.
content:
application/json:
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/responses/Catalogs.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description:
description: |-
Information about the list of catalogs offered by this service.
content:
application/json:
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/responses/ConformanceDeclaration.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description:
description: |-
The URIs of all conformance classes supported by the server.
content:
application/json:
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/responses/InvalidParameter.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description:
description: |-
A query parameter has an invalid value.
content:
application/json:
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/responses/LandingPage.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description:
description: |-
The landing page provides links to the API definition (link relations
`service-desc` and `service-doc`), the Conformance declaration (path
`/conformance`, link relation `conformance`), and the Record Collections
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/responses/NotAcceptable.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description:
description: |-
Content negotiation failed. For example, the `Accept` header submitted
in the request did not support any of the media types supported by the
server for the requested resource.
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/responses/NotFound.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description:
description: |-
The requested resource does not exist on the server. For example,
a path parameter had an incorrect value.
content:
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/responses/Record.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description:
description: |-
Fetch the record with id `recordId` in the record collection
with id `collectionId`
content:
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/responses/Records.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description:
description: |-
The response is a document consisting of records in the collection.
The records included in the response are determined by the server
based on the query parameters of the request. To support access to
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/responses/ServerError.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description:
description: |-
A server error occurred.
content:
application/json:
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/responses/Sortables.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description:
description: |-
A list of properties by which the server response may be sorted.
content:
application/json:
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/schemas/catalog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ allOf:
- type: object
properties:
itemType:
description:
description: |-
If this catalog is a homogenous collection
of records then itemType is a string of fixed
value of record.
Expand Down
13 changes: 7 additions & 6 deletions core/openapi/schemas/catalogCommonProperties.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,20 @@ allOf:
- type
properties:
type:
description:
description: |-
Fixed to "Collection" for collections of records and/or subordinate
catalogs.
type: string
const: Collection
enum:
- Collection
conformsTo:
type: array
description:
description: |-
The extensions/conformance classes used in this collection.
items:
type: string
recordsArrayName:
description:
description: |-
If records are encoded in-line within the catalog object,
this member advertises the name of the array member that
contains the catalog records. By default the name of the
Expand All @@ -33,7 +34,7 @@ allOf:
default: records
records:
type: array
description:
description: |-
An array of records that are part of this catalog that
are encoded in-line within the catalog object.
The items schema is intentionally general (i.e. object)
Expand All @@ -51,7 +52,7 @@ allOf:
$ref: 'linkTemplate.yaml'
schemes:
type: array
description:
description: |-
A list of schemes used in this context.
items:
$ref: 'scheme.yaml'
2 changes: 1 addition & 1 deletion core/openapi/schemas/collection.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ allOf:
- type: object
properties:
itemType:
description:
description: |-
For a collection of records, the itemType is
fixed to "record".
type: string
Expand Down
13 changes: 7 additions & 6 deletions core/openapi/schemas/contact.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ properties:
The name of the responsible person.
position:
type: string
description:
description: |-
The name of the role or position of the responsible person taken
from the organization's formal organizational hierarchy or chart.
organization:
type: string
description:
description: |-
Organization/affiliation of the contact.
logo:
description:
description: |-
Graphic identifying a contact. The link relation should be `icon`
and the media type should be an image media type.
allOf:
Expand Down Expand Up @@ -94,9 +94,10 @@ properties:
description: ZIP or other postal code.
country:
type: string
description: Country of the physical address. ISO 3166-1 is recommended.
description: |-
Country of the physical address. ISO 3166-1 is recommended.
roles:
description:
description: |-
The type of address (e.g. office, home, etc.).
$ref: 'roles.yaml'
links:
Expand All @@ -117,7 +118,7 @@ properties:
Supplemental instructions on how or when to contact the
responsible party.
roles:
description:
description: |-
The set of named duties, job functions and/or permissions
associated with this contact.
(e.g. developer, administrator, etc.).
Expand Down
10 changes: 5 additions & 5 deletions core/openapi/schemas/language.yaml
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
---
type: object
description:
description: |-
The language used for textual values in this record.
required:
- code
properties:
code:
type: string
description:
description: |-
The language tag as per RFC-5646.
name:
type: string
minLength: 1
description:
description: |-
The untranslated name of the language.
alternate:
type: string
description:
description: |-
The name of the language in another well-understood language,
usually English.
dir:
type: string
description:
description: |-
The direction for text in this language. The default, `ltr`
(left-to-right), represents the most common situation.
However, care should be taken to set the value of `dir`
Expand Down
2 changes: 1 addition & 1 deletion core/openapi/schemas/license.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
type: string
description:
description: |-
A legal document under which the resource is made available.
If the resource is being made available under a common license
then use an SPDX license id (https://spdx.org/licenses/).
Expand Down
12 changes: 6 additions & 6 deletions core/openapi/schemas/linkBase.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ properties:
description: The type or semantics of the relation.
type:
type: string
description:
description: |-
A hint indicating what the media type of the
result of dereferencing the link should be.
hreflang:
type: string
description:
description: |-
A hint indicating what the language of the
result of dereferencing the link should be.
title:
type: string
description:
description: |-
Used to label the destination of a link
such that it can be used as a human-readable
identifier.
length:
type: integer
profile:
type: array
description:
description: |-
One or more identifiers that provide information about additional
semantics (constraints, conventions, extensions), in addition to
those defined by the media type, that are associated with the
Expand All @@ -33,13 +33,13 @@ properties:
type: string
created:
type: string
description:
description: |-
Date of creation of the resource pointed to
by the link.
format: date-time
updated:
type: string
description:
description: |-
Most recent date on which the resource pointed
to by the link was changed.
format: date-time
6 changes: 3 additions & 3 deletions core/openapi/schemas/linkTemplate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ allOf:
properties:
uriTemplate:
type: string
description:
description: |-
Supplies a resolvable URI to a remote resource
(or resource fragment).
varBase:
type: string
description:
description: |-
The base URI to which the variable name can be
appended to retrieve the definition of the
variable as a JSON Schema fragment.
format: uri-reference
variables:
type: object
description:
description: |-
This object contains one key per substitution
variable in the templated URL. Each key defines
the schema of one substitution variable using a
Expand Down
Loading