-
Notifications
You must be signed in to change notification settings - Fork 13
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
Add more clarity around how to generate the bearer token #100
Changes from 4 commits
034aa44
7aa8034
d8486a4
23d0fbd
d5c14ed
76a13e2
d9b1c52
72490ef
342a200
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,6 +22,11 @@ import TabItem from "@theme/TabItem"; | |
|
||
## CreateCorpus | ||
|
||
This operation authenticates with an OAuth 2.0 Bearer | ||
Token (also known as a JWT token) via the client credentials grant. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is "via the client credentials grant" an important detail? I'm genuinely curious. We mention it in many places. |
||
Review the [OAuth 2.0 section](/docs/api-reference/auth-apis/oauth-2) about | ||
how to generate JWT token. We also provide [client credentials grant examples](/docs/getting-started-samples/JWTFetcher.cs) | ||
in different programming languages. | ||
|
||
|
||
Create Corpus | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,9 +21,23 @@ import Export from "@theme/ApiDemoPanel/Export"; | |
|
||
<ApiLogo logo={{"url":"https://docs.vectara.com/img/vectara_wordmark.png","altText":"Vectara"}} darkLogo={{"url":"https://docs.vectara.com/img/vectara_wordmark_light.png","altText":"Vectara"}}></ApiLogo> | ||
|
||
Vectara is a neural search platform, built for developers to get the most out of their data. | ||
Vectara is the trusted GenAI product platform. Built around a neural search | ||
core, it provides an end-to-end platform for creating GenAI products using | ||
a simple to use API | ||
|
||
You can sign up for an account at [https://vectara.com](https://vectara.com). | ||
You can sign up for an account at [https://vectara.com](https://vectara.com) and | ||
then view several [API Recipes](/docs/api-recipes) with example queries | ||
and parameter values. | ||
|
||
:::note | ||
|
||
API Keys can be used for querying and indexing operations, but cannot at this | ||
time be used for administrative operations such as creating or deleting | ||
corpora. These operations authenticate with a Bearer Token via the | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I see this referred to as Bearer Token in the API playground and JWT token in the OAuth docs. I think JWT token is more common, so I suggest we consistently refer to it using this term, unless in the context of the API playground. |
||
OAuth 2.0 client credentials grant. Review the [OAuth 2.0 section](/docs/api-reference/auth-apis/oauth-2) about | ||
how to generate the token. | ||
|
||
::: | ||
|
||
<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"OAuth 2.0: oAuth"} value={"oAuth"}> | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: remove italics because they don't convey additional info