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: render mgmt api body params #26319

Merged
merged 22 commits into from
May 21, 2024
Merged

feat: render mgmt api body params #26319

merged 22 commits into from
May 21, 2024

Conversation

phamhieu
Copy link
Member

@phamhieu phamhieu commented May 15, 2024

I have read the CONTRIBUTING.md file.

YES

What kind of change does this PR introduce?

Mgmt api docs doesn't show body params

What is the current behavior?

Body params is empty

What is the new behavior?

Body params will be rendered

  • Render body params
  • Support content type selection
  • Support body object, array of object and array of primitive type
  • Render accepted enum values
  • Render body param with object type
  • Improve response with sample and schema
  • Update mgmt api spec to latest

Additional context

Screenshot 2024-05-15 at 8 43 34 AM Screenshot 2024-05-15 at 8 43 22 AM Screenshot 2024-05-15 at 8 45 29 AM Screenshot 2024-05-16 at 10 25 29 AM Screenshot 2024-05-16 at 10 26 57 AM

Copy link

vercel bot commented May 15, 2024

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

Name Status Preview Comments Updated (UTC)
design-system ❌ Failed (Inspect) May 21, 2024 6:12am
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 21, 2024 6:12am
studio-staging ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 21, 2024 6:12am
zone-www-dot-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 21, 2024 6:12am
3 Ignored Deployments
Name Status Preview Comments Updated (UTC)
database-new ⬜️ Ignored (Inspect) May 21, 2024 6:12am
studio ⬜️ Ignored (Inspect) Visit Preview May 21, 2024 6:12am
studio-self-hosted ⬜️ Ignored (Inspect) Visit Preview May 21, 2024 6:12am

Copy link

supabase bot commented May 15, 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 ↗︎.

</span>
<span className="text-foreground-muted text-xs">{props.type ?? 'no type'}</span>
</span>}
{!props.isEnum && <span className="text-foreground-muted text-xs">{props.type ?? 'no type'}</span>}
Copy link
Member Author

Choose a reason for hiding this comment

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

I have to add a new prop to prevent require and type fields rendering. It looks weir for accepted enum values
Screenshot 2024-05-15 at 9 49 35 AM

apps/docs/components/ApiSchema.tsx Show resolved Hide resolved
apps/docs/components/ApiSchemaOption.tsx Outdated Show resolved Hide resolved
apps/docs/components/ApiSchemaOption.tsx Outdated Show resolved Hide resolved
apps/docs/components/Options.tsx Outdated Show resolved Hide resolved
apps/docs/components/reference/ApiOperationSection.tsx Outdated Show resolved Hide resolved
phamhieu and others added 2 commits May 21, 2024 12:49
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
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.

None yet

3 participants