feat(docs): Add required oauth scope to API endpoints (#39723)

This commit is contained in:
Kamil Ogórek authored and GitHub committed 2025-10-22 15:19:23 +02:00
1 parent d8f7cc0d57
commit 564ebfc274
2 files changed
+13

No files matched your search

@@ -24,6 +24,7 @@ export interface IApiEndPoint {
}
tags?: Array<string>
security?: Array<ISecurityOption>
'x-oauth-scope'?: string
}
export type ISchema =
@@ -341,6 +341,18 @@ async function ApiEndpointSection({ link, section, servicePath }: ApiEndpointSec
{endpointDetails.description}
</ReactMarkdown>
)}
{endpointDetails['x-oauth-scope'] && (
<section>
<h3 className="mb-3 text-base text-foreground">OAuth scopes</h3>
<ul>
<li key={endpointDetails['x-oauth-scope']} className="list-['-'] ml-2 pl-2">
<span className="font-mono text-sm font-medium text-foreground">
{endpointDetails['x-oauth-scope']}
</span>
</li>
</ul>
</section>
)}
{pathParameters.length > 0 && (
<section>
<h3 className="mb-3 text-base text-foreground">Path parameters</h3>