opengeospatial / ogcapi-connected-systems

Public Repository for the Connected Systems SWG
Other
8 stars 6 forks source link

Change API definition example from OpenAPI 3.1 to OpenAPI 3.0.3 #48

Open ghobona opened 7 months ago

ghobona commented 7 months ago

OGC API Standards are expected to target OpenAPI 3.0.

Part 1 of the OGC API - Connected Systems candidate Standard correctly mentions only OpenAPI 3.0.

https://docs.ogc.org/DRAFTS/23-001r0.html

However, the associated API definition yaml file appears to reference OpenAPI 3.1.

https://github.com/opengeospatial/ogcapi-connected-systems/blob/master/api/part1/openapi/openapi-connectedsystems-1.yaml

Please change the API definition example from OpenAPI 3.1 to OpenAPI 3.0.3.

alexrobin commented 7 months ago

We need to use OpenAPI 3.1 so we can import the SensorML schemas. The schema is large so I don't want to duplicate everything using OpenAPI schema flavor...

alexrobin commented 7 months ago

Features has duplicated the entire GeoJSON schema but I don't think this is a scalable approach. We should migrate to OpenAPI 3.1 instead. The tooling has been working fine for me

ghobona commented 2 months ago

@avillar has created a version of the OpenAPI definition document that conforms to OpenAPI 3.0.3.

https://gist.github.com/avillar/b1596e634b4f330234028cc08957a344

@alexrobin Could you please review the downcompiled yaml file and then place a copy of the file at https://github.com/opengeospatial/ogcapi-connected-systems/tree/master/api/part1/openapi ?

Please name the file ogcapi-connectedsystems-1.bundled.oas30.json

The word bundled in the filename means that all of the imported files have been resolved into a single bundle. A number of other OGC API SWGs use the same naming scheme.