Skip to content

API versioning via GitHub releases/tags #690

@Neurone

Description

@Neurone

Currently there's no way I can refer to a specific version of the API specifications.

This is an issue for both services, which cannot advertise the supported API specifications, and clients, who don't know if they are following the latest version because they don't know when things change. For example, see #639.

One solution would be to introduce a simple semantic versioning system for the API specs.

Tagging those versions as releases/tags on the GitHub repository would also improve quality of life, helping with automation and integration.

Note: The current tags seem to me to be more related to the development of possible future v1 specs than to real tags that developers can reference in their applications.

Note 2: There's another open issue about a similar topic (#408), but I think a simple tag/release approach would be an easy first step. After that, we can consider the possibility of introducing a more complex, granular versioning system at the API level and not just the repository level.

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