Skip to content

Commit c95deba

Browse files
shjellvikshjellvik
authored
Refresh openapi specs (#46)
1 parent 4fad812 commit c95deba

12 files changed

Lines changed: 6344 additions & 18875 deletions

‎openapi_specs/CRS_Catalog.json‎

Lines changed: 0 additions & 5909 deletions
This file was deleted.

‎openapi_specs/CRS_Catalog.yaml‎

Lines changed: 382 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,382 @@
1+
# Copyright © Amazon
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http:#www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
swagger: '2.0'
16+
info:
17+
version: 2.0.0
18+
title: CRS Catalog Service API
19+
description: Coordinate Reference System (CRS) Catalog Service
20+
host: ROOT_URL
21+
x-google-allow: all
22+
tags:
23+
- name: Coordinate Transformations
24+
- name: Coordinate Reference Systems
25+
- name: Area of Use
26+
schemes:
27+
- https
28+
consumes:
29+
- application/json
30+
produces:
31+
- application/json
32+
paths:
33+
/coordinate-transformation:
34+
get:
35+
tags:
36+
- Coordinate Transformations
37+
parameters:
38+
- in: header
39+
name: data-partition-id
40+
type: string
41+
required: false
42+
- name: dataId
43+
in: query
44+
required: false
45+
type: string
46+
description: Searches on data.ID for CT records
47+
- name: recordId
48+
in: query
49+
required: false
50+
type: string
51+
description: Searches on id for CT records
52+
responses:
53+
'200':
54+
description: A successful response
55+
schema:
56+
$ref: '#/definitions/SearchResponse'
57+
post:
58+
tags:
59+
- Coordinate Transformations
60+
parameters:
61+
- in: header
62+
name: data-partition-id
63+
type: string
64+
required: false
65+
- in: body
66+
name: body
67+
schema:
68+
$ref: '#/definitions/CoordinateTransformationSearch'
69+
responses:
70+
'200':
71+
description: A successful response
72+
schema:
73+
$ref: '#/definitions/SearchResponse'
74+
75+
/coordinate-reference-system:
76+
get:
77+
tags:
78+
- Coordinate Reference Systems
79+
parameters:
80+
- in: header
81+
name: data-partition-id
82+
type: string
83+
required: false
84+
- name: dataId
85+
in: query
86+
required: false
87+
type: string
88+
description: Searches on data.ID for CRS records
89+
- name: recordId
90+
in: query
91+
required: false
92+
type: string
93+
description: Searches on id for CRS records
94+
responses:
95+
'200':
96+
description: A successful response
97+
schema:
98+
$ref: '#/definitions/SearchResponse'
99+
post:
100+
tags:
101+
- Coordinate Reference Systems
102+
parameters:
103+
- in: header
104+
name: data-partition-id
105+
type: string
106+
required: false
107+
- in: body
108+
name: body
109+
schema:
110+
$ref: '#/definitions/CoordinateReferenceSystemSearch'
111+
responses:
112+
'200':
113+
description: A successful response
114+
schema:
115+
$ref: '#/definitions/SearchResponse'
116+
117+
/points-in-aou:
118+
post:
119+
tags:
120+
- Area of Use
121+
parameters:
122+
- in: header
123+
name: data-partition-id
124+
type: string
125+
required: false
126+
- in: body
127+
name: body
128+
schema:
129+
$ref: '#/definitions/PointsInAOUSearch'
130+
responses:
131+
'200':
132+
description: A successful response
133+
schema:
134+
$ref: '#/definitions/PointsInAOUResponse'
135+
136+
/info:
137+
get:
138+
tags:
139+
- "Info"
140+
summary: "Version info"
141+
description: "For deployment available public `/info` endpoint, \
142+
\ which provides build and git related information."
143+
operationId: "Version info"
144+
produces:
145+
- "application/json"
146+
responses:
147+
200:
148+
description: "Version info."
149+
schema:
150+
$ref: "#/definitions/VersionInfo"
151+
definitions:
152+
PointsInAOUSearch:
153+
description: Body for checking points against Area of use
154+
properties:
155+
recordId:
156+
type: string
157+
description: Record of CRS or CT to check points against
158+
points:
159+
type: array
160+
description: List of points to check against CRS or CT bounding boxes
161+
items:
162+
$ref: '#/definitions/Point'
163+
PointsInAOUResponse:
164+
properties:
165+
bboxFailedPoint:
166+
type: array
167+
description: List of failed points, ones that aren't in bounding box
168+
items:
169+
$ref: '#/definitions/bboxFailedPoint'
170+
maxDistKmOutsideBBox:
171+
type: number
172+
description: Point distance with highest km outside bounding box
173+
bboxFailedPoint:
174+
description: A point that didn't land in the bounding box for area of use search
175+
properties:
176+
point:
177+
$ref: '#/definitions/Point'
178+
index:
179+
type: number
180+
description: A zero-based index of the point in the input "points" array
181+
approximateKmDistanceOutside:
182+
type: number
183+
description: Kilometers outside the record's bounding box
184+
Point:
185+
description: Lat, long point
186+
properties:
187+
latitude:
188+
type: number
189+
longitude:
190+
type: number
191+
CoordinateTransformationSearch:
192+
description: Body for searching on CTs
193+
properties:
194+
codeSpace:
195+
type: string
196+
description: Corresponds to CodeSpace field on CT records
197+
name:
198+
type: string
199+
description: Corresponds to Name field on CT records. All entities with name containing the search string will be returned. Wildcard is not supported.
200+
id:
201+
type: string
202+
description: Corresponds to ID field on CT records
203+
code:
204+
type: string
205+
description: Corresponds to Code field on CT records
206+
kind:
207+
type: string
208+
description: Corresponds to the Kind field on CT records. Default is to not return CT records with Kind "VerticalTransformation". Viable options include "Transformation", "ConcatenatedOperation", "VerticalTransformation", "ExcludeVertical" (default) and "All". "All" is a special value which indicates returning records of all kinds.
209+
sourceCRS:
210+
type: string
211+
description: Corresponds to SourceCRS.SourceCRSID (record id), e.g., "osdu:reference-data--CoordinateReferenceSystem:Geographic2D:EPSG::4198:". As SourceCRS and TargetCRS are interchangeable, it will also search TargetCRS.TargetCRSID
212+
targetCRS:
213+
type: string
214+
description: Corresponds to TargetCRS.TargetCRSID (record id), e.g., "osdu:reference-data--CoordinateReferenceSystem:Geographic2D:EPSG::4198:". As SourceCRS and TargetCRS are interchangeable, it will also search SourceCRS.SourceCRSID
215+
latitude:
216+
type: number
217+
description: Returns all entities for which the (Latitude, Longitude) is inside the Extent bounding box. Must also provide longitude.
218+
longitude:
219+
type: number
220+
description: See latitude
221+
includeDeprecated:
222+
type: boolean
223+
description: Whether to return deprecated records marked with InactiveIndicator=true. Default is false.
224+
offset:
225+
type: integer
226+
description: Corresponds to offset on search service
227+
limit:
228+
type: integer
229+
description: Corresponds to limit on search service. Default is to return all found entities.
230+
returnAllFields:
231+
type: boolean
232+
description: Whether to return all fields in the record. Default is false and only a subset is returned
233+
234+
CoordinateReferenceSystemSearch:
235+
description: Body for searching on CRSs
236+
properties:
237+
codeSpace:
238+
type: string
239+
description: Corresponds to CodeSpace field on CRS records
240+
name:
241+
type: string
242+
description: Corresponds to Name field on CRS records. All entities with name containing the search string will be returned. Wildcard is not supported.
243+
id:
244+
type: string
245+
description: Corresponds to ID field on CRS records
246+
code:
247+
type: string
248+
description: Corresponds to Code field on CRS records
249+
kind:
250+
type: string
251+
description: Corresponds to Kind field on CRS records
252+
baseCRS:
253+
$ref: "#/definitions/BaseCRS"
254+
datum:
255+
$ref: "#/definitions/Datum"
256+
extent:
257+
$ref: "#/definitions/Extent"
258+
coordinateReferenceSystemType:
259+
type: string
260+
description: Type of CRS, e.g., BoundCRS, ProjectedCRS, GeodeticCRS, VerticalCRS
261+
horizontalAxisUnitId:
262+
type: string
263+
description: Corresponds to CoordinateSystem.HorizontalAxisUnitID field on CRS records, e.g., "osdu:reference-data--UnitOfMeasure:dega:".
264+
verticalAxisUnitId:
265+
type: string
266+
description: Corresponds to CoordinateSystem.VerticalAxisUnitID field on CRS records
267+
returnBoundProjectedAndProjectedBasedOnWgs84:
268+
type: boolean
269+
description: Whether or not to only return bound projected type or projected type based on wgs84. If true, it only returns CRS 1. with Kind as "BoundProjected" or 2. with Kind as "projected" and BaseCRS.AuthorityCode.Code as 4326
270+
returnBoundGeographic2DAndWgs84:
271+
type: boolean
272+
description: Whether or not to only return bound geopraphic 2d type. If true, it only returns CRS 1. with Kind as "BoundGeographic2D" or 2. with Kind as "geographic 2D" and Code as 4326 and CodeSpace as "EPSG"
273+
latitude:
274+
type: number
275+
description: Latitude point for searching on CRS bounding box
276+
longitude:
277+
type: number
278+
description: Longitude point for searching on CRS bounding box
279+
includeDeprecated:
280+
type: boolean
281+
description:
282+
Whether to return deprecated records marked with InactiveIndicator=true. Default is false
283+
offset:
284+
type: integer
285+
description: Corresponds to offset on search service
286+
limit:
287+
type: integer
288+
description: Corresponds to limit on search service. Default is to return all found entities.
289+
returnAllFields:
290+
type: boolean
291+
description: Whether to return all fields in the record. Default is false and only a subset is returned
292+
293+
BaseCRS:
294+
properties:
295+
id:
296+
type: string
297+
description: Record Id of parent CRS
298+
name:
299+
type: string
300+
description: Name of parent CRS
301+
302+
Datum:
303+
properties:
304+
code:
305+
type: string
306+
description: Code of datum
307+
name:
308+
type: string
309+
description: Name of datum
310+
codeSpace:
311+
type: string
312+
description: Codespace of datum
313+
314+
Extent:
315+
properties:
316+
description:
317+
type: string
318+
description: Description of extent. Corresponds to PreferredUsage.Extent.Description in the record. All entities with PreferredUsage.Extent.Description containing the search string will be returned. Wildcard is not supported.
319+
320+
SearchResponse:
321+
description: Results for most V3 endpoints
322+
properties:
323+
searchResults:
324+
$ref: '#/definitions/QueryResponse'
325+
query:
326+
type: string
327+
description: Query string used against Search service
328+
329+
QueryResponse:
330+
description: Results from Search service
331+
properties:
332+
results:
333+
type: object
334+
description: Results like in Search service results
335+
aggregations:
336+
type: object
337+
description: Aggregations used like in Search service results
338+
totalCount:
339+
type: integer
340+
description: Total count of search results
341+
342+
VersionInfo:
343+
type: "object"
344+
properties:
345+
groupId:
346+
type: "string"
347+
description: "Maven artifact group ID."
348+
actifactId:
349+
type: "string"
350+
description: "Maven artifact ID."
351+
version:
352+
type: "string"
353+
description: "Maven artifact version"
354+
buildTime:
355+
type: "string"
356+
description: "Maven artifact build time"
357+
branch:
358+
type: "string"
359+
description: "Current git branch"
360+
commitId:
361+
type: "string"
362+
description: "Latest commit hash"
363+
commitMessage:
364+
type: "string"
365+
description: "Latest commit message"
366+
connectedOuterServices:
367+
type: "array"
368+
description: "Connected outer services information"
369+
items:
370+
$ref: "#/definitions/ConnectedOuterService"
371+
description: "Version info."
372+
373+
ConnectedOuterService:
374+
type: "object"
375+
properties:
376+
name:
377+
type: "string"
378+
description: "Connected outer service name."
379+
version:
380+
type: "string"
381+
description: "Connected outer service version."
382+
description: "Connected outer service information."

0 commit comments

Comments
 (0)