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: extend endpoint overrides for openapi codegen #4305

Conversation

sebws
Copy link
Contributor

@sebws sebws commented Mar 26, 2024

Add an option to filter parameters into endpoint overrides for RTK Query codegen for OpenApi schemas.

Both the path parameter and the body parameter aren't included in this, but could possibly be if it is thought that that would be helpful. I wasn't sure they would need to be filtered since they're less likely than other locations to be auto-added by a middleware.

This means it can filter out from the query, header, or cookie as seen in "Parameter Locations" in the OpenAPI spec

It only runs on the first (by order of endpointOverrides array) filter. This was the existing behaviour for query type, and makes enough sense.

Inspired by my issue #4285 and another relevant issue #3006

Copy link

codesandbox bot commented Mar 26, 2024

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

@sebws sebws force-pushed the feat/openapi-codegen-override-endpoints-filter-params branch from fdb9e20 to d0d0db1 Compare March 26, 2024 13:08
Copy link

netlify bot commented Mar 26, 2024

Deploy Preview for redux-starter-kit-docs ready!

Name Link
🔨 Latest commit fdb9e20
🔍 Latest deploy log https://app.netlify.com/sites/redux-starter-kit-docs/deploys/6602c8a35bacb00008bc4e2c
😎 Deploy Preview https://deploy-preview-4305--redux-starter-kit-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codesandbox-ci bot commented Mar 26, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 3585e82:

Sandbox Source
@examples-query-react/basic Configuration
@examples-query-react/advanced Configuration
@examples-action-listener/counter Configuration
rtk-esm-cra Configuration

Copy link

netlify bot commented Mar 26, 2024

Deploy Preview for redux-starter-kit-docs ready!

Name Link
🔨 Latest commit 3585e82
🔍 Latest deploy log https://app.netlify.com/sites/redux-starter-kit-docs/deploys/66d237683895230008822805
😎 Deploy Preview https://deploy-preview-4305--redux-starter-kit-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sebws sebws force-pushed the feat/openapi-codegen-override-endpoints-filter-params branch from d0d0db1 to afd882a Compare March 28, 2024 04:49
@sebws
Copy link
Contributor Author

sebws commented Jun 13, 2024

hi there, any chance someone could take a look at this?

@markerikson markerikson force-pushed the feat/openapi-codegen-override-endpoints-filter-params branch from afd882a to 1f6c72e Compare August 30, 2024 21:09
@markerikson markerikson merged commit 8b417da into reduxjs:master Aug 30, 2024
16 checks passed
@markerikson
Copy link
Collaborator

Should be live in https://github.com/reduxjs/redux-toolkit/releases/tag/%40rtk-query%2Fcodegen-openapi%402.0.0-alpha.0 ! Please try it out and let us know if it works.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants