Add an OpenAPI (Swagger) schema to the API
Open
Nobody has claimed this yet.
project:cape
- Dominant language
- HTML
- Stars
- 12
- Forks
- 2
- Avg merge
- 13d 3h
- Merged PRs (30d)
- 1
Description
Should be possible via the Django REST Framework we’re using to generate the API: https://www.django-rest-framework.org/api-guide/schemas/
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
Start with the Django REST Framework schemas guide linked in the issue, then inspect the repository's API entry points and configuration to see how the API is exposed. Done means the API has an accessible OpenAPI (Swagger) schema that describes its endpoints and can be generated through the existing Django REST Framework setup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, openapi
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100