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

Add support for explode query params and example generation #1078

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

blindaa121
Copy link
Collaborator

Description

This PR consists of adding support for explode and correct example generation for array query parameters.

Motivation and Context

See #1024 for context

How Has This Been Tested?

Tested with OpenAPI example spec provided in #1024.

Screenshots (if appropriate)

Screenshot 2025-01-30 at 1 57 21 PM

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

@blindaa121 blindaa121 requested a review from sserrata January 30, 2025 21:58
@blindaa121 blindaa121 self-assigned this Jan 30, 2025
Copy link

Size Change: 0 B

Total Size: 2.07 MB

ℹ️ View Unchanged
Filename Size
demo/.docusaurus/codeTranslations.json 2 B
demo/.docusaurus/docusaurus.config.mjs 13.9 kB
demo/.docusaurus/globalData.json 39 kB
demo/.docusaurus/i18n.json 267 B
demo/.docusaurus/registry.js 57.5 kB
demo/.docusaurus/routes.js 53.1 kB
demo/.docusaurus/routesChunkNames.json 22 kB
demo/.docusaurus/site-metadata.json 1.35 kB
demo/build/assets/css/styles.********.css 146 kB
demo/build/assets/js/main.********.js 735 kB
demo/build/assets/js/runtime~main.********.js 15.3 kB
demo/build/index.html 91.1 kB
demo/build/petstore/add-pet/index.html 27.5 kB
demo/build/petstore/create-user/index.html 21.6 kB
demo/build/petstore/create-users-with-array-input/index.html 21.6 kB
demo/build/petstore/create-users-with-list-input/index.html 21.6 kB
demo/build/petstore/delete-order/index.html 21.6 kB
demo/build/petstore/delete-pet/index.html 21.7 kB
demo/build/petstore/delete-user/index.html 21.9 kB
demo/build/petstore/find-pets-by-status/index.html 22.3 kB
demo/build/petstore/find-pets-by-tags/index.html 23 kB
demo/build/petstore/get-inventory/index.html 20.9 kB
demo/build/petstore/get-order-by-id/index.html 21.9 kB
demo/build/petstore/get-pet-by-id/index.html 22.5 kB
demo/build/petstore/get-user-by-name/index.html 22 kB
demo/build/petstore/login-user/index.html 22.5 kB
demo/build/petstore/logout-user/index.html 21.3 kB
demo/build/petstore/new-pet/index.html 21.9 kB
demo/build/petstore/pet/index.html 23.6 kB
demo/build/petstore/place-order/index.html 21.1 kB
demo/build/petstore/schemas/apiresponse/index.html 22.9 kB
demo/build/petstore/schemas/cat/index.html 36.8 kB
demo/build/petstore/schemas/category/index.html 24 kB
demo/build/petstore/schemas/dog/index.html 37.2 kB
demo/build/petstore/schemas/honeybee/index.html 37.3 kB
demo/build/petstore/schemas/id/index.html 21 kB
demo/build/petstore/schemas/order/index.html 25.1 kB
demo/build/petstore/schemas/pet/index.html 36.7 kB
demo/build/petstore/schemas/tag/index.html 22.4 kB
demo/build/petstore/schemas/user/index.html 44.9 kB
demo/build/petstore/store/index.html 21.6 kB
demo/build/petstore/subscribe-to-the-store-events/index.html 27.9 kB
demo/build/petstore/swagger-petstore-yaml/index.html 28 kB
demo/build/petstore/update-pet-with-form/index.html 21.8 kB
demo/build/petstore/update-pet/index.html 22.3 kB
demo/build/petstore/update-user/index.html 21.9 kB
demo/build/petstore/upload-file/index.html 21.7 kB
demo/build/petstore/user/index.html 22.5 kB

compressed-size-action

Copy link

Visit the preview URL for this PR (updated for commit be0e76f):

https://docusaurus-openapi-36b86--pr1078-tm9k8x09.web.app

(expires Sat, 01 Mar 2025 22:02:54 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: bf293780ee827f578864d92193b8c2866acd459f

@sserrata
Copy link
Member

Thanks Bryan, is the plan to, eventually, add support for the other style/parameters as defined here?

@blindaa121
Copy link
Collaborator Author

blindaa121 commented Feb 1, 2025

Hi @sserrata, we should definitely aim to cover all parameter types and serializing combinations. We can look further into supporting all combinations in a separate PR?

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