Skip to content

Commit 17171d0

Browse files
Merge pull request #2074 from lindazqli/patch-20
update openapi spec auth type support
2 parents 09ba51c + a58ca6b commit 17171d0

File tree

1 file changed

+1
-13
lines changed

1 file changed

+1
-13
lines changed

articles/ai-services/agents/how-to/tools/openapi-spec.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ OpenAPI Specified tool improves your function calling experience by providing st
2525
automated, and scalable API integrations that enhance the capabilities and efficiency of your agent.
2626
[OpenAPI specifications](https://spec.openapis.org/oas/latest.html) provide a formal standard for
2727
describing HTTP APIs. This allows people to understand how an API works, how a sequence of APIs
28-
work together, generate client code, create tests, apply design standards, and more.
28+
work together, generate client code, create tests, apply design standards, and more. Currently, we support 3 authentication types with the OpenAPI 3.0 specified tools: `anonymous`, `API key`, `managed identity`.
2929

3030
## Set up
3131
1. Ensure you've completed the prerequisites and setup steps in the [quickstart](../../quickstart.md).
@@ -51,18 +51,6 @@ work together, generate client code, create tests, apply design standards, and m
5151
- Connection name: `YOUR_CONNECTION_NAME` (You will use this connection name in the sample code below.)
5252
- Access: you can choose either *this project only* or *shared to all projects*. Just make sure in the sample code below, the project you entered connection string for has access to this connection.
5353

54-
1. Update your OpenAPI Spec with the following:
55-
```json
56-
"components": {
57-
"securitySchemes": {
58-
"cosoLocationApiLambdaAuthorizer": {
59-
"type": "apiKey",
60-
"name": "key",
61-
"in": "query"
62-
}
63-
}
64-
}
65-
```
6654
::: zone-end
6755

6856
::: zone pivot="code-example"

0 commit comments

Comments
 (0)