Change from BearerAuth to API Key Auth #3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
annelo-msft
commented
Sep 28, 2023
| @@ -1,15 +1,3 @@ | |||
| A conversion of the OpenAI OpenAPI to TypeSpec. | |||
| # OpenAPI spec for the OpenAI API | |||
There was a problem hiding this comment.
This is a weird Windows thing, we think, and I can follow up by deleting this file, which I've moved to conversion.md.
annelo-msft
commented
Sep 28, 2023
main.tsp
Outdated
| version: "2.0.0", | ||
| }) | ||
| @useAuth(BearerAuth) | ||
| @useAuth(ApiKeyAuth<ApiKeyLocation.query, "AUTHORIZATION">) |
There was a problem hiding this comment.
@bterlson, is there a way to tell the ApiKeyAuth piece about a string prefix it needs to add before the API key?
There was a problem hiding this comment.
it is a bearerkey defined in the original api though
securitySchemes:
ApiKeyAuth:
type: http
scheme: 'bearer'
ApiKeyAuth is just a free name they choosed
See playground with BearerAuth
vs ApiKeyAuth
There was a problem hiding this comment.
The exact same name can be achieved by using your own model name instead of BearerAuth if this is important
import "@typespec/http";
using TypeSpec.Http;
@service
@useAuth(ApiKeyAuth)
namespace DemoService;
model ApiKeyAuth is BearerAuth {}
annelo-msft
referenced
this pull request
in annelo-msft/openai-in-typespec
Mar 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The original OpenAI API definition defines their auth policy as API Key, so changing the TypeSpec to do the same.