Skip to content

Commit bb9aeb1

Browse files
committed
openapi: Fixed SwaggerHub warnings for numberMatched and numberReturned
- The numberMatched.yaml and numberReturned.yaml files should have been referenced in the collections response - Using elements rather than features and items to avoid confusion with OGC API - Features "items"
1 parent ea75da7 commit bb9aeb1

File tree

4 files changed

+12
-21
lines changed

4 files changed

+12
-21
lines changed

openapi/ogcapi-maps-1.bundled.json

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1522,14 +1522,10 @@
15221522
"format": "date-time"
15231523
},
15241524
"numberMatched": {
1525-
"type": "integer",
1526-
"minimum": 0,
1527-
"example": 1
1525+
"$ref": "#/components/schemas/numberMatched"
15281526
},
15291527
"numberReturned": {
1530-
"type": "integer",
1531-
"minimum": 0,
1532-
"example": 1
1528+
"$ref": "#/components/schemas/numberReturned"
15331529
},
15341530
"collections": {
15351531
"type": "array",
@@ -2087,13 +2083,13 @@
20872083
"example": "2017-08-17T08:05:32Z"
20882084
},
20892085
"numberReturned": {
2090-
"description": "The number of items in the response.\nA server may omit this information, if the information about the \nnumber of items is not known or difficult to compute.\nIf the value is provided, the value shall be identical to the number\nof items in the response.",
2086+
"description": "The number of elements in the response.\nA server may omit this information, if the information about the\nnumber of elements is not known or difficult to compute.\nIf the value is provided, the value shall be identical to the number\nof elements in the response.",
20912087
"type": "integer",
20922088
"minimum": 0,
20932089
"example": 10
20942090
},
20952091
"numberMatched": {
2096-
"description": "The number of features of the feature type that match the selection\nparameters like `bbox`.",
2092+
"description": "The number of elements in the response that match the selection parameters like `bbox`.",
20972093
"type": "integer",
20982094
"minimum": 0,
20992095
"example": 127

openapi/schemas/common-geodata/collections.yaml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,9 @@ properties:
1111
type: string
1212
format: date-time
1313
numberMatched:
14-
type: integer
15-
minimum: 0
16-
example: 1
14+
$ref: 'numberMatched.yaml'
1715
numberReturned:
18-
type: integer
19-
minimum: 0
20-
example: 1
16+
$ref: 'numberReturned.yaml'
2117
collections:
2218
type: array
2319
items:
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
description: |-
2-
The number of features of the feature type that match the selection
3-
parameters like `bbox`.
2+
The number of elements in the response that match the selection parameters like `bbox`.
43
type: integer
54
minimum: 0
6-
example: 127
5+
example: 127
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
description: |-
2-
The number of items in the response.
3-
A server may omit this information, if the information about the
4-
number of items is not known or difficult to compute.
2+
The number of elements in the response.
3+
A server may omit this information, if the information about the
4+
number of elements is not known or difficult to compute.
55
If the value is provided, the value shall be identical to the number
6-
of items in the response.
6+
of elements in the response.
77
type: integer
88
minimum: 0
99
example: 10

0 commit comments

Comments
 (0)