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

Support for API key #798

Open
pmcelhaney opened this issue Mar 14, 2024 · 0 comments
Open

Support for API key #798

pmcelhaney opened this issue Mar 14, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@pmcelhaney
Copy link
Owner

Counterfact doesn't currently read the security object of the OpenAPI schema.

When generating types, it should take that object into account.

For example, if the security object is defined as:

{
  "type": "apiKey",
  "name": "api_key",
  "in": "header"
}

Then Counterfact should act as if every operation has a required request header named "api_key" when generating code.

Note: this only covers "apiKey" authentication. OpenAPI also "http", "mutualTLS", "oauth2", "openIdConnect". Eventually we'll want to support "http" and "oauth2" as well. I'm not sure the others worth pursuing.

@pmcelhaney pmcelhaney added the enhancement New feature or request label Mar 14, 2024
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

No branches or pull requests

1 participant