opengeospatial / ogcapi-connected-systems

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

Make bundle file available to reviewers for CSAPI Part 2 #79

Open Sam-Bolling opened 4 weeks ago

Sam-Bolling commented 4 weeks ago

This public comment is respectfully submitted by the Web Service Technical Panel (WSTP) of the Defence Geospatial Information Working Group (DGIWG). This comment addresses an identified issue where there is no completely self-contained OAS definition yaml file, also known as the “bundle file,” available for the OGC API – Connected Systems – Part 2: Dynamic Data. Most code generation / automation tools expect a single schema file. The lack of this resource during the review period introduces a significant challenge for implementers and reviewers to evaluate the standard.

Request: For the purposes of reviewing, please provide and declare a completely self-contained OAS definition yaml file for OGC API – Connected Systems – Part 2: Dynamic Data, in the SWG-decided version of OAS. It is recommended that the tool, Swagger CLI, used for creating OGC API – Maps and OGC API – Tiles bundle files is reused for this effort. A reference of this process is described at https://github.com/opengeospatial/ogcapi-maps/tree/master/openapi

alexrobin commented 4 weeks ago

We'll work on making the bundle file available but note that the API documentation is also available online for review purposes.

alexrobin commented 3 weeks ago

Discussed during 10/31 telecon:

@SpeckiJ will try to generate an OpenAPI 3.1 bundle with a tool he developped.

Or try bundling with https://redocly.com/redocly-cli.