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

refactor(docs): convert management api reference to app router #29146

Merged
merged 4 commits into from
Sep 11, 2024

Conversation

charislam
Copy link
Contributor

No description provided.

In preparation for App Router migration of Management API reference,
preprocess the Management API spec (both OpenAPI spec and common
sections), and write the processed data to file, in the style of the
other pregenerated reference data.

Details:

- Split reference section generation into separate functions for SDK, CLI, and API
- Add new function to generate API reference sections from OpenAPI spec
- Introduce mapEndpointsById function to create a map of API endpoints
- Update run function to execute all reference generation tasks in parallel
- Import necessary new dependencies and types
Copy link

vercel bot commented Sep 6, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 10, 2024 11:08pm
5 Skipped Deployments
Name Status Preview Comments Updated (UTC)
design-system ⬜️ Ignored (Inspect) Visit Preview Sep 10, 2024 11:08pm
studio ⬜️ Ignored (Inspect) Visit Preview Sep 10, 2024 11:08pm
studio-self-hosted ⬜️ Ignored (Inspect) Visit Preview Sep 10, 2024 11:08pm
studio-staging ⬜️ Skipped (Inspect) Sep 10, 2024 11:08pm
zone-www-dot-com ⬜️ Skipped (Inspect) Sep 10, 2024 11:08pm

Copy link

supabase bot commented Sep 6, 2024

No changes detected in supabase directory.
This pull request has been ignored for the connected project xguihxuzqibwxjnimxev due to its connection settings.
Go to Project Integrations Settings ↗︎ in order to change this behavior.


Branching Preview Branches by Supabase.
Learn more about Supabase for Git ↗︎.

@vercel vercel bot temporarily deployed to Preview – studio-staging September 9, 2024 22:18 Inactive
@vercel vercel bot temporarily deployed to Preview – zone-www-dot-com September 9, 2024 22:18 Inactive
@charislam charislam changed the title chore(docs): preprocess management api specs refactor(docs): convert management api reference to app router Sep 10, 2024
@vercel vercel bot temporarily deployed to Preview – zone-www-dot-com September 10, 2024 21:56 Inactive
@vercel vercel bot temporarily deployed to Preview – studio-staging September 10, 2024 21:56 Inactive
@vercel vercel bot temporarily deployed to Preview – studio-staging September 10, 2024 22:04 Inactive
@vercel vercel bot temporarily deployed to Preview – zone-www-dot-com September 10, 2024 22:04 Inactive
@vercel vercel bot temporarily deployed to Preview – studio-staging September 10, 2024 23:02 Inactive
@vercel vercel bot temporarily deployed to Preview – zone-www-dot-com September 10, 2024 23:02 Inactive
@charislam charislam marked this pull request as ready for review September 10, 2024 23:02
@charislam charislam merged commit 33ede6f into master Sep 11, 2024
14 checks passed
@charislam charislam deleted the refactor/docs-api-app-router branch September 11, 2024 17:53
laktek pushed a commit that referenced this pull request Sep 12, 2024
* chore(docs): preprocess management api specs

In preparation for App Router migration of Management API reference,
preprocess the Management API spec (both OpenAPI spec and common
sections), and write the processed data to file, in the style of the
other pregenerated reference data.

Details:

- Split reference section generation into separate functions for SDK, CLI, and API
- Add new function to generate API reference sections from OpenAPI spec
- Introduce mapEndpointsById function to create a map of API endpoints
- Update run function to execute all reference generation tasks in parallel
- Import necessary new dependencies and types

* refactor(docs): migrate management api reference to app router

* fix(docs): statically build management api reference page

* fix(docs): minor styling issues
encima pushed a commit that referenced this pull request Nov 19, 2024
* chore(docs): preprocess management api specs

In preparation for App Router migration of Management API reference,
preprocess the Management API spec (both OpenAPI spec and common
sections), and write the processed data to file, in the style of the
other pregenerated reference data.

Details:

- Split reference section generation into separate functions for SDK, CLI, and API
- Add new function to generate API reference sections from OpenAPI spec
- Introduce mapEndpointsById function to create a map of API endpoints
- Update run function to execute all reference generation tasks in parallel
- Import necessary new dependencies and types

* refactor(docs): migrate management api reference to app router

* fix(docs): statically build management api reference page

* fix(docs): minor styling issues
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