SEARCH /api/crs/catalog/v3/coordinate-reference-system
@spencer the CRS SEARCH endpoint has various things to work through based on our tests of use cases. Issue #39 (closed) describes the PASS/FAIL of use cases (but not all are yet attempted partly due to not understanding some things).
This issue is to highlight immediately found specific issues.
-
codeSpace appears to be mandatory in the request. It should not be. (This does not appear to be the case for the SEARCH CT endpoint; but if it is then that one should be fixed the same). The reason it should not be is that we want CRS regardless whether BP or SHELL or EPSG defined it (even though in the OSDU catalog all are EPSG; that won't be the case for Operators with custom CRSs). -
Please provide an example in the comments how we can find all CRSs of kind projected and/or BoundProjected that have a horizontal unit "meter". -
The documentation indicated that Extent.name can be searched. -
- (1) The property that should be searched is the preferredUsage.extent.description; not the name. Please change this to searching the extent description, and the preferred Usage (the help does not specify but note that an entity can have 2 or more Usages in an array, but only a single preferredUsage which is used in OSDU. It also has a Name and a Description. The description contains more detail, e.g., a list of counties, where the name is short and cryptic. Hence we need to search the description.
-
- (2) Please provide an example request body in the comments how to do a case insensitive wildcard search for "azori" in the preferredUsage.extent.description field - this should return some CRSs in Texas (Brazoria county).
-
The response does not provide enough properties back. This probably should be moved to its own issue - but I wanted to mention it as an issue here. The original spec word document details which properties should be returned from search. -
- We agreed for now return all to deploy in M12; then for M13 we would discuss to have a flag “all (default) or preselected subset of properties
-
Agreed to add a query parameter for HorizontalAxisUnitID & VerticalAxisUnitID. -
Agreed to show how to filter BoundProjected and Projected with BaseCRS=WGS 84. Sent separate email explaining this. -
openapi documentation incorrectly refers to CT; should say CRS.
For example it says "codeSpace: Corresponds to CodeSpace field on CT records". This should obviously be CRS and was copied/pasted from the CT document (multiple places; I noticed it for codespace, code, latitude, longitude).
======================================================================
Example 1 showing codeSpace appears required: Request:
Request
{
"latitude": 30.0,
"longitude": -90
}
Response
Some error message that codeSpace is missing from the request.
Example 2 showing a response that seems to indicate codeSpace is set to NULL:
Request
{
"id": "osdu:reference-data--CoordinateReferenceSystem:Geographic2D:EPSG::4158"
}
Response
{
"searchResults": {
"results": [],
"aggregations": [],
"totalCount": 0
},
"query": "(data.CodeSpace: null) AND (data.ID: \"osdu:reference-data--CoordinateReferenceSystem:Geographic2D:EPSG::4158\"*)"
}