mirror of
https://github.com/coder/coder.git
synced 2026-06-07 23:18:20 +00:00
Marcin Tojek
dc6d271293
* WIP * Gen * WIP * chi swagger * WIP * WIP * WIP * GetWorkspaces * GetWorkspaces * Markdown * Use widdershins * WIP * WIP * WIP * Markdown template * Fix: makefile * fmt * Fix: comment * Enable swagger conditionally * fix: site * Default false * Flag tests * fix * fix * template fixes * Fix * Fix * Fix * WIP * Formatted * Cleanup * Templates * BEGIN END SECTION * subshell exit code * Fix * Fix merge * WIP * Fix * Fix fmt * Fix * Generic api.md page * Fix merge * Link pages * Fix * Fix * Fix: links * Add icon * Write manifest file * Fix fmt * Fix: enterprise * Fix: Swagger.Enable * Fix: rename apidocs to apidoc * Fix: find -not -prune * Fix: json not available * Fix: rename Coderd API to Coder API * Fix: npm exec * Fix: api dir * Fix: by ID * Fix: string uuid * Fix: include deleted * Fix: indirect go.mod * Fix: source lib.sh * Fix: shellcheck * Fix: pushd popd * Fix: fmt * Fix: improve workspaces * Fix: swagger-enable * Fix * Fix: mention only HTTP 200 * Fix: IDs * Fix: https * Fix: icon * More APis * Fix: format swagger.json * Fix: SwaggerEndpoint * Fix: SCRIPT_DIR * Fix: PROJECT_ROOT * Fix: use code tags in schemas.md * Fix: examples * Fix: examples * Fix: improve format * Fix: date-time,enums * Fix: include_deleted * Fix: array of * Fix: parameter, response * Fix: string time or null * Workspaces: more docs * Workspaces: more docs * Fix: renderDisplayName * Fix: ActiveUserCount * Fix * Fix: typo * Templates: docs * Notice: incomplete
28 lines
1.0 KiB
Modula-2
28 lines
1.0 KiB
Modula-2
<!-- APIDOCGEN: BEGIN SECTION -->
|
|
{{= data.tags.section }}# Authentication
|
|
{{ for (var s in data.api.components.securitySchemes) { }}
|
|
{{ var sd = data.api.components.securitySchemes[s]; }}
|
|
{{? sd.type == 'apiKey' }}
|
|
- API Key ({{=s}})
|
|
- Parameter Name: **{{=sd.name}}**, in: {{=sd.in}}. {{=sd.description || ''}}
|
|
{{?}}
|
|
{{? sd.type == 'http'}}
|
|
- HTTP Authentication, scheme: {{=sd.scheme}}{{? sd.description }}<br/>{{=sd.description}}{{?}}
|
|
{{?}}
|
|
{{? sd.type == 'oauth2'}}
|
|
- oAuth2 authentication. {{=sd.description || ''}}
|
|
{{ for (var f in sd.flows) { }}
|
|
{{ var flow = sd.flows[f]; }}
|
|
- Flow: {{=f}}
|
|
{{? flow.authorizationUrl}} - Authorization URL = [{{=flow.authorizationUrl}}]({{=flow.authorizationUrl}}){{?}}
|
|
{{? flow.tokenUrl}} - Token URL = [{{=flow.tokenUrl}}]({{=flow.tokenUrl}}){{?}}
|
|
{{? flow.scopes && Object.keys(flow.scopes).length}}
|
|
|Scope|Scope Description|
|
|
|---|---|
|
|
{{ for (var sc in flow.scopes) { }}|{{=sc}}|{{=data.utils.join(flow.scopes[sc])}}|
|
|
{{ } /* of scopes */ }}
|
|
{{?}}
|
|
{{ } /* of flows */ }}
|
|
{{?}}
|
|
{{ } /* of securitySchemes */ }}
|