Skip to content
This repository was archived by the owner on Apr 10, 2024. It is now read-only.

Automated swagger documentation #35

Open
2 tasks
MakMuftic opened this issue Feb 28, 2023 · 0 comments
Open
2 tasks

Automated swagger documentation #35

MakMuftic opened this issue Feb 28, 2023 · 0 comments

Comments

@MakMuftic
Copy link
Contributor

The Swagger API documentation is currently not automatically updated upon new releases. This results in the link in the README file pointing to v1.0.0 of the API, which is hardcoded. Even if we change the URL to point to the latest version, the Swagger docs will still show v1.0.0 as it is the last released version of swagger docs.

Implementation details

To resolve this issue, we should automate the release of new versions of the Swagger docs using a GitHub action. This will ensure that the latest version of the documentation is always available and up to date.

Acceptance Criteria

  • The link inside the README file should point to the latest version of the Swagger API documentation.
  • A GitHub action should be created to release new Swagger docs versions automatically.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants