Sprint Goal #1 Feedback about using the OGC API - Connected Systems Parts 1& 2 YAML files

[Sam-Bolling]

CSAPI Sprint Goal #1 for OGC Code Sprint 26:
Confirm that the OpenAPI bundle definition YAML files for OGC CSAPI Parts 1 & 2 work as intended and can be used to autogenerate useful code without issues

Please post here any and all feedback you have relating to the CSAPI parts 1 & 2 yaml files. Opinions, testimonials, experiences, complaints, concerns, issues, challenges, recommendations and ideas of all kinds are welcome.

[EricLo-417]

The redoc examples seem complete and working. However, when I tried to download the openAPI yaml file for code generation I ran into some problems.

• The linked yaml file in redoc does not work without downloading other files. Not nearly as simple as OGC Features Part 1-3's one bundled file
• I downloaded from the link schema registry: https://schemas.opengis.net/ogcapi/connected-systems/
  • Noticed that these references files outside of connected-systems so i downloaded even more files, the whole registry: http://schemas.opengis.net/SCHEMAS_OPENGIS_NET.zip
  • This is where the first problem started. schemas/sensormlDefs is looking for sensorml but the folder at the root is called "sensorML"
  • Then it appears sensorML/common (root from the whole registry) is missing some files (instantForNow and instantForPeriod)
• After trying to fiddle with everything I noticed that the github contains different openAPI files and those appear to work. Ran into one duplicate issue but nothing broke.

Overall, It seems there is some disconnect between github and schemas.opengis. I assume the GitHub version is the most up to date and maybe the files should be consolidated into one place and ideally have bundle provided (much easier for quick viewing and for code generation as you only need to add one file not a whole file structure)

[SpeckiJ]

ideally have bundle provided

we have a bundles available, but we are currently pretty bad at marketing those. They are automatically build when a new tag is pushed to the repo and then released here: https://github.com/opengeospatial/ogcapi-connected-systems/releases/

I have just pushed a new tag based on the current master, so the bundles should regenerate right now.

TODO: we whould probably link to them more prominently than in old (now closed) issues. (opengeospatial/ogcapi-connected-systems#137)

[SpeckiJ]

This is where the first problem started. schemas/sensormlDefs is looking for sensorml but the folder at the root is called "sensorML"

This is a general issue with the repository structure, there are so many relative imports mixed with absolute ones, mixed with local ones, mixed with ones from "bundler" classes that sometimes get optimized out by tools that it gets really complicated.

This causes huge troubles as can be seen here: https://github.com/52North/connected-systems-pygeoapi/blob/3a20a04d932aa3e2b00dfcb8bf09093e5bfc89e8/tools/bundler/bundler.js#L64