Skip to content

Version 0.4

Choose a tag to compare

View all tags
@leonhard-s leonhard-s released this 24 Jun 16:52
· 45 commits to main since this release
v0.4
6fe1cc7

Full rewrite of the API specification for OpenAPI 3.1.

Changes

  • Rewrote endpoint descriptions
  • Added descriptions for all fields on all collections
  • Added parameter documentation for query commands (for brevity, these are only listed for the generic endpoints, not the collection-specific overrides)
  • API specification was broken up into multiple files. A monolithic JSON document can be found in the generated/ directory
  • Moved top-level entry point, schemas, path content, and parameter definitions to YAML for readability
  • Examples have been moved to the examples/ directory and left in JSON format. This improves testability, but also means that individual payload schemas no longer include the top level {collection}_list key.

Known Issues

  • The vendor extensions x-cast-to and x-reference-to are a preview and may change in the future
  • The monolithic JSON spec hosted in the generated/ directory is tentative and may be renamed or otherwise changed
Assets 2
Loading