directus / directus/openapi

Schema snapshot response format is missing data wrapper

Open Beginner friendly
#77 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
9
Forks
8
PR merge metrics
No merged PRs in 30d

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

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.