openmobilityfoundation / openmobilityfoundation/cds-openapi
Implement 501 status code
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 7
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
From @michael-danko-passport
I have been looking for any documentation around the standard API responses and relevant status codes. I know the spec calls out a 501 - Not Implemented for some APIs but if there's some detailed documentation about this I may have overlooked, it should not be hard to also include within the OpenAPI spec. As a result of not finding this documentation, all of the API responses are a work in progress. We can easily apply them to each endpoint if they're structured similarly since these would be shared models.
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
Start by locating the OpenAPI schema, shared response models, and endpoint definitions referenced by the issue. Review how existing API responses are represented, then confirm that the 501 response is documented consistently for the applicable endpoints and reflected in the OpenAPI spec.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 32/100