Skip to content

Commit 84cc1a2

Browse files
committed
Reference parameter defs in the text rather than copy.
1 parent 846ccbf commit 84cc1a2

10 files changed

Lines changed: 35 additions & 61 deletions

File tree

core/openapi/ogcapi-records-1-example-ref-schema-repo.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ paths:
169169
- $ref: 'parameters/catalogId.yaml'
170170
- $ref: 'parameters/q.yaml'
171171
- $ref: 'parameters/type.yaml'
172-
- $ref: 'parameters/externalId.yaml'
172+
- $ref: 'parameters/externalIds.yaml'
173173
- $ref: 'parameters/ids.yaml'
174174
- $ref: 'parameters/sortby.yaml'
175175
responses:

core/openapi/parameters/externalId.yaml

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: externalIds
3+
in: query
4+
description: |-
5+
The optional externalIds parameter allows a specific list of records,
6+
identified by their external identifiers, to be fetched from a catalog.
7+
Only records where one of their associated external identifiers equals
8+
one of the values listed for this parameter shall appear in the response.
9+
required: false
10+
schema:
11+
type: array
12+
items:
13+
type: string
14+
pattern: ([^:]+:)?[^:]+
15+
explode: false
16+
style: form

core/openapi/parameters/ids.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
name: ids
33
in: query
44
description:
5-
The optional ids parameter allows a specified of records to be fetched
6-
from a catalog using their identifiers.
5+
The optional ids parameter allows a specific list of records, identified
6+
by their identifiers, to be fetched from a catalog. Only records whose
7+
identifier matches one of the values listed for this parameter shall appear
8+
in the response.
79
required: false
810
schema:
911
type: array

core/openapi/parameters/q.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: |-
55
The optional q parameter supports keyword searching. Only records
66
whose text fields contain one or more of the specified search terms
77
are selected. The specific set of text keys/fields/properties of a
8-
record to which the q operator is applied is up to the description
8+
record to which the q operator is applied is up to the discretion
99
of the server. Implementations should, however, apply the q
1010
operator to the title, description and keywords keys/fields/properties.
1111
required: false

core/openapi/parameters/type.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22
name: type
33
in: query
44
description: |-
5-
The optional type parameter supports searching by resource type. Only
6-
records whose type, as indicated by the value of the type core
7-
queryable, is equal to one of the listed values shall be selected.
5+
The optional type parameter allows a specific list of records, identified
6+
by their resource type, to be fetched from a catalog. Only records whose
7+
resource type matches one of the values listed for this parameter shall
8+
appear in the response.
89
required: false
910
schema:
1011
type: array
1112
items:
1213
type: string
1314
explode: false
1415
style: form
16+
17+

core/standard/requirements/building-blocks/record-core-query-parameters/REQ_query-param-externalIds-definition.adoc

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,7 @@ part:: The `externalIds` parameter SHALL have the following characteristics (usi
3030
+
3131
[source,YAML]
3232
----
33-
name: externalIds
34-
in: query
35-
required: false
36-
schema:
37-
type: array
38-
items:
39-
type: string
40-
pattern: ([^:]+:)?[^:]+
41-
explode: false
33+
include::../../../../openapi/parameters/externalIds.yaml[]
4234
----
4335
44-
====
36+
====

core/standard/requirements/building-blocks/record-core-query-parameters/REQ_query-param-ids-definition.adoc

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,7 @@ part:: The following OpenAPI 3.0 schema fragment SHALL define the characteristic
3232
+
3333
[source,YAML]
3434
----
35-
name: ids
36-
in: query
37-
required: false
38-
schema:
39-
type: array
40-
items:
41-
type: string
42-
explode: false
43-
style: form
35+
include::../../../../openapi/parameters/ids.yaml[]
4436
----
37+
4538
====

core/standard/requirements/building-blocks/record-core-query-parameters/REQ_query-param-q-definition.adoc

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,7 @@ part:: The `q` parameter SHALL have the following characteristics (using an Open
3434
+
3535
[source,YAML]
3636
----
37-
name: q
38-
in: query
39-
required: false
40-
schema:
41-
type: array
42-
items:
43-
type: string
44-
explode: false
45-
style: form
37+
include::../../../../openapi/parameters/q.yaml[]
4638
----
4739
4840
part:: Search terms that may appear together (logical OR) in a record SHALL be separated by literal commas.

core/standard/requirements/building-blocks/record-core-query-parameters/REQ_query-param-type-definition.adoc

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,7 @@ part:: The `type` parameter SHALL have the following characteristics (using an O
3030
3131
[source,YAML]
3232
----
33-
name: type
34-
in: query
35-
required: false
36-
schema:
37-
type: array
38-
items:
39-
type: string
40-
explode: false
41-
style: form
33+
include::../../../../openapi/parameters/type.yaml[]
4234
----
35+
4336
====

0 commit comments

Comments
 (0)