Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Register a tool in the repository at a given version of OpenAPI #6

Open
SensibleWood opened this issue Feb 15, 2022 · 1 comment
Open
Assignees
Labels
enhancement New feature or request

Comments

@SensibleWood
Copy link
Collaborator

SensibleWood commented Feb 15, 2022

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.

@SensibleWood SensibleWood added the enhancement New feature or request label Feb 15, 2022
@SensibleWood SensibleWood self-assigned this Mar 30, 2022
@SensibleWood
Copy link
Collaborator Author

Prior to an approach being devised for #19 we'll focus on the existing openapi3 tag and add openapi31 to the build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant