feat: add type def to docs for column endpoints #596
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
This PR adds types definitions to the Open API spec for the column CRUD endpoints.
What is the current behavior?
Currently, the Open API spec doesn't contain the expected types for payloads and responses for column endpoints.
What is the new behavior?
npm run docs: export
now creates openapi.json which contains all type definitions for payloads and responses of column endpoints.Impacted endpoints:
Additional context
I was using these endpoints and wanted to generate a client using
openapi-generator-cli
and found that types are not hooked up for these endpoints. I took inspiration from the table endpoints and hooked it up like that. I am a newbie in open-source dev and would love any sort of feedback to improve.