Clarify API version lifecycle

Open
#55 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi
Domain
api, documentation

Research direction

Compare the version shown in Swagger UI with the 2.0 reference in README.MD, then inspect the repository documentation around API versions. Done means the documentation clearly lists each available version, its status, and its end-of-life date, including the relationship between versions 2.0 and 3.0.

Written by the indexing model from the issue text.

Description

I just noted that the swagger ui points to version 3.0. Is this already in production? The README.MD refers to 2.0 only.

As a API consumer it would be very helpful to have an lifecycle statement which lists available versions with status and EOL date.

Thx for the great work!

Dominant language
Java
Stars
154
Forks
18
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from foojayio/discoapi

All issues in foojayio/discoapi

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.