Skip to content

Define what the OpenAPI info.version means and add a changelog #511

Open

Description

@pdettori

Follow-up from the change policy (docs/reference/change-policy.md, PR #506).

Both docs/api/openapi.yaml and docs/api/harness-openapi.yaml say version: 1.0.0 with no stated meaning.

Decision: it is the version of the /v1 contract. Bump the minor for additive changes; bump the major only together with a /v2. Add a short changelog to each file (or a linked changelog) and mention the rule in the policy page.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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