Add `info.lifecycle` with maturity/lifecycle informations.
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
The proposal
A LifeCycle object to describe the API lifecycle, eg:
info:
lifecycle:
maturity: published # or deprecated, retired, ...
published_at: 2019-01-01
deprecated_at: 2022-01-01
retired_at: 2022-06-01
Data related to other version may be specified eg. via link relations
links:
- rel: prev
url: https://prev-oas-spec
- rel: next
url: https://next-oas-spec
Benefits
Automatic discovery of API status.
Considerations
- http://apisjson.org/ seems not maintained anymore
- we already have
deprecationinformations in operations - lifecycle could contain further informations related to eg. versioning (link to previous spec versions)
Related to
OAI/sig-lifecycle#8
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or implementation entry points are named. Start by reviewing the proposed LifeCycle shape, the 32-comment discussion, and the related OAI/sig-lifecycle#8 issue; completion would require an agreed design for maturity dates, version links, and interaction with existing operation deprecation information.
Written by the indexing model from the issue text.
Assessment
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100