Add Body & Response Examples
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- openapi, typescript
- Domain
- api, documentation
Research direction
Start by reviewing the current OpenAPI definitions for the Items and other key endpoints, then compare them with the older API docs. Define which simple and relational body and response examples, and which use cases, are in scope; done means the selected endpoints expose useful examples.
Written by the indexing model from the issue text.
Description
Missing body and/or response examples on many of the key endpoints.
E.g. Items:
- missing body payload examples for simple and relational payloads
- missing response examples for simple and relational responses
Understanding that the dynamic and agnostic nature of Directus makes this difficult, it is still extremely helpful to see the structure of the body and responses via an example.
Perhaps 1 or more example use cases could be used to demonstrate the usage of the endpoints:
- simple CMS webpage
- simple Product Management
- could align with templates available on cloud?
- if more than one use case option, include a way to choose the example
Just some ideas. Mostly need examples similar to the older API docs.
- Dominant language
- TypeScript
- Stars
- 9
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
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.
More from directus/openapi
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
Id is not required Open
Difficulty 3/5 1-2 days Newbie friendliness 35/100
All issues in directus/openapi
Similar issues
-
Browser Waiting for: Product Owner
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
getsentry/sentry-javascript#24577 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
agilepathway/label-checker#640 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
copse-dev/agent-pane#2953 ·
-
agentic-workflows
Difficulty 1/5 Under an hour Newbie friendliness 85/100
githubnext/rig#534 ·
-
automation missing-model model-sync provider:pioneer
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
anomalyco/models.dev#7701 ·