The openapi.yaml file contains several categories of data that rely on each other. Jumping between and maintaining these different sections can be unwieldy. Splitting the openapi documentation into multiple files could help organize the data, making it easier to grok and navigate. This is possible using "refs" to external files.
Acceptance criteria
[x] The following data are broken into their own files
[x] parameters
[x] schemas
[x] responses
[x] The open api documentation is still buildable into a single html file.
This may require bundling the files first with redocly bundle command
Note
Some examples from other sites have a file for each individual component and store them together in a folder. For example, a land_use.yaml file in a 'schemas' folder. This might be a good next step. But, I don't think it's strictly necessary for this iteration.
Description
The openapi.yaml file contains several categories of data that rely on each other. Jumping between and maintaining these different sections can be unwieldy. Splitting the openapi documentation into multiple files could help organize the data, making it easier to grok and navigate. This is possible using "refs" to external files.
Acceptance criteria
parametersschemasresponsesredocly bundlecommandNote Some examples from other sites have a file for each individual component and store them together in a folder. For example, a
land_use.yamlfile in a 'schemas' folder. This might be a good next step. But, I don't think it's strictly necessary for this iteration.