Paweł Gronowski
9e5299c63e
Add a Go converter in a separate tooling module and reintroduce swagger.yaml as generated Swagger 2.0 output. Preserve schema property order, examples, and generator extensions, and reject unsupported constructs. Use the union of response media types for Swagger's operation-wide produces lists. Leave historical versioned specifications and generated Go models unchanged. Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
1.3 KiB
API Documentation
This directory contains versioned documents for each version of the API specification supported by this module. While this module provides support for older API versions, support should be considered "best-effort", especially for very old versions. Users are recommended to use the latest API versions, and only rely on older API versions for compatibility with older clients.
Newer API versions tend to be backward-compatible with older versions, with some exceptions where features were deprecated. For an overview of changes for each version, refer to CHANGELOG.md.
The latest specification is openapi.yaml, using OpenAPI 3.2.0. It may include unreleased changes. We still generate Swagger 2.0 for existing tooling, including Go model generation. See the module README for how to edit and validate the specification.
For API version v1.24, documentation is only available in markdown format.
Existing v*.yaml files stay in Swagger (OpenAPI) v2.0 format.
These files are used to generate the published API docs.
Report differences between the specification and implementation in an issue or pull request.