Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add type def to docs for column endpoints #596

Merged
merged 2 commits into from
Aug 10, 2023

Conversation

owaisahmad-dev
Copy link
Contributor

@owaisahmad-dev owaisahmad-dev commented Jul 20, 2023

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:

- GET /columns
- POST /columns
- GET /columns/{tableId}{ordinalPosition}
- PATCH /columns/{id}
- DELETE /columns/{id}

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.

@owaisahmad-dev owaisahmad-dev requested review from a team as code owners July 20, 2023 11:50
Copy link
Member

@soedirgo soedirgo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay - and thanks for the PR!

@soedirgo soedirgo merged commit 7e7d114 into supabase:master Aug 10, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants