Register a tool in the repository at a given version of OpenAPI
@SensibleWood is already working on this.
Since Mar 30, 2022.
- Dominant language
- JavaScript
- Stars
- 177
- Forks
- 87
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
User Story
As a tooling maker I want to register my tool's support for a given version of OpenAPI.
Detailed Requirement
The library gulpfile.js/lib/processors/awesome-openapi3-processor.js implements the method APIs.guru developed for collecting tooling through GitHub tags. This mechanism has legs as it is:
- Sustainable.
- Self-supporting.
- Extensible.
Proposal is to extend this so tooling makers can attest to a given version. We can dedup across versions in the build process i.e. it may see a repo tagged several times, but the metadata will only be pulled once.
Proposed values (for discussion):
- swagger.
- openapi2.
- openapi3 (currently supported tag).
- openapi30.
- openapi31.
This should allow the publication/ingestion mechanism to remain fairly straightforward and automated. The approach of course needs to be socialised with the community in an effort to get traction on tagging across repositories and repository providers.
Contributor guide
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.
Assessment
This issue has not been assessed yet.