Skip to content

Commit 5b3f5d3

Browse files
authored
Merge pull request #462 from pvretano/profile
Add profile parameter to fix invalid record media type.
2 parents 70536f6 + f3e0728 commit 5b3f5d3

34 files changed

+496
-98
lines changed

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -431,6 +431,15 @@ components:
431431
identifier.
432432
length:
433433
type: integer
434+
profile:
435+
type: array
436+
description:
437+
One or more identifiers that provide information about additional
438+
semantics (constraints, conventions, extensions), in addition to
439+
those defined by the media type, that are associated with the
440+
target resource.
441+
items:
442+
type: string
434443
created:
435444
type: string
436445
description:

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 & 16 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
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: profile
3+
in: query
4+
description:
5+
One or more identifiers that provide information about additional
6+
semantics (constraints, conventions, extensions), in addition to
7+
those defined by the media type, that are associated with the
8+
target resource.
9+
required: false
10+
schema:
11+
type: array
12+
items:
13+
type: string
14+
explode: false
15+
style: form

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/openapi/schemas/linkBase.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,15 @@ properties:
2222
identifier.
2323
length:
2424
type: integer
25+
profile:
26+
type: array
27+
description:
28+
One or more identifiers that provide information about additional
29+
semantics (constraints, conventions, extensions), in addition to
30+
those defined by the media type, that are associated with the
31+
target resource.
32+
items:
33+
type: string
2534
created:
2635
type: string
2736
description:
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[[ats_query-param-profile]]
2+
[conformance_class]
3+
====
4+
[%metadata]
5+
identifier:: http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/query-param-profile
6+
target:: http://www.opengis.net/spec/ogcapi-records-1/1.0/req/query-param-profile
7+
classification:: Target Type:Web API
8+
abstract-test:: /conf/query-param-profile/definition
9+
abstract-test:: /conf/query-param-profile/response
10+
====
11+
12+
==== Query Parameter Profile
13+
14+
include::query-param-profile/ATS_definition.adoc[]
15+
16+
include::query-param-profile/ATS_response.adoc[]

0 commit comments

Comments
 (0)