Skip to content

Commit 32785c7

Browse files
pvretanopvretano
committed
Cleanup comments and other misc updates.
1 parent be07090 commit 32785c7

10 files changed

+155
-175
lines changed

‎core/openapi/ogcapi-records-1-building-blocks.yaml‎

Lines changed: 25 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
1-
openapi: 3.1.0
1+
openapi: 3.0.3
22
info:
33
title: "Building Blocks specified in OGC API - Features - Part 1: Core"
44
description: |-
5-
Common components used in the
6-
[OGC standard "OGC API - Records - Part 1: Core"](https://docs.opengeospatial.org/is/20-004r1/20-004r1.html).
7-
8-
OGC API - Records - Part 1: Core 1.0 is an OGC Standard.
5+
Common components used in the [OGC standard "OGC API - Records - Part 1: Core"](https://docs.opengeospatial.org/is/20-004r1/20-004r1.html).
6+
OGC API - Records - Part 1: Core is an OGC Standard.
97
Copyright (c) 2019 Open Geospatial Consortium.
108
To obtain additional rights of use, visit https://www.ogc.org/about-ogc/policies.
11-
12-
This document is also available on
13-
[OGC](https://schemas.opengis.net/ogcapi/records/part1/1.0/openapi/ogcapi-records-1.yaml).
9+
This document is also available on [OGC](https://schemas.opengis.net/ogcapi/records/part1/1.0/openapi/ogcapi-records-1-building-blocks.yaml).
1410
version: '1.0.0'
1511
contact:
1612
name: Panagiotis Vretanos
@@ -174,7 +170,8 @@ components:
174170
key work but all the swagger validators tried complained
175171
about it.
176172
type: string
177-
const: Collection
173+
enum:
174+
- Collection
178175
conformsTo:
179176
type: array
180177
description: |-
@@ -263,18 +260,6 @@ components:
263260
enum:
264261
- record
265262
- catalog
266-
collection:
267-
allOf:
268-
- $ref: '#/components/schemas/catalog'
269-
- type: object
270-
properties:
271-
itemType:
272-
description: |-
273-
For a collection of records, the itemType is
274-
fixed to "record".
275-
type: string
276-
enum:
277-
- record
278263
contact:
279264
type: object
280265
description: |-
@@ -525,6 +510,17 @@ components:
525510
Most recent date on which the resource pointed
526511
to by the link was changed.
527512
format: date-time
513+
link:
514+
type: object
515+
allOf:
516+
- $ref: '#/components/schemas/linkBase'
517+
- type: object
518+
required:
519+
- href
520+
properties:
521+
href:
522+
type: string
523+
format: uri
528524
linkTemplate:
529525
allOf:
530526
- $ref: '#/components/schemas/linkBase'
@@ -553,17 +549,6 @@ components:
553549
JSON Schema fragment and can thus include things
554550
like the data type of the variable, enumerations,
555551
minimum values, maximum values, etc.
556-
link:
557-
type: object
558-
allOf:
559-
- $ref: '#/components/schemas/linkBase'
560-
- type: object
561-
required:
562-
- href
563-
properties:
564-
href:
565-
type: string
566-
format: uri
567552
recordCollectionGeoJSON:
568553
allOf:
569554
- $ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/featureCollectionGeoJSON.yaml'
@@ -699,25 +684,20 @@ components:
699684
enum:
700685
- Feature
701686
time:
702-
oneOf:
703-
- type: "null"
704-
- $ref: '#/components/schemas/time'
687+
$ref: '#/components/schemas/time'
705688
geometry:
706-
oneOf:
707-
- type: "null"
708-
- $ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml'
689+
$ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml'
709690
conformsTo:
691+
type: array
710692
description: |-
711693
The extensions/conformance classes used in this record.
712-
type: array
713694
items:
714695
type: string
715696
properties:
716-
oneOf:
717-
- type: "null"
718-
- allOf:
719-
- type: object
720-
- $ref: '#/components/schemas/recordCommonProperties'
697+
nullable: true
698+
allOf:
699+
- type: object
700+
- $ref: '#/components/schemas/recordCommonProperties'
721701
links:
722702
type: array
723703
items:
@@ -798,6 +778,7 @@ components:
798778
enumerating the list of schemes in the queryable's schema
799779
definition.
800780
time:
781+
nullable: true
801782
type: object
802783
properties:
803784
date:

‎core/openapi/ogcapi-records-1-example-all-in-one.yaml‎

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,20 @@ info:
44
version: '1.0.0'
55
description: |-
66
This is a sample OpenAPI definition that conforms to the conformance
7-
classes "Core", "GeoJSON", "HTML" and "OpenAPI 3.0" of the draft
8-
standard "OGC API - Records - Part 1: Core".
7+
classes of the "OGC API - Records - Part 1: Core" standard:
98
10-
This example is a generic OGC API - Records definition that uses path
11-
parameters to describe all record collections and all records.
12-
The generic OpenAPI definition does not provide any details on the
13-
collections or the record content. This information is only available
14-
from accessing the record collection resources.
9+
* Searchable Catalog
10+
* Searchable Catalog - Sorting
11+
* Local Resources Catalog
12+
* Local Resources Catalog - Query Parameters
13+
* Local Resources Catalog - Sorting
14+
* OpenAPI 3.0
1515
16-
There is [another example](ogcapi-records-1-example2.yaml)
17-
that specifies each collection explicitly.
16+
This example is a generic definition that uses path parameters to
17+
describe all catalogs and records. The generic OpenAPI definition
18+
does not provide any details on the catalogs or the record content.
19+
This information is only available by accessing the catalog and its
20+
records.
1821
contact:
1922
name: CubeWerx Inc.
2023
email: [email protected]
@@ -376,9 +379,9 @@ components:
376379
enum:
377380
- Collection
378381
conformsTo:
382+
type: array
379383
description: |-
380384
The extensions/conformance classes used in this collection.
381-
type: array
382385
items:
383386
type: string
384387
recordsArrayName:
@@ -414,7 +417,7 @@ components:
414417
items:
415418
$ref: '#/components/schemas/linkTemplate'
416419
defaultSortOrder:
417-
$ref: '#/components/schemas/defaultSortOrder'
420+
$ref: '#/components/schemas/defaultSortOrder'
418421
schemes:
419422
type: array
420423
description: |-
@@ -713,6 +716,17 @@ components:
713716
Most recent date on which the resource pointed
714717
to by the link was changed.
715718
format: date-time
719+
link:
720+
type: object
721+
allOf:
722+
- $ref: '#/components/schemas/linkBase'
723+
- type: object
724+
required:
725+
- href
726+
properties:
727+
href:
728+
type: string
729+
format: uri
716730
linkTemplate:
717731
allOf:
718732
- $ref: '#/components/schemas/linkBase'
@@ -741,17 +755,6 @@ components:
741755
JSON Schema fragment and can thus include things
742756
like the data type of the variable, enumerations,
743757
minimum values, maximum values, etc.
744-
link:
745-
type: object
746-
allOf:
747-
- $ref: '#/components/schemas/linkBase'
748-
- type: object
749-
required:
750-
- href
751-
properties:
752-
href:
753-
type: string
754-
format: uri
755758
recordCollectionGeoJSON:
756759
allOf:
757760
- $ref: 'https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/featureCollectionGeoJSON.yaml'

‎core/openapi/ogcapi-records-1-example-ref-buildingblocks-bundle.yaml‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
1-
openapi: 3.1.0
1+
openapi: 3.0.3
22
info:
33
title: "OGC API - Records - Part 1: Core"
44
version: '1.0.0'
55
description: |-
66
This is a sample OpenAPI definition that conforms to the conformance
7-
classes "Core", "GeoJSON", "HTML" and "OpenAPI 3.0" of the draft
8-
standard "OGC API - Records - Part 1: Core".
7+
classes of the "OGC API - Records - Part 1: Core" standard:
98
10-
This example is a generic OGC API - Records definition that uses path
11-
parameters to describe all record collections and all records.
12-
The generic OpenAPI definition does not provide any details on the
13-
collections or the record content. This information is only available
14-
from accessing the record collection resources.
9+
* Searchable Catalog
10+
* Searchable Catalog - Sorting
11+
* Local Resources Catalog
12+
* Local Resources Catalog - Query Parameters
13+
* Local Resources Catalog - Sorting
14+
* OpenAPI 3.0
1515
16-
There is [another example](ogcapi-records-1-example2.yaml)
17-
that specifies each collection explicitly.
16+
This example is a generic definition that uses path parameters to
17+
describe all catalogs and records. The generic OpenAPI definition
18+
does not provide any details on the catalogs or the record content.
19+
This information is only available by accessing the catalog and its
20+
records.
1821
contact:
1922
name: CubeWerx Inc.
2023
email: [email protected]

0 commit comments

Comments
 (0)