Skip to content

Conversation

kanadgupta
Copy link
Member

@kanadgupta kanadgupta commented Sep 3, 2024

🚥 Partially resolves RM-10641, RM-10720, RM-10730

🧰 Changes

Adds an OAS extension so folks can configure OAuth flows handling. These options are inspired by Swagger UI's configuration options: https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/

In my testing, I've found these ones are necessary for a v1 release of OAuth flows support, but I'm down to add more options further down the line.

Also, a super tiny type-fix with our CODE_SAMPLES extension.

🧬 QA & Testing

Tests appear to pass, but I would love targeted feedback on the following million dollar question: do you feel good about the naming conventions and defaults? This will be impossible to change in the future so I'd love to make sure we develop a consensus first!

I opted to stick with the Swagger naming conventions (despite by own personal reservations), with a couple small exceptions:

Footnotes

  1. First discovered through this: https://security.stackexchange.com/a/143560

  2. I'm also cool with a name that ensures folks understand the risks, (e.g., useInsecureAuthorizationCodeGrantDefinition with a default of false, etc.)

@kanadgupta kanadgupta added the enhancement New feature or request label Sep 3, 2024
@kanadgupta kanadgupta marked this pull request as ready for review September 3, 2024 21:39
*/
name?: string;
};
}[];
Copy link
Member Author

Choose a reason for hiding this comment

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

smol type fix

Copy link
Member Author

@kanadgupta kanadgupta Sep 3, 2024

Choose a reason for hiding this comment

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

all of the changes i made in this file are related to that smol type fix

@kanadgupta kanadgupta requested a review from erunion September 4, 2024 14:15
@kanadgupta kanadgupta merged commit fc524f2 into main Sep 4, 2024
6 checks passed
@kanadgupta kanadgupta deleted the kanad-2024-09-03/oas-extension-for-oauth-options branch September 4, 2024 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants