Skip to content

No way to distinguish spec versions using the spec alone #46

@SinisterRectus

Description

@SinisterRectus

This is perhaps two different issues in one.

The info in openapi.json is identical to the info in openapi_preview.json, providing no way to programmatically distinguish specs by anything other than filename. More specifically, the two current specs are both titled and described as "Preview" while only one has a _preview suffix in its filename.

Additionally, the version field is used incorrectly.

From https://spec.openapis.org/oas/v3.1.0.html#info-object:

REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).

From https://spec.openapis.org/oas/v3.1.1.html#info-object (latest version):

REQUIRED. The version of the OpenAPI Document (which is distinct from the OpenAPI Specification version or the version of the API being described or the version of the OpenAPI Description).

Because version is set to the API version (10), the only way to distinguish between document versions is by git commit hash.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions