diff --git a/cli/testdata/coder_server_--help.golden b/cli/testdata/coder_server_--help.golden index 8aea61bf6a..8abc40867e 100644 --- a/cli/testdata/coder_server_--help.golden +++ b/cli/testdata/coder_server_--help.golden @@ -730,7 +730,7 @@ OAUTH2 / GITHUB OPTIONS: --oauth2-github-allowed-teams string-array, $CODER_OAUTH2_GITHUB_ALLOWED_TEAMS Teams inside organizations the user must be a member of to Login with - GitHub. Structured as: /. + GitHub. Structured as: `/`. --oauth2-github-client-id string, $CODER_OAUTH2_GITHUB_CLIENT_ID Client ID for Login with GitHub. diff --git a/cli/testdata/coder_tokens_create_--help.golden b/cli/testdata/coder_tokens_create_--help.golden index 19e9beac20..d408fa4101 100644 --- a/cli/testdata/coder_tokens_create_--help.golden +++ b/cli/testdata/coder_tokens_create_--help.golden @@ -7,7 +7,8 @@ USAGE: OPTIONS: --allow allow-list - Repeatable allow-list entry (:, e.g. workspace:1234-...). + Repeatable allow-list entry (`:`, e.g. + workspace:1234-...). --lifetime string, $CODER_TOKEN_LIFETIME Duration for the token lifetime. Supports standard Go duration units diff --git a/cli/testdata/server-config.yaml.golden b/cli/testdata/server-config.yaml.golden index 0106cd0dfe..a8f3d90eb3 100644 --- a/cli/testdata/server-config.yaml.golden +++ b/cli/testdata/server-config.yaml.golden @@ -301,7 +301,7 @@ oauth2: # (default: , type: string-array) allowedOrgs: [] # Teams inside organizations the user must be a member of to Login with GitHub. - # Structured as: /. + # Structured as: `/`. # (default: , type: string-array) allowedTeams: [] # Whether new users can sign up with GitHub. diff --git a/cli/tokens.go b/cli/tokens.go index 8d47a5e424..de8603939a 100644 --- a/cli/tokens.go +++ b/cli/tokens.go @@ -146,7 +146,7 @@ func (r *RootCmd) createToken() *serpent.Command { }, { Flag: "allow", - Description: "Repeatable allow-list entry (:, e.g. workspace:1234-...).", + Description: "Repeatable allow-list entry (`:`, e.g. workspace:1234-...).", Value: AllowListFlagOf(&allowList), }, } diff --git a/coderd/aitasks.go b/coderd/aitasks.go index f8ec5eaef3..606849d036 100644 --- a/coderd/aitasks.go +++ b/coderd/aitasks.go @@ -426,7 +426,7 @@ func deriveTaskCurrentState( // @Security CoderSessionToken // @Produce json // @Tags Tasks -// @Param q query string false "Search query for filtering tasks. Supports: owner:, organization:, status:" +// @Param q query string false "Search query for filtering tasks. Supports: `owner:`, `organization:`, `status:`" // @Success 200 {object} codersdk.TasksListResponse // @Router /api/v2/tasks [get] func (api *API) tasksList(rw http.ResponseWriter, r *http.Request) { diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go index 637075415d..74eb5e7cd6 100644 --- a/coderd/apidoc/docs.go +++ b/coderd/apidoc/docs.go @@ -78,7 +78,7 @@ const docTemplate = `{ "parameters": [ { "type": "string", - "description": "Search query. Supports title:\u003csubstring\u003e (case-insensitive, quote multi-word values), archived:bool, has_unread:bool, pr_status:\u003cdraft\\|open\\|merged\\|closed\u003e as repeated or comma-separated values, source:\u003ccreated_by_me\\|shared_with_me\u003e, diff_url:\u003curl\u003e (quote values containing colons), pr:\u003cnumber\u003e (exact PR number match), repo:\u003cowner/repo\u003e (case-insensitive substring match against git remote origin or URL), pr_title:\u003ctext\u003e (case-insensitive PR title substring). Bare terms are not supported; use title:\u003cvalue\u003e for title filtering.", + "description": "Search query. Supports ` + "`" + `title:\u003csubstring\u003e` + "`" + ` (case-insensitive, quote multi-word values), ` + "`" + `archived:bool` + "`" + `, ` + "`" + `has_unread:bool` + "`" + `, ` + "`" + `pr_status:\u003cdraft\\|open\\|merged\\|closed\u003e` + "`" + ` as repeated or comma-separated values, ` + "`" + `source:\u003ccreated_by_me\\|shared_with_me\u003e` + "`" + `, ` + "`" + `diff_url:\u003curl\u003e` + "`" + ` (quote values containing colons), ` + "`" + `pr:\u003cnumber\u003e` + "`" + ` (exact PR number match), ` + "`" + `repo:\u003cowner/repo\u003e` + "`" + ` (case-insensitive substring match against git remote origin or URL), ` + "`" + `pr_title:\u003ctext\u003e` + "`" + ` (case-insensitive PR title substring). Bare terms are not supported; use ` + "`" + `title:\u003cvalue\u003e` + "`" + ` for title filtering.", "name": "q", "in": "query" }, @@ -5520,7 +5520,7 @@ const docTemplate = `{ }, { "type": "object", - "description": "Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'})", + "description": "Provisioner tags to filter by (JSON of the form ` + "`" + `{'tag1':'value1','tag2':'value2'}` + "`" + `)", "name": "tags", "in": "query" } @@ -5631,7 +5631,7 @@ const docTemplate = `{ }, { "type": "object", - "description": "Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'})", + "description": "Provisioner tags to filter by (JSON of the form ` + "`" + `{'tag1':'value1','tag2':'value2'}` + "`" + `)", "name": "tags", "in": "query" }, @@ -7077,7 +7077,7 @@ const docTemplate = `{ "parameters": [ { "type": "string", - "description": "Search query for filtering tasks. Supports: owner:\u003cusername/uuid/me\u003e, organization:\u003corg-name/uuid\u003e, status:\u003cstatus\u003e", + "description": "Search query for filtering tasks. Supports: ` + "`" + `owner:\u003cusername/uuid/me\u003e` + "`" + `, ` + "`" + `organization:\u003corg-name/uuid\u003e` + "`" + `, ` + "`" + `status:\u003cstatus\u003e` + "`" + `", "name": "q", "in": "query" } @@ -14897,7 +14897,7 @@ const docTemplate = `{ "type": "boolean" }, "anthropic": { - "description": "Deprecated: Use Providers with indexed CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_* env vars instead.", + "description": "Deprecated: Use Providers with indexed ` + "`" + `CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_*` + "`" + ` env vars instead.", "allOf": [ { "$ref": "#/definitions/codersdk.AIBridgeAnthropicConfig" @@ -14909,7 +14909,7 @@ const docTemplate = `{ "type": "string" }, "bedrock": { - "description": "Deprecated: Use Providers with indexed CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_* env vars instead.", + "description": "Deprecated: Use Providers with indexed ` + "`" + `CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_*` + "`" + ` env vars instead.", "allOf": [ { "$ref": "#/definitions/codersdk.AIBridgeBedrockConfig" @@ -14950,7 +14950,7 @@ const docTemplate = `{ "type": "integer" }, "openai": { - "description": "Deprecated: Use Providers with indexed CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_* env vars instead.", + "description": "Deprecated: Use Providers with indexed ` + "`" + `CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_*` + "`" + ` env vars instead.", "allOf": [ { "$ref": "#/definitions/codersdk.AIBridgeOpenAIConfig" @@ -14958,7 +14958,7 @@ const docTemplate = `{ ] }, "providers": { - "description": "Providers holds provider instances populated from CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_\u003cKEY\u003e\nenv vars and/or the deprecated LegacyOpenAI/LegacyAnthropic/LegacyBedrock fields above.", + "description": "Providers holds provider instances populated from ` + "`" + `CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_\u003cKEY\u003e` + "`" + `\nenv vars and/or the deprecated LegacyOpenAI/LegacyAnthropic/LegacyBedrock fields above.", "type": "array", "items": { "$ref": "#/definitions/codersdk.AIProviderConfig" diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json index 75c3481d33..3f8365fab3 100644 --- a/coderd/apidoc/swagger.json +++ b/coderd/apidoc/swagger.json @@ -59,7 +59,7 @@ "parameters": [ { "type": "string", - "description": "Search query. Supports title:\u003csubstring\u003e (case-insensitive, quote multi-word values), archived:bool, has_unread:bool, pr_status:\u003cdraft\\|open\\|merged\\|closed\u003e as repeated or comma-separated values, source:\u003ccreated_by_me\\|shared_with_me\u003e, diff_url:\u003curl\u003e (quote values containing colons), pr:\u003cnumber\u003e (exact PR number match), repo:\u003cowner/repo\u003e (case-insensitive substring match against git remote origin or URL), pr_title:\u003ctext\u003e (case-insensitive PR title substring). Bare terms are not supported; use title:\u003cvalue\u003e for title filtering.", + "description": "Search query. Supports `title:\u003csubstring\u003e` (case-insensitive, quote multi-word values), `archived:bool`, `has_unread:bool`, `pr_status:\u003cdraft\\|open\\|merged\\|closed\u003e` as repeated or comma-separated values, `source:\u003ccreated_by_me\\|shared_with_me\u003e`, `diff_url:\u003curl\u003e` (quote values containing colons), `pr:\u003cnumber\u003e` (exact PR number match), `repo:\u003cowner/repo\u003e` (case-insensitive substring match against git remote origin or URL), `pr_title:\u003ctext\u003e` (case-insensitive PR title substring). Bare terms are not supported; use `title:\u003cvalue\u003e` for title filtering.", "name": "q", "in": "query" }, @@ -4891,7 +4891,7 @@ }, { "type": "object", - "description": "Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'})", + "description": "Provisioner tags to filter by (JSON of the form `{'tag1':'value1','tag2':'value2'}`)", "name": "tags", "in": "query" } @@ -4996,7 +4996,7 @@ }, { "type": "object", - "description": "Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'})", + "description": "Provisioner tags to filter by (JSON of the form `{'tag1':'value1','tag2':'value2'}`)", "name": "tags", "in": "query" }, @@ -6272,7 +6272,7 @@ "parameters": [ { "type": "string", - "description": "Search query for filtering tasks. Supports: owner:\u003cusername/uuid/me\u003e, organization:\u003corg-name/uuid\u003e, status:\u003cstatus\u003e", + "description": "Search query for filtering tasks. Supports: `owner:\u003cusername/uuid/me\u003e`, `organization:\u003corg-name/uuid\u003e`, `status:\u003cstatus\u003e`", "name": "q", "in": "query" } @@ -13239,7 +13239,7 @@ "type": "boolean" }, "anthropic": { - "description": "Deprecated: Use Providers with indexed CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_* env vars instead.", + "description": "Deprecated: Use Providers with indexed `CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_*` env vars instead.", "allOf": [ { "$ref": "#/definitions/codersdk.AIBridgeAnthropicConfig" @@ -13251,7 +13251,7 @@ "type": "string" }, "bedrock": { - "description": "Deprecated: Use Providers with indexed CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_* env vars instead.", + "description": "Deprecated: Use Providers with indexed `CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_*` env vars instead.", "allOf": [ { "$ref": "#/definitions/codersdk.AIBridgeBedrockConfig" @@ -13292,7 +13292,7 @@ "type": "integer" }, "openai": { - "description": "Deprecated: Use Providers with indexed CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_* env vars instead.", + "description": "Deprecated: Use Providers with indexed `CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_*` env vars instead.", "allOf": [ { "$ref": "#/definitions/codersdk.AIBridgeOpenAIConfig" @@ -13300,7 +13300,7 @@ ] }, "providers": { - "description": "Providers holds provider instances populated from CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_\u003cKEY\u003e\nenv vars and/or the deprecated LegacyOpenAI/LegacyAnthropic/LegacyBedrock fields above.", + "description": "Providers holds provider instances populated from `CODER_AI_GATEWAY_PROVIDER_\u003cN\u003e_\u003cKEY\u003e`\nenv vars and/or the deprecated LegacyOpenAI/LegacyAnthropic/LegacyBedrock fields above.", "type": "array", "items": { "$ref": "#/definitions/codersdk.AIProviderConfig" diff --git a/coderd/exp_chats.go b/coderd/exp_chats.go index 651008391c..47b32e0138 100644 --- a/coderd/exp_chats.go +++ b/coderd/exp_chats.go @@ -337,7 +337,7 @@ func (api *API) chatsByWorkspace(rw http.ResponseWriter, r *http.Request) { // @Security CoderSessionToken // @Tags Chats // @Produce json -// @Param q query string false "Search query. Supports title: (case-insensitive, quote multi-word values), archived:bool, has_unread:bool, pr_status: as repeated or comma-separated values, source:, diff_url: (quote values containing colons), pr: (exact PR number match), repo: (case-insensitive substring match against git remote origin or URL), pr_title: (case-insensitive PR title substring). Bare terms are not supported; use title: for title filtering." +// @Param q query string false "Search query. Supports `title:` (case-insensitive, quote multi-word values), `archived:bool`, `has_unread:bool`, `pr_status:` as repeated or comma-separated values, `source:`, `diff_url:` (quote values containing colons), `pr:` (exact PR number match), `repo:` (case-insensitive substring match against git remote origin or URL), `pr_title:` (case-insensitive PR title substring). Bare terms are not supported; use `title:` for title filtering." // @Param label query string false "Filter by label as key:value. Repeat for multiple (AND logic)." // @Success 200 {array} codersdk.Chat // @Router /api/experimental/chats [get] diff --git a/coderd/provisionerdaemons.go b/coderd/provisionerdaemons.go index 362b39b657..493d082c38 100644 --- a/coderd/provisionerdaemons.go +++ b/coderd/provisionerdaemons.go @@ -26,7 +26,7 @@ import ( // @Param limit query int false "Page limit" // @Param ids query []string false "Filter results by job IDs" format(uuid) // @Param status query codersdk.ProvisionerJobStatus false "Filter results by status" enums(pending,running,succeeded,canceling,canceled,failed) -// @Param tags query object false "Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'})" +// @Param tags query object false "Provisioner tags to filter by (JSON of the form `{'tag1':'value1','tag2':'value2'}`)" // @Success 200 {array} codersdk.ProvisionerDaemon // @Router /api/v2/organizations/{organization}/provisionerdaemons [get] func (api *API) provisionerDaemons(rw http.ResponseWriter, r *http.Request) { diff --git a/coderd/provisionerjobs.go b/coderd/provisionerjobs.go index 5ece926cd6..799b7baae1 100644 --- a/coderd/provisionerjobs.go +++ b/coderd/provisionerjobs.go @@ -75,7 +75,7 @@ func (api *API) provisionerJob(rw http.ResponseWriter, r *http.Request) { // @Param limit query int false "Page limit" // @Param ids query []string false "Filter results by job IDs" format(uuid) // @Param status query codersdk.ProvisionerJobStatus false "Filter results by status" enums(pending,running,succeeded,canceling,canceled,failed) -// @Param tags query object false "Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'})" +// @Param tags query object false "Provisioner tags to filter by (JSON of the form `{'tag1':'value1','tag2':'value2'}`)" // @Param initiator query string false "Filter results by initiator" format(uuid) // @Success 200 {array} codersdk.ProvisionerJob // @Router /api/v2/organizations/{organization}/provisionerjobs [get] diff --git a/codersdk/deployment.go b/codersdk/deployment.go index 8a9a39aab6..2c4a0bffa9 100644 --- a/codersdk/deployment.go +++ b/codersdk/deployment.go @@ -2686,7 +2686,7 @@ communicating directly.`, }, { Name: "OAuth2 GitHub Allowed Teams", - Description: "Teams inside organizations the user must be a member of to Login with GitHub. Structured as: /.", + Description: "Teams inside organizations the user must be a member of to Login with GitHub. Structured as: `/`.", Flag: "oauth2-github-allowed-teams", Env: "CODER_OAUTH2_GITHUB_ALLOWED_TEAMS", Value: &c.OAuth2.Github.AllowedTeams, @@ -4874,13 +4874,13 @@ Write out the current server config as YAML to stdout.`, type AIBridgeConfig struct { Enabled serpent.Bool `json:"enabled" typescript:",notnull"` - // Deprecated: Use Providers with indexed CODER_AI_GATEWAY_PROVIDER__* env vars instead. + // Deprecated: Use Providers with indexed `CODER_AI_GATEWAY_PROVIDER__*` env vars instead. LegacyOpenAI AIBridgeOpenAIConfig `json:"openai" typescript:",notnull"` - // Deprecated: Use Providers with indexed CODER_AI_GATEWAY_PROVIDER__* env vars instead. + // Deprecated: Use Providers with indexed `CODER_AI_GATEWAY_PROVIDER__*` env vars instead. LegacyAnthropic AIBridgeAnthropicConfig `json:"anthropic" typescript:",notnull"` - // Deprecated: Use Providers with indexed CODER_AI_GATEWAY_PROVIDER__* env vars instead. + // Deprecated: Use Providers with indexed `CODER_AI_GATEWAY_PROVIDER__*` env vars instead. LegacyBedrock AIBridgeBedrockConfig `json:"bedrock" typescript:",notnull"` - // Providers holds provider instances populated from CODER_AI_GATEWAY_PROVIDER__ + // Providers holds provider instances populated from `CODER_AI_GATEWAY_PROVIDER__` // env vars and/or the deprecated LegacyOpenAI/LegacyAnthropic/LegacyBedrock fields above. Providers []AIProviderConfig `json:"providers,omitempty"` // Deprecated: Injected MCP in AI Bridge is deprecated and will be removed in a future release. diff --git a/docs/about/contributing/documentation.md b/docs/about/contributing/documentation.md index 7f511d9b58..835e8f081a 100644 --- a/docs/about/contributing/documentation.md +++ b/docs/about/contributing/documentation.md @@ -71,7 +71,7 @@ Use _code font_ for: - Filenames, filename extensions, and paths - Folders and directories - HTTP verbs, status codes, and content-type values -- Placeholder variables +- Placeholder variables (see [Placeholders in angle brackets](#placeholders-in-angle-brackets)) Use _code blocks_ for code samples and other blocks of code. Be sure to indicate the language your using to apply the proper syntax highlighting. @@ -83,6 +83,24 @@ This is a codeblock. For code that you want users to enter via a command-line interface, use `console`, not `bash`. +### Placeholders in angle brackets + +Placeholder values written in angle brackets **must** be wrapped in backticks so +they render as inline code. The documentation site renders Markdown as HTML, so +an unwrapped placeholder such as `` is parsed as an unknown +HTML tag and stripped out of the page, so readers never see it. + +This applies wherever the text becomes documentation, including the Go CLI help +strings and Swagger annotations that generate the CLI and API reference. + +```text +# Correct: wrap the placeholder in backticks +Structured as: `/`. + +# Incorrect: the placeholder renders as "Structured as: /." +Structured as: /. +``` + ### Punctuation Do not use the ampersand (&) as a shorthand for _and_ unless you're referring to diff --git a/docs/reference/api/chats.md b/docs/reference/api/chats.md index a9bd9bd042..0206083b0e 100644 --- a/docs/reference/api/chats.md +++ b/docs/reference/api/chats.md @@ -19,10 +19,10 @@ Experimental: this endpoint is subject to change. ### Parameters -| Name | In | Type | Required | Description | -|---------|-------|--------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `q` | query | string | false | Search query. Supports title: (case-insensitive, quote multi-word values), archived:bool, has_unread:bool, pr_status: as repeated or comma-separated values, source:, diff_url: (quote values containing colons), pr: (exact PR number match), repo: (case-insensitive substring match against git remote origin or URL), pr_title: (case-insensitive PR title substring). Bare terms are not supported; use title: for title filtering. | -| `label` | query | string | false | Filter by label as key:value. Repeat for multiple (AND logic). | +| Name | In | Type | Required | Description | +|---------|-------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `q` | query | string | false | Search query. Supports `title:` (case-insensitive, quote multi-word values), `archived:bool`, `has_unread:bool`, `pr_status:` as repeated or comma-separated values, `source:`, `diff_url:` (quote values containing colons), `pr:` (exact PR number match), `repo:` (case-insensitive substring match against git remote origin or URL), `pr_title:` (case-insensitive PR title substring). Bare terms are not supported; use `title:` for title filtering. | +| `label` | query | string | false | Filter by label as key:value. Repeat for multiple (AND logic). | ### Example responses diff --git a/docs/reference/api/organizations.md b/docs/reference/api/organizations.md index c0dcb21926..16324ba132 100644 --- a/docs/reference/api/organizations.md +++ b/docs/reference/api/organizations.md @@ -288,14 +288,14 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Parameters -| Name | In | Type | Required | Description | -|----------------|-------|--------------|----------|------------------------------------------------------------------------------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `limit` | query | integer | false | Page limit | -| `ids` | query | array(uuid) | false | Filter results by job IDs | -| `status` | query | string | false | Filter results by status | -| `tags` | query | object | false | Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'}) | -| `initiator` | query | string(uuid) | false | Filter results by initiator | +| Name | In | Type | Required | Description | +|----------------|-------|--------------|----------|--------------------------------------------------------------------------------------| +| `organization` | path | string(uuid) | true | Organization ID | +| `limit` | query | integer | false | Page limit | +| `ids` | query | array(uuid) | false | Filter results by job IDs | +| `status` | query | string | false | Filter results by status | +| `tags` | query | object | false | Provisioner tags to filter by (JSON of the form `{'tag1':'value1','tag2':'value2'}`) | +| `initiator` | query | string(uuid) | false | Filter results by initiator | #### Enumerated Values diff --git a/docs/reference/api/provisioning.md b/docs/reference/api/provisioning.md index 7a6a238b60..1389b0c123 100644 --- a/docs/reference/api/provisioning.md +++ b/docs/reference/api/provisioning.md @@ -15,13 +15,13 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi ### Parameters -| Name | In | Type | Required | Description | -|----------------|-------|--------------|----------|------------------------------------------------------------------------------------| -| `organization` | path | string(uuid) | true | Organization ID | -| `limit` | query | integer | false | Page limit | -| `ids` | query | array(uuid) | false | Filter results by job IDs | -| `status` | query | string | false | Filter results by status | -| `tags` | query | object | false | Provisioner tags to filter by (JSON of the form {'tag1':'value1','tag2':'value2'}) | +| Name | In | Type | Required | Description | +|----------------|-------|--------------|----------|--------------------------------------------------------------------------------------| +| `organization` | path | string(uuid) | true | Organization ID | +| `limit` | query | integer | false | Page limit | +| `ids` | query | array(uuid) | false | Filter results by job IDs | +| `status` | query | string | false | Filter results by status | +| `tags` | query | object | false | Provisioner tags to filter by (JSON of the form `{'tag1':'value1','tag2':'value2'}`) | #### Enumerated Values diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md index 82ef396293..a3d68f71b8 100644 --- a/docs/reference/api/schemas.md +++ b/docs/reference/api/schemas.md @@ -435,28 +435,28 @@ ### Properties -| Name | Type | Required | Restrictions | Description | -|-------------------------------------|----------------------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `allow_byok` | boolean | false | | | -| `anthropic` | [codersdk.AIBridgeAnthropicConfig](#codersdkaibridgeanthropicconfig) | false | | Deprecated: Use Providers with indexed CODER_AI_GATEWAY_PROVIDER__* env vars instead. | -| `api_dump_dir` | string | false | | Api dump dir is the base directory under which each provider's request/response dumps are written, in a subdirectory named after the provider. Empty disables dumping. | -| `bedrock` | [codersdk.AIBridgeBedrockConfig](#codersdkaibridgebedrockconfig) | false | | Deprecated: Use Providers with indexed CODER_AI_GATEWAY_PROVIDER__* env vars instead. | -| `budget_period` | string | false | | | -| `budget_policy` | string | false | | Budget settings for AI Governance cost controls. | -| `circuit_breaker_enabled` | boolean | false | | Circuit breaker protects against cascading failures from upstream AI provider overload (503, 529). | -| `circuit_breaker_failure_threshold` | integer | false | | | -| `circuit_breaker_interval` | integer | false | | | -| `circuit_breaker_max_requests` | integer | false | | | -| `circuit_breaker_timeout` | integer | false | | | -| `enabled` | boolean | false | | | -| `inject_coder_mcp_tools` | boolean | false | | Deprecated: Injected MCP in AI Bridge is deprecated and will be removed in a future release. | -| `max_concurrency` | integer | false | | | -| `openai` | [codersdk.AIBridgeOpenAIConfig](#codersdkaibridgeopenaiconfig) | false | | Deprecated: Use Providers with indexed CODER_AI_GATEWAY_PROVIDER__* env vars instead. | -| `providers` | array of [codersdk.AIProviderConfig](#codersdkaiproviderconfig) | false | | Providers holds provider instances populated from CODER_AI_GATEWAY_PROVIDER__ env vars and/or the deprecated LegacyOpenAI/LegacyAnthropic/LegacyBedrock fields above. | -| `rate_limit` | integer | false | | | -| `retention` | integer | false | | | -| `send_actor_headers` | boolean | false | | | -| `structured_logging` | boolean | false | | | +| Name | Type | Required | Restrictions | Description | +|-------------------------------------|----------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `allow_byok` | boolean | false | | | +| `anthropic` | [codersdk.AIBridgeAnthropicConfig](#codersdkaibridgeanthropicconfig) | false | | Deprecated: Use Providers with indexed `CODER_AI_GATEWAY_PROVIDER__*` env vars instead. | +| `api_dump_dir` | string | false | | Api dump dir is the base directory under which each provider's request/response dumps are written, in a subdirectory named after the provider. Empty disables dumping. | +| `bedrock` | [codersdk.AIBridgeBedrockConfig](#codersdkaibridgebedrockconfig) | false | | Deprecated: Use Providers with indexed `CODER_AI_GATEWAY_PROVIDER__*` env vars instead. | +| `budget_period` | string | false | | | +| `budget_policy` | string | false | | Budget settings for AI Governance cost controls. | +| `circuit_breaker_enabled` | boolean | false | | Circuit breaker protects against cascading failures from upstream AI provider overload (503, 529). | +| `circuit_breaker_failure_threshold` | integer | false | | | +| `circuit_breaker_interval` | integer | false | | | +| `circuit_breaker_max_requests` | integer | false | | | +| `circuit_breaker_timeout` | integer | false | | | +| `enabled` | boolean | false | | | +| `inject_coder_mcp_tools` | boolean | false | | Deprecated: Injected MCP in AI Bridge is deprecated and will be removed in a future release. | +| `max_concurrency` | integer | false | | | +| `openai` | [codersdk.AIBridgeOpenAIConfig](#codersdkaibridgeopenaiconfig) | false | | Deprecated: Use Providers with indexed `CODER_AI_GATEWAY_PROVIDER__*` env vars instead. | +| `providers` | array of [codersdk.AIProviderConfig](#codersdkaiproviderconfig) | false | | Providers holds provider instances populated from `CODER_AI_GATEWAY_PROVIDER__` env vars and/or the deprecated LegacyOpenAI/LegacyAnthropic/LegacyBedrock fields above. | +| `rate_limit` | integer | false | | | +| `retention` | integer | false | | | +| `send_actor_headers` | boolean | false | | | +| `structured_logging` | boolean | false | | | ## codersdk.AIBridgeListSessionsResponse diff --git a/docs/reference/api/tasks.md b/docs/reference/api/tasks.md index 4efe1053cf..e0236cbb58 100644 --- a/docs/reference/api/tasks.md +++ b/docs/reference/api/tasks.md @@ -15,9 +15,9 @@ curl -X GET http://coder-server:8080/api/v2/tasks \ ### Parameters -| Name | In | Type | Required | Description | -|------|-------|--------|----------|---------------------------------------------------------------------------------------------------------------------| -| `q` | query | string | false | Search query for filtering tasks. Supports: owner:, organization:, status: | +| Name | In | Type | Required | Description | +|------|-------|--------|----------|---------------------------------------------------------------------------------------------------------------------------| +| `q` | query | string | false | Search query for filtering tasks. Supports: `owner:`, `organization:`, `status:` | ### Example responses diff --git a/docs/reference/cli/server.md b/docs/reference/cli/server.md index ca907d4adb..f4ae058d87 100644 --- a/docs/reference/cli/server.md +++ b/docs/reference/cli/server.md @@ -414,7 +414,7 @@ Organizations the user must be a member of to Login with GitHub. | Environment | $CODER_OAUTH2_GITHUB_ALLOWED_TEAMS | | YAML | oauth2.github.allowedTeams | -Teams inside organizations the user must be a member of to Login with GitHub. Structured as: /. +Teams inside organizations the user must be a member of to Login with GitHub. Structured as: `/`. ### --oauth2-github-allow-signups diff --git a/docs/reference/cli/tokens_create.md b/docs/reference/cli/tokens_create.md index b15e58cd13..56873aaec7 100644 --- a/docs/reference/cli/tokens_create.md +++ b/docs/reference/cli/tokens_create.md @@ -52,4 +52,4 @@ Repeatable scope to attach to the token (e.g. workspace:read). |------|-------------------------| | Type | allow-list | -Repeatable allow-list entry (:, e.g. workspace:1234-...). +Repeatable allow-list entry (`:`, e.g. workspace:1234-...). diff --git a/enterprise/cli/testdata/coder_server_--help.golden b/enterprise/cli/testdata/coder_server_--help.golden index 5d934b6b5a..369b2fe72c 100644 --- a/enterprise/cli/testdata/coder_server_--help.golden +++ b/enterprise/cli/testdata/coder_server_--help.golden @@ -731,7 +731,7 @@ OAUTH2 / GITHUB OPTIONS: --oauth2-github-allowed-teams string-array, $CODER_OAUTH2_GITHUB_ALLOWED_TEAMS Teams inside organizations the user must be a member of to Login with - GitHub. Structured as: /. + GitHub. Structured as: `/`. --oauth2-github-client-id string, $CODER_OAUTH2_GITHUB_CLIENT_ID Client ID for Login with GitHub. diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts index a63fcdc279..bb9321a467 100644 --- a/site/src/api/typesGenerated.ts +++ b/site/src/api/typesGenerated.ts @@ -42,19 +42,19 @@ export interface AIBridgeBedrockConfig { export interface AIBridgeConfig { readonly enabled: boolean; /** - * @deprecated Use Providers with indexed CODER_AI_GATEWAY_PROVIDER__* env vars instead. + * @deprecated Use Providers with indexed `CODER_AI_GATEWAY_PROVIDER__*` env vars instead. */ readonly openai: AIBridgeOpenAIConfig; /** - * @deprecated Use Providers with indexed CODER_AI_GATEWAY_PROVIDER__* env vars instead. + * @deprecated Use Providers with indexed `CODER_AI_GATEWAY_PROVIDER__*` env vars instead. */ readonly anthropic: AIBridgeAnthropicConfig; /** - * @deprecated Use Providers with indexed CODER_AI_GATEWAY_PROVIDER__* env vars instead. + * @deprecated Use Providers with indexed `CODER_AI_GATEWAY_PROVIDER__*` env vars instead. */ readonly bedrock: AIBridgeBedrockConfig; /** - * Providers holds provider instances populated from CODER_AI_GATEWAY_PROVIDER__ + * Providers holds provider instances populated from `CODER_AI_GATEWAY_PROVIDER__` * env vars and/or the deprecated LegacyOpenAI/LegacyAnthropic/LegacyBedrock fields above. */ readonly providers?: readonly AIProviderConfig[];