Skip to content

Commit 56cc0bf

Browse files
committed
docs(api): add YAML examples for x-authorize-params and x-token-params vendor extensions
1 parent f567cde commit 56cc0bf

1 file changed

Lines changed: 35 additions & 2 deletions

File tree

‎docs/src/page-data/rapidoc-api.yaml‎

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -600,7 +600,40 @@ Extensions:
600600
description: When set to "true", enforces Proof Key for Code Exchange (PKCE) flow and prevents client secrets from being transmitted from the browser.
601601
- name: x-authorize-params
602602
description: >
603-
Object or query string defining custom parameters appended to the OAuth2 authorizationUrl query string (e.g. proxy launch tokens, prompt, audience). Supported at both security scheme and individual flow levels.
603+
Object or query string defining custom parameters appended to the OAuth2 authorizationUrl query string (e.g. proxy launch tokens, prompt, audience). Supported at both security scheme and individual flow levels.<br/><br/>
604+
<span class="yellow">Example:</span>
605+
<pre><code class="language-yaml">
606+
components:
607+
securitySchemes:
608+
oauth-flow:
609+
type: oauth2
610+
flows:
611+
authorizationCode:
612+
authorizationUrl: https://auth.example.com/oauth2/authorize
613+
tokenUrl: https://auth.example.com/oauth2/token
614+
x-authorize-params:
615+
launch: xyz123
616+
prompt: consent
617+
audience: https://api.mycompany.com
618+
scopes:
619+
read: Read access
620+
</code></pre>
604621
- name: x-token-params
605622
description: >
606-
Object or form parameters sent in the POST request body to the OAuth2 tokenUrl (e.g. custom proxy fields, resource, audience). Supported at both security scheme and individual flow levels.
623+
Object or form parameters sent in the POST request body to the OAuth2 tokenUrl (e.g. custom proxy fields, resource, audience). Supported at both security scheme and individual flow levels.<br/><br/>
624+
<span class="yellow">Example:</span>
625+
<pre><code class="language-yaml">
626+
components:
627+
securitySchemes:
628+
oauth-flow:
629+
type: oauth2
630+
flows:
631+
authorizationCode:
632+
authorizationUrl: https://auth.example.com/oauth2/authorize
633+
tokenUrl: https://auth.example.com/oauth2/token
634+
x-token-params:
635+
audience: https://api.mycompany.com
636+
resource: urn:my:resource:server
637+
scopes:
638+
read: Read access
639+
</code></pre>

0 commit comments

Comments
 (0)