Skip to content
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
47 changes: 14 additions & 33 deletions core/openapi/ogcapi-records-1-building-blocks.yaml
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
openapi: 3.1.0
openapi: 3.0.3
info:
title: "Building Blocks specified in OGC API - Features - Part 1: Core"
description: |-
Common components used in the
[OGC standard "OGC API - Records - Part 1: Core"](https://docs.opengeospatial.org/is/20-004r1/20-004r1.html).

OGC API - Records - Part 1: Core 1.0 is an OGC Standard.
Common components used in the [OGC standard "OGC API - Records - Part 1: Core"](https://docs.opengeospatial.org/is/20-004r1/20-004r1.html).
OGC API - Records - Part 1: Core is an OGC Standard.
Copyright (c) 2019 Open Geospatial Consortium.
To obtain additional rights of use, visit https://www.ogc.org/about-ogc/policies.

This document is also available on
[OGC](https://schemas.opengis.net/ogcapi/records/part1/1.0/openapi/ogcapi-records-1.yaml).
This document is also available on [OGC](https://schemas.opengis.net/ogcapi/records/part1/1.0/openapi/ogcapi-records-1-building-blocks.yaml).
version: '1.0.0'
contact:
name: Panagiotis Vretanos
Expand Down Expand Up @@ -174,7 +170,8 @@ components:
key work but all the swagger validators tried complained
about it.
type: string
const: Collection
enum:
- Collection
conformsTo:
type: array
description: |-
Expand Down Expand Up @@ -263,18 +260,6 @@ components:
enum:
- record
- catalog
collection:
allOf:
- $ref: '#/components/schemas/catalog'
- type: object
properties:
itemType:
description: |-
For a collection of records, the itemType is
fixed to "record".
type: string
enum:
- record
contact:
type: object
description: |-
Expand Down Expand Up @@ -699,25 +684,20 @@ components:
enum:
- Feature
time:
oneOf:
- type: "null"
- $ref: '#/components/schemas/time'
$ref: '#/components/schemas/time'
geometry:
oneOf:
- type: "null"
- $ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml'
$ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml'
conformsTo:
type: array
description: |-
The extensions/conformance classes used in this record.
type: array
items:
type: string
properties:
oneOf:
- type: "null"
- allOf:
- type: object
- $ref: '#/components/schemas/recordCommonProperties'
nullable: true
allOf:
- type: object
- $ref: '#/components/schemas/recordCommonProperties'
links:
type: array
items:
Expand Down Expand Up @@ -798,6 +778,7 @@ components:
enumerating the list of schemes in the queryable's schema
definition.
time:
nullable: true
type: object
properties:
date:
Expand Down
23 changes: 13 additions & 10 deletions core/openapi/ogcapi-records-1-example-all-in-one.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,20 @@ info:
version: '1.0.0'
description: |-
This is a sample OpenAPI definition that conforms to the conformance
classes "Core", "GeoJSON", "HTML" and "OpenAPI 3.0" of the draft
standard "OGC API - Records - Part 1: Core".
classes of the "OGC API - Records - Part 1: Core" standard:

This example is a generic OGC API - Records definition that uses path
parameters to describe all record collections and all records.
The generic OpenAPI definition does not provide any details on the
collections or the record content. This information is only available
from accessing the record collection resources.
* Searchable Catalog
* Searchable Catalog - Sorting
* Local Resources Catalog
* Local Resources Catalog - Query Parameters
* Local Resources Catalog - Sorting
* OpenAPI 3.0

There is [another example](ogcapi-records-1-example2.yaml)
that specifies each collection explicitly.
This example is a generic definition that uses path parameters to
describe all catalogs and records. The generic OpenAPI definition
does not provide any details on the catalogs or the record content.
This information is only available by accessing the catalog and its
records.
contact:
name: CubeWerx Inc.
email: [email protected]
Expand Down Expand Up @@ -376,9 +379,9 @@ components:
enum:
- Collection
conformsTo:
type: array
description: |-
The extensions/conformance classes used in this collection.
type: array
items:
type: string
recordsArrayName:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
openapi: 3.1.0
openapi: 3.0.3
info:
title: "OGC API - Records - Part 1: Core"
version: '1.0.0'
description: |-
This is a sample OpenAPI definition that conforms to the conformance
classes "Core", "GeoJSON", "HTML" and "OpenAPI 3.0" of the draft
standard "OGC API - Records - Part 1: Core".
classes of the "OGC API - Records - Part 1: Core" standard:

This example is a generic OGC API - Records definition that uses path
parameters to describe all record collections and all records.
The generic OpenAPI definition does not provide any details on the
collections or the record content. This information is only available
from accessing the record collection resources.
* Searchable Catalog
* Searchable Catalog - Sorting
* Local Resources Catalog
* Local Resources Catalog - Query Parameters
* Local Resources Catalog - Sorting
* OpenAPI 3.0

There is [another example](ogcapi-records-1-example2.yaml)
that specifies each collection explicitly.
This example is a generic definition that uses path parameters to
describe all catalogs and records. The generic OpenAPI definition
does not provide any details on the catalogs or the record content.
This information is only available by accessing the catalog and its
records.
contact:
name: CubeWerx Inc.
email: [email protected]
Expand Down
25 changes: 14 additions & 11 deletions core/openapi/ogcapi-records-1-example-ref-schema-repo.yaml
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
openapi: 3.1.0
openapi: 3.0.3
info:
title: "OGC API - Records - Part 1: Core"
version: '1.0.0'
description: |-
This is a sample OpenAPI definition that conforms to the conformance
classes "Core", "GeoJSON", "HTML" and "OpenAPI 3.0" of the draft
standard "OGC API - Records - Part 1: Core".
classes of the "OGC API - Records - Part 1: Core" standard:

This example is a generic OGC API - Records definition that uses path
parameters to describe all record collections and all records.
The generic OpenAPI definition does not provide any details on the
collections or the record content. This information is only available
from accessing the record collection resources.

There is [another example](ogcapi-records-1-example2.yaml)
that specifies each collection explicitly.
* Searchable Catalog
* Searchable Catalog - Sorting
* Local Resources Catalog
* Local Resources Catalog - Query Parameters
* Local Resources Catalog - Sorting
* OpenAPI 3.0

This example is a generic definition that uses path parameters to
describe all catalogs and records. The generic OpenAPI definition
does not provide any details on the catalogs or the record content.
This information is only available by accessing the catalog and its
records.
contact:
name: CubeWerx Inc.
email: [email protected]
Expand Down
5 changes: 4 additions & 1 deletion core/openapi/schemas/catalogCommonProperties.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ allOf:
Fixed to "Collection" for collections of records and/or subordinate
catalogs.
type: string
const: Collection
enum:
- Collection
conformsTo:
type: array
description: |-
Expand Down Expand Up @@ -49,6 +50,8 @@ allOf:
type: array
items:
$ref: 'linkTemplate.yaml'
defaultSortOrder:
$ref: 'defaultSortOrder.yaml'
schemes:
type: array
description: |-
Expand Down
3 changes: 2 additions & 1 deletion core/openapi/schemas/collection.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ allOf:
For a collection of records, the itemType is
fixed to "record".
type: string
const: record
enum:
- record
3 changes: 0 additions & 3 deletions core/openapi/schemas/recordCommonProperties.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@ properties:
items:
$ref: 'theme.yaml'
language:
description: |-
The language used for textual values in this
record representation.
$ref: 'language.yaml'
languages:
type: array
Expand Down
26 changes: 11 additions & 15 deletions core/openapi/schemas/recordGeoJSON.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,30 @@ required:
- properties
properties:
id:
type:
- string
- integer
oneOf:
- type: string
- type: integer
description: |-
A unique identifier of the catalog record.
type:
type: string
const: Feature
enum:
- Feature
time:
oneOf:
- type: "null"
- $ref: 'time.yaml'
$ref: 'time.yaml'
geometry:
oneOf:
- type: "null"
- $ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml'
$ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml'
conformsTo:
type: array
description: |-
The extensions/conformance classes used in this record.
items:
type: string
properties:
oneOf:
- type: "null"
- allOf:
- type: object
- $ref: 'recordCommonProperties.yaml'
nullable: true
allOf:
- type: object
- $ref: 'recordCommonProperties.yaml'
links:
type: array
items:
Expand Down
18 changes: 5 additions & 13 deletions core/openapi/schemas/recordJSON.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,15 @@ allOf:
- id
properties:
id:
type: string
description: |-
The unique identifier for this record.
time:
description: |-
A characteristic time or time interval associated
with the resource that this record described.
oneOf:
- type: "null"
- $ref: 'time.yaml'
- type: string
- type: integer
time:
$ref: 'time.yaml'
geometry:
description: |-
A characteristic spatial extent association with
the resource that this record described.
oneOf:
- type: "null"
- $ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml'
$ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml'
conformsTo:
type: array
description: |-
Expand Down
1 change: 1 addition & 0 deletions core/openapi/schemas/time.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
nullable: true
type: object
properties:
date:
Expand Down