API for OpenAPI tools
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 177
- Forks
- 87
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
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.
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.
Research direction
The issue names no files, tests, or entry points. Start by surveying the JavaScript repository and how its current HTML pages and tool data are produced, then define the API contract and filtering fields. Done means a published OpenAPI or GraphQL API covering the requested tool details and filters.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- graphql, javascript, openapi
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100