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(plugins): Show multipart/form-data example and schema #10166

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

BreakBB
Copy link

@BreakBB BreakBB commented Oct 11, 2024

Description

Request objects for multipart/form-data current don't show the example structure or schema, as application/json do. This PR reuses <ModelExample /> to also show example data for multipart/form-data. Also I enabled prettier with the projects settings, so some spacing inconsistencies are fixed as well.

Motivation and Context

Fixes #4581
Fixes #5169
Fixes #9756

How Has This Been Tested?

I used npm run dev and an oas3 file with multipart/form-data.

Screenshots (if appropriate):

Before
image

Example object
image

Partial schema
image

Unchanged Try It Out
image

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests 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
1 participant