-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
collections/searchable: below-sd parameter requirements and other fixes
- Fixed requirement IDs - Simplified and improved multiple requirements
- Loading branch information
1 parent
b5a9ca9
commit 7969180
Showing
20 changed files
with
81 additions
and
102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...s/searchable-collections/PER_rc-prev.adoc → ...able-collections/PER_searchable-prev.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[[per_collections_rc-prev]] | ||
[[per_searchable_prev]] | ||
[width="90%",cols="2,6a"] | ||
|=== | ||
^|*Permission {counter:per-id}* |*/per/collections/rc-prev* | ||
^|*Permission {counter:per-id}* |*/per/searchable/prev* | ||
^|A |A response to a `next` link MAY include a `prev` link to the resource that included the `next` link. | ||
|=== |
4 changes: 2 additions & 2 deletions
4
...able-collections/PER_rc-server-limit.adoc → ...lections/PER_searchable-server-limit.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[[per_collections_rc-server-limit]] | ||
[[per_searchable_server-limit]] | ||
[width="90%",cols="2,6a"] | ||
|=== | ||
^|*Permission {counter:per-id}* |*/per/collections/rc-server-limit* | ||
^|*Permission {counter:per-id}* |*/per/searchable/server-limit* | ||
^|A |If a server is configured with a maximum response size, then the server MAY page responses which exceed that threshold. | ||
|=== |
7 changes: 7 additions & 0 deletions
7
...ecommendations/searchable-collections/REC_searchable-limit-default-maximum.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
[[rec_searchable_limit-default-maximum]] | ||
[width="90%",cols="2,6a"] | ||
|=== | ||
^|*Recommendation {counter:req-id}* |*/rec/searchable/limit-definition* | ||
^|A |The Implementation SHOULD advertise the default value for the `limit` parameter. | ||
^|B |The Implementation SHOULD advertise the maximum value for the `limit` parameter. | ||
|=== |
4 changes: 2 additions & 2 deletions
4
...le-collections/REC_rc-paged-response.adoc → ...ctions/REC_searchable-paged-response.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[[rec_collections_rc-paged-response]] | ||
[[rec_searchable_paged-response]] | ||
[width="90%",cols="2,6a"] | ||
|=== | ||
^|*Recommendation {counter:rec-id}* |*/rec/collections/rc-paged-response* | ||
^|*Recommendation {counter:rec-id}* |*/rec/searchable/paged-response* | ||
^|A|If the number of items in the `collections` element is less than the number available through the API, then the `numberMatched` and `numberReturned` properties SHOULD be included in the Collections response. | ||
|=== |
4 changes: 2 additions & 2 deletions
4
...able-collections/REC_rc-server-limit.adoc → ...lections/REC_searchable-server-limit.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
21 changes: 0 additions & 21 deletions
21
collections/requirements/searchable-collections/REQ_rc-limit-definition.adoc
This file was deleted.
Oops, something went wrong.
4 changes: 2 additions & 2 deletions
4
...e-collections/REQ_rc-bbox-definition.adoc → ...tions/REQ_searchable-bbox-definition.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...ble-collections/REQ_rc-bbox-response.adoc → ...ections/REQ_searchable-bbox-response.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 9 additions & 0 deletions
9
collections/requirements/searchable-collections/REQ_searchable-below-sd.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[[req_searchable-below-sd]] | ||
[width="90%",cols="2,6a"] | ||
|=== | ||
^|*Requirement {counter:req-id}* |*/req/searchable/below-sd* | ||
^|A|The Implementation SHALL support a `below-sd` parameter specified as numeric value for the `/collections` resource. | ||
^|B|The Implementation SHALL NOT include in the response collections for which the `minScaleDenominator` property (or the equivalent conversion for `minCellSize` assuming 0.28mm/cell) | ||
of the collection description is greater than the scale denominator specified in the `below-sd` parameter value. | ||
^|C|Collections with an unknown `minScaleDenominator` (or equivalent `minCellSize`) SHALL be included in the response. | ||
|=== |
20 changes: 4 additions & 16 deletions
20
...llections/REQ_rc-datetime-definition.adoc → ...s/REQ_searchable-datetime-definition.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...collections/REQ_rc-datetime-response.adoc → ...ons/REQ_searchable-datetime-response.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
[[req_searchable_rc-datetime-response]] | ||
[[req_searchable_datetime-response]] | ||
[width="90%",cols="2,6a"] | ||
|=== | ||
^|*Requirement {counter:req-id}* |*/req/searchable/rc-datetime-response* | ||
^|*Requirement {counter:req-id}* |*/req/searchable/datetime-response* | ||
^|A |If the `datetime` parameter is provided by the client and supported by the server, then only collections whose temporal extent intersects the interval or instant of the `datetime` parameter and collections that | ||
do not describe a temporal extent SHALL be part of the result set. | ||
|=== |
7 changes: 7 additions & 0 deletions
7
...ctions/requirements/searchable-collections/REQ_searchable-limit-definition.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
[[req_searchable_limit-definition]] | ||
[width="90%",cols="2,6a"] | ||
|=== | ||
^|*Requirement {counter:req-id}* |*/req/searchable/limit-definition* | ||
^|A |The Implementation SHALL support a `limit` parameter consisting of a positive integer greater or equal to 1. | ||
The default value for this parameter is up to the server. | ||
|=== |
5 changes: 3 additions & 2 deletions
5
...le-collections/REQ_rc-limit-response.adoc → ...ctions/REQ_searchable-limit-response.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,8 @@ | ||
[[req_searchable_rc-limit-response]] | ||
[[req_searchable-limit-response]] | ||
[width="90%",cols="2,6a"] | ||
|=== | ||
^|*Requirement {counter:req-id}* |*/req/searchable/rc-limit-response* | ||
^|*Requirement {counter:req-id}* |*/req/searchable/limit-response* | ||
^|A |If the `limit` parameter is provided by the client and supported by the server, then the response SHALL NOT contain more collections than specified by the `limit` parameter. | ||
^|B |If the API definition specifies a maximum value for the `limit` parameter, the response SHALL NOT contain more collections than this maximum value. | ||
^|C |If the value of the `limit` parameter is larger than the maximum value, this SHALL NOT result in an error (instead the server's maximum value for the parameter SHALL be used). | ||
|=== |
4 changes: 2 additions & 2 deletions
4
...s/searchable-collections/REQ_rc-next.adoc → ...able-collections/REQ_searchable-next.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...ble-collections/REQ_rc-numberMatched.adoc → ...ections/REQ_searchable-numberMatched.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
[[reqsearchable_rc-numberMatched]] | ||
[[reqsearchable_numberMatched]] | ||
[width="90%",cols="2,6a"] | ||
|=== | ||
^|*Requirement {counter:req-id}* |*/req/searchable/rc-numberMatched* | ||
^|*Requirement {counter:req-id}* |*/req/searchable/numberMatched* | ||
^|A |If a property `numberMatched` is included in the response, the value SHALL be identical to the number of hosted collections that meet the selection parameters provided by the client. | ||
^|B |A server MAY omit this information in a response, if the information about the number of matching resources is not known or difficult to compute. | ||
|=== |
4 changes: 2 additions & 2 deletions
4
...le-collections/REQ_rc-numberReturned.adoc → ...ctions/REQ_searchable-numberReturned.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
[[req_searchable_rc-numberReturned]] | ||
[[req_searchable-numberReturned]] | ||
[width="90%",cols="2,6a"] | ||
|=== | ||
^|*Requirement {counter:req-id}* |*/req/searchable/rc-numberReturned* | ||
^|*Requirement {counter:req-id}* |*/req/searchable/numberReturned* | ||
^|A |If a property `numberReturned` is included in the response, the value SHALL be identical to the number of items in the `collections` array in the `Collections` document. | ||
^|B |A server MAY omit this information in a response, if the information about the number of resources in the response is not known or difficult to compute. | ||
|=== |
20 changes: 3 additions & 17 deletions
20
...ents/searchable-collections/REQ_rc-q.adoc → ...rchable-collections/REQ_searchable-q.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
.../searchable-collections/REQ_rc-query.adoc → ...ble-collections/REQ_searchable-query.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters