From d22050bd9af2f0dc98a8234efe66720f2a899e79 Mon Sep 17 00:00:00 2001 From: Lauren Date: Fri, 28 Jul 2023 14:22:14 -0500 Subject: [PATCH] update docs Nothing to No Content for HTTP 204 resp (#409) update Nothing to No Content for HTTP 204 --- website/docs/cloud-docs/api-docs/agents.mdx | 2 +- .../docs/cloud-docs/api-docs/organization-tags.mdx | 4 ++-- .../cloud-docs/api-docs/organization-tokens.mdx | 2 +- website/docs/cloud-docs/api-docs/policies.mdx | 2 +- website/docs/cloud-docs/api-docs/policy-sets.mdx | 10 +++++----- .../api-docs/private-registry/modules.mdx | 2 +- .../provider-versions-platforms.mdx | 4 ++-- .../api-docs/private-registry/providers.mdx | 2 +- website/docs/cloud-docs/api-docs/projects.mdx | 4 ++-- .../api-docs/run-tasks/run-tasks-integration.mdx | 8 ++++---- .../cloud-docs/api-docs/run-tasks/run-tasks.mdx | 6 +++--- website/docs/cloud-docs/api-docs/run-triggers.mdx | 2 +- website/docs/cloud-docs/api-docs/ssh-keys.mdx | 2 +- website/docs/cloud-docs/api-docs/workspaces.mdx | 14 +++++++------- 14 files changed, 32 insertions(+), 32 deletions(-) diff --git a/website/docs/cloud-docs/api-docs/agents.mdx b/website/docs/cloud-docs/api-docs/agents.mdx index 14e69603d..641505565 100644 --- a/website/docs/cloud-docs/api-docs/agents.mdx +++ b/website/docs/cloud-docs/api-docs/agents.mdx @@ -373,7 +373,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | ------------------------------------------------------------------------------------------------------------ | -| [204][] | Nothing | Success | +| [204][] | No Content | Success | | [412][] | [JSON API error object][] | Agent is not deletable. Agents must have a status of `unknown`, `errored`, or `exited` before being deleted. | | [404][] | [JSON API error object][] | Agent not found, or user unauthorized to perform action | diff --git a/website/docs/cloud-docs/api-docs/organization-tags.mdx b/website/docs/cloud-docs/api-docs/organization-tags.mdx index 2ad7b68d9..c78461f4e 100644 --- a/website/docs/cloud-docs/api-docs/organization-tags.mdx +++ b/website/docs/cloud-docs/api-docs/organization-tags.mdx @@ -124,7 +124,7 @@ exist. Tags deleted here will be removed from all other resources. | Status | Response | Reason(s) | | ------- | ------------------------- | -------------------------------------------------------------- | -| [204][] | Nothing | Successfully removed tags from organization | +| [204][] | No Content | Successfully removed tags from organization | | [404][] | [JSON API error object][] | Organization not found, or user unauthorized to perform action | ### Request Body @@ -178,7 +178,7 @@ Status code `204`. | Status | Response | Reason(s) | | ------- | ------------------------- | ----------------------------------------------------- | -| [204][] | Nothing | Successfully added workspaces to tag | +| [204][] | No Content | Successfully added workspaces to tag | | [404][] | [JSON API error object][] | Tag not found, or user unauthorized to perform action | ### Request Body diff --git a/website/docs/cloud-docs/api-docs/organization-tokens.mdx b/website/docs/cloud-docs/api-docs/organization-tokens.mdx index c4f6ce145..6d794a60f 100644 --- a/website/docs/cloud-docs/api-docs/organization-tokens.mdx +++ b/website/docs/cloud-docs/api-docs/organization-tokens.mdx @@ -133,7 +133,7 @@ Only members of the owners team, the owners [team API token](/terraform/cloud-do | Status | Response | Reason | | ------- | ------------------------- | ------------------- | -| [204][] | Nothing | Success | +| [204][] | No Content | Success | | [404][] | [JSON API error object][] | User not authorized | ### Sample Request diff --git a/website/docs/cloud-docs/api-docs/policies.mdx b/website/docs/cloud-docs/api-docs/policies.mdx index d56cb21b8..1835641a0 100644 --- a/website/docs/cloud-docs/api-docs/policies.mdx +++ b/website/docs/cloud-docs/api-docs/policies.mdx @@ -539,7 +539,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | -------------------------------------------------------- | -| [204][] | Nothing | Successfully deleted the policy | +| [204][] | No Content | Successfully deleted the policy | | [404][] | [JSON API error object][] | Policy not found, or user unauthorized to perform action | ### Sample Request diff --git a/website/docs/cloud-docs/api-docs/policy-sets.mdx b/website/docs/cloud-docs/api-docs/policy-sets.mdx index 53ad8df7c..eb6bbfd60 100644 --- a/website/docs/cloud-docs/api-docs/policy-sets.mdx +++ b/website/docs/cloud-docs/api-docs/policy-sets.mdx @@ -631,7 +631,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | -------------------------------------------------------------------------- | -| [204][] | Nothing | The request was successful | +| [204][] | No Content | The request was successful | | [404][] | [JSON API error object][] | Policy set not found or user unauthorized to perform action | | [422][] | [JSON API error object][] | Malformed request body (one or more policies not found, wrong types, etc.) | @@ -681,7 +681,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | ---------------------------------------------------------------------------- | -| [204][] | Nothing | The request was successful | +| [204][] | No Content | The request was successful | | [404][] | [JSON API error object][] | Policy set not found or user unauthorized to perform action | | [422][] | [JSON API error object][] | Malformed request body (one or more workspaces not found, wrong types, etc.) | @@ -727,7 +727,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | ----------------------------------------------------------- | -| [204][] | Nothing | The request was successful | +| [204][] | No Content | The request was successful | | [404][] | [JSON API error object][] | Policy set not found or user unauthorized to perform action | | [422][] | [JSON API error object][] | Malformed request body (wrong types, etc.) | @@ -777,7 +777,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | ----------------------------------------------------------- | -| [204][] | Nothing | The request was successful | +| [204][] | No Content | The request was successful | | [404][] | [JSON API error object][] | Policy set not found or user unauthorized to perform action | | [422][] | [JSON API error object][] | Malformed request body (wrong types, etc.) | @@ -823,7 +823,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | ------------------------------------------------------------ | -| [204][] | Nothing | Successfully deleted the policy set | +| [204][] | No Content | Successfully deleted the policy set | | [404][] | [JSON API error object][] | Policy set not found, or user unauthorized to perform action | ### Sample Request diff --git a/website/docs/cloud-docs/api-docs/private-registry/modules.mdx b/website/docs/cloud-docs/api-docs/private-registry/modules.mdx index f3e30fe49..4ecd660e5 100644 --- a/website/docs/cloud-docs/api-docs/private-registry/modules.mdx +++ b/website/docs/cloud-docs/api-docs/private-registry/modules.mdx @@ -809,7 +809,7 @@ If a version deletion would leave a provider with no versions, the provider will | Status | Response | Reason | | ------- | ------------------------- | ------------------------------------------------------------- | -| [204][] | Nothing | Success | +| [204][] | No Content | Success | | [403][] | [JSON API error object][] | Forbidden - public module curation disabled | | [404][] | [JSON API error object][] | Module, provider, or version not found or user not authorized | diff --git a/website/docs/cloud-docs/api-docs/private-registry/provider-versions-platforms.mdx b/website/docs/cloud-docs/api-docs/private-registry/provider-versions-platforms.mdx index f2558686a..9ecbd13fe 100644 --- a/website/docs/cloud-docs/api-docs/private-registry/provider-versions-platforms.mdx +++ b/website/docs/cloud-docs/api-docs/private-registry/provider-versions-platforms.mdx @@ -379,7 +379,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | ----------------------------------------------------------- | -| [204][] | Nothing | Success | +| [204][] | No Content | Success | | [403][] | [JSON API error object][] | Forbidden - public provider curation disabled | | [404][] | [JSON API error object][] | Provider not found or user not authorized to perform action | @@ -697,7 +697,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | ----------------------------------------------------------- | -| [204][] | Nothing | Success | +| [204][] | No Content | Success | | [403][] | [JSON API error object][] | Forbidden - public provider curation disabled | | [404][] | [JSON API error object][] | Provider not found or user not authorized to perform action | diff --git a/website/docs/cloud-docs/api-docs/private-registry/providers.mdx b/website/docs/cloud-docs/api-docs/private-registry/providers.mdx index 1074556b8..ff29bef1d 100644 --- a/website/docs/cloud-docs/api-docs/private-registry/providers.mdx +++ b/website/docs/cloud-docs/api-docs/private-registry/providers.mdx @@ -446,7 +446,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | ----------------------------------------------------------- | -| [204][] | Nothing | Success | +| [204][] | No Content | Success | | [403][] | [JSON API error object][] | Forbidden - public provider curation disabled | | [404][] | [JSON API error object][] | Provider not found or user not authorized to perform action | diff --git a/website/docs/cloud-docs/api-docs/projects.mdx b/website/docs/cloud-docs/api-docs/projects.mdx index 5af0ed2b9..f80915b72 100644 --- a/website/docs/cloud-docs/api-docs/projects.mdx +++ b/website/docs/cloud-docs/api-docs/projects.mdx @@ -358,7 +358,7 @@ A project cannot be deleted if it contains workspaces. | Status | Response | Reason(s) | |---------|---------------------------|-------------------------------------------------------------------| -| [204][] | Nothing | Successfully deleted the project | +| [204][] | No Content | Successfully deleted the project | | [403][] | [JSON API error object][] | Not authorized to perform a force delete on the project | | [404][] | [JSON API error object][] | Project not found, or user unauthorized to perform project delete | @@ -393,7 +393,7 @@ This POST endpoint requires a JSON object with the following properties as a req | Status | Response | Reason(s) | |---------|---------------------------|----------------------------------------------------------------------------------------------------------| -| [204][] | Nothing | Successfully moved workspace(s) | +| [204][] | No Content | Successfully moved workspace(s) | | [403][] | [JSON API error object][] | Workspace(s) not found, or user is not authorized to move all workspaces out of their current project(s) | | [404][] | [JSON API error object][] | Project not found, or user unauthorized to move workspaces into project | diff --git a/website/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx b/website/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx index 8040dd3ab..c69d2ea6c 100644 --- a/website/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx +++ b/website/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx @@ -34,9 +34,9 @@ The service receiving the run task request should respond with `200 OK`, or Terr |-----------|---------------------------------------------------------| | `:url` | The URL configured in the run task to send requests to. | -| Status | Response | Reason | -|---------|----------|-----------------------------------| -| [200][] | Nothing | Successfully submitted a run task | +| Status | Response | Reason | +|---------|------------|-----------------------------------| +| [200][] | No Content | Successfully submitted a run task | ### Request Body @@ -133,7 +133,7 @@ Once a run task request has been fulfilled by the external integration, the inte | Status | Response | Reason | | ------- | ------------------------- | ---------------------------------------- | -| [200][] | Nothing | Successfully submitted a run task result | +| [200][] | No Content | Successfully submitted a run task result | | [401][] | [JSON API error object][] | Not authorized to perform action | | [422][] | [JSON API error object][] | Invalid response payload. This could be caused by invalid attributes, or sending a status that is not accepted. | diff --git a/website/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx b/website/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx index d1a2ddfb3..af5910952 100644 --- a/website/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx +++ b/website/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx @@ -400,7 +400,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | ---------------------------------------------------------- | -| [204][] | Nothing | Successfully deleted the run task | +| [204][] | No Content | Successfully deleted the run task | | [404][] | [JSON API error object][] | Run task not found, or user unauthorized to perform action | ### Sample Request @@ -433,7 +433,7 @@ You may also configure the run task to begin during a specific [run stage](/terr | Status | Response | Reason | | ------- | ------------------------- | ---------------------------------------------------------------------- | -| [204][] | Nothing | The request was successful | +| [204][] | No Content | The request was successful | | [404][] | [JSON API error object][] | Workspace or run task not found or user unauthorized to perform action | | [422][] | [JSON API error object][] | Malformed request body | @@ -744,7 +744,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | -------------------------------------------------------------------- | -| [204][] | Nothing | Successfully deleted the workspace run task | +| [204][] | No Content | Successfully deleted the workspace run task | | [404][] | [JSON API error object][] | Workspace run task not found, or user unauthorized to perform action | ### Sample Request diff --git a/website/docs/cloud-docs/api-docs/run-triggers.mdx b/website/docs/cloud-docs/api-docs/run-triggers.mdx index 09a8bbd80..c6e5a0f22 100644 --- a/website/docs/cloud-docs/api-docs/run-triggers.mdx +++ b/website/docs/cloud-docs/api-docs/run-triggers.mdx @@ -318,7 +318,7 @@ curl \ | Status | Response | Reason | | ------- | ------------------------- | ------------------------------------------------------------ | -| [204][] | Nothing | Successfully deleted the run trigger | +| [204][] | No Content | Successfully deleted the run trigger | | [404][] | [JSON API error object][] | Run trigger not found or user unauthorized to perform action | ### Permissions diff --git a/website/docs/cloud-docs/api-docs/ssh-keys.mdx b/website/docs/cloud-docs/api-docs/ssh-keys.mdx index 5c8e899f8..b28f428b2 100644 --- a/website/docs/cloud-docs/api-docs/ssh-keys.mdx +++ b/website/docs/cloud-docs/api-docs/ssh-keys.mdx @@ -304,7 +304,7 @@ Deleting SSH keys requires permission to manage VCS settings. ([More about permi | Status | Response | Reason | | ------- | ------------------------- | ---------------------------------------- | -| [204][] | Nothing | Success | +| [204][] | No Content | Success | | [404][] | [JSON API error object][] | SSH key not found or user not authorized | ### Sample Request diff --git a/website/docs/cloud-docs/api-docs/workspaces.mdx b/website/docs/cloud-docs/api-docs/workspaces.mdx index f0a03d7ab..fedec1efc 100644 --- a/website/docs/cloud-docs/api-docs/workspaces.mdx +++ b/website/docs/cloud-docs/api-docs/workspaces.mdx @@ -1294,7 +1294,7 @@ You can safe delete a workspace using two endpoints that behave identically. The | Status | Response | Reason(s) | | ------- | --------------------------| --------------------------------------------------------------------- | -| [204][] | Nothing | Successfully deleted the workspace | +| [204][] | No Content | Successfully deleted the workspace | | [404][] | [JSON API error object][] | Workspace not found, or user unauthorized to perform workspace delete | | [409][] | [JSON API error object][] | Workspace is not safe to delete because it is managing resources | @@ -1323,7 +1323,7 @@ You can use two endpoints to force delete a workspace, which behave identically. | Status | Response | Reason(s) | | ------- | --------------------------| --------------------------------------------------------------------- | -| [204][] | Nothing | Successfully deleted the workspace | +| [204][] | No Content | Successfully deleted the workspace | | [403][] | [JSON API error object][] | Not authorized to perform a force delete on the workspace | | [404][] | [JSON API error object][] | Workspace not found, or user unauthorized to perform workspace delete | @@ -2421,7 +2421,7 @@ This endpoint can only be used by teams with permission to manage workspaces for | Status | Response | Reason(s) | | ------- | ------------------------- | --------------------------------------------------------------------- | -| [204][] | Nothing | Successfully updated remote state consumers | +| [204][] | No Content | Successfully updated remote state consumers | | [404][] | [JSON API error object][] | Workspace not found, or user unauthorized to perform action | | [422][] | [JSON API error object][] | Problem with payload or request; details provided in the error object | @@ -2482,7 +2482,7 @@ This endpoint adds one or more remote state consumers to the workspace. It can o | Status | Response | Reason(s) | | ------- | ------------------------- | --------------------------------------------------------------------- | -| [204][] | Nothing | Successfully updated remote state consumers | +| [204][] | No Content | Successfully updated remote state consumers | | [404][] | [JSON API error object][] | Workspace not found, or user unauthorized to perform action | | [422][] | [JSON API error object][] | Problem with payload or request; details provided in the error object | @@ -2542,7 +2542,7 @@ This endpoint removes one or more remote state consumers from a workspace, accor | Status | Response | Reason(s) | | ------- | ------------------------- | --------------------------------------------------------------------- | -| [204][] | Nothing | Successfully updated remote state consumers | +| [204][] | No Content | Successfully updated remote state consumers | | [404][] | [JSON API error object][] | Workspace not found, or user unauthorized to perform action | | [422][] | [JSON API error object][] | Problem with payload or request; details provided in the error object | @@ -2672,7 +2672,7 @@ matching organization tag exists with such name, a new one will be created. | Status | Response | Reason(s) | | ------- | ------------------------- | ----------------------------------------------------------- | -| [204][] | Nothing | Successfully added tags to workspace | +| [204][] | No Content | Successfully added tags to workspace | | [404][] | [JSON API error object][] | Workspace not found, or user unauthorized to perform action | ### Request Body @@ -2740,7 +2740,7 @@ removed from the organization-wide list. | Status | Response | Reason(s) | | ------- | ------------------------- | ----------------------------------------------------------- | -| [204][] | Nothing | Successfully removed tags to workspace | +| [204][] | No Content | Successfully removed tags to workspace | | [404][] | [JSON API error object][] | Workspace not found, or user unauthorized to perform action | ### Request Body