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

API for OpenAPI tools #60

Open
karelhusa opened this issue Jul 14, 2022 · 1 comment
Open

API for OpenAPI tools #60

karelhusa opened this issue Jul 14, 2022 · 1 comment
Labels
data Issue relates to the tooling data collected from data sources enhancement New feature or request

Comments

@karelhusa
Copy link

User Story

As an architect, I would like to use API instead of HTML pages when I do research.
With queries, I would filter the tools according to my needs.
The API would provide a data source for content creators and other data users (the reason why we do APIs).

Detailed Requirement

Design and publish OAI Tooling API in OpenAPI (preferably) or GraphQL.

Public API would provide:
Filtering

  • categories
  • compliance with standards (OpenAPI 2.0, 3.0, 3.1)
  • full text

Detail of the tool

  • name
  • text description
  • list of functions
  • link to product home page, link to the documentation
  • compliance (yes, no, partial, unknown)
  • licensing (free, commercial)
  • code repository
  • created date
  • last update

Optionally administration API

  • creating new items
  • review new items/changes, etc.
@SensibleWood SensibleWood added enhancement New feature or request data Issue relates to the tooling data collected from data sources labels Jul 15, 2022
@rafalkrupinski
Copy link

This is a statically generated page. I'd rather suggest adding a JSON file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data Issue relates to the tooling data collected from data sources enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants