Schema snapshot response format is missing data wrapper
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 85/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- openapi
- Domain
- api, documentation
Research direction
Open openapi/paths/schema/snapshot/schemaSnapshot.yaml at the referenced response definition and compare it with other data endpoints that use a data wrapper. Update the schema snapshot response description to show the wrapper, then verify the OpenAPI document remains valid and the response shape matches the endpoint.
Written by the indexing model from the issue text.
Description
The schema snapshot endpoint returns the schema wrapped in a data property, consistent with most other data endpoints. However, the OpenAPI specification currently describes the schema as being returned at the top level and does not reflect this data wrapper.
https://github.com/directus/openapi/blob/main/openapi/paths/schema/snapshot/schemaSnapshot.yaml#L14
- Dominant language
- TypeScript
- Stars
- 9
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
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 82/100
-
Id is not requiredOpen
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Collection endpoints need more examplesMay be free again @hola-soy-milk claimed this 544 days ago, and no pull request is open. Open
-
Collection endpoints have incorrect schemaMay be free again @hola-soy-milk claimed this 544 days ago, and no pull request is open. Open
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
All issues in directus/openapi
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
openedx/frontend-app-authoring#3274 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
area/documentation status/need-triage
Difficulty 1/5 Under an hour Newbie friendliness 95/100
google-gemini/gemini-cli#29548 ·
Maintainers usually reply within 1 day
-
sdk-typescript vector-store
Difficulty 2/5 Half a day Newbie friendliness 82/100
mem0ai/mem0#7495 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day