Skip to content

Commit

Permalink
update docs Nothing to No Content for HTTP 204 resp (#409)
Browse files Browse the repository at this point in the history 
update Nothing to No Content for HTTP 204
  • Loading branch information
@laurenolivia
laurenolivia authored Jul 28, 2023
1 parent 667816e commit d22050b
Show file tree
Hide file tree
Showing 14 changed files with 32 additions and 32 deletions.
2 changes: 1 addition & 1 deletion website/docs/cloud-docs/api-docs/agents.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

Expand Down
4 changes: 2 additions & 2 deletions website/docs/cloud-docs/api-docs/organization-tags.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion website/docs/cloud-docs/api-docs/organization-tokens.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion website/docs/cloud-docs/api-docs/policies.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions website/docs/cloud-docs/api-docs/policy-sets.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.) |

Expand Down Expand Up @@ -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.) |

Expand Down Expand Up @@ -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.) |

Expand Down Expand Up @@ -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.) |

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion website/docs/cloud-docs/api-docs/private-registry/modules.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

Expand Down
4 changes: 2 additions & 2 deletions website/docs/cloud-docs/api-docs/private-registry/provider-versions-platforms.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

Expand Down Expand Up @@ -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 |

Expand Down
2 changes: 1 addition & 1 deletion website/docs/cloud-docs/api-docs/private-registry/providers.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

Expand Down
4 changes: 2 additions & 2 deletions website/docs/cloud-docs/api-docs/projects.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

Expand Down Expand Up @@ -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 |

Expand Down
8 changes: 4 additions & 4 deletions website/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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. |

Expand Down
6 changes: 3 additions & 3 deletions website/docs/cloud-docs/api-docs/run-tasks/run-tasks.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 |

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion website/docs/cloud-docs/api-docs/run-triggers.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion website/docs/cloud-docs/api-docs/ssh-keys.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions website/docs/cloud-docs/api-docs/workspaces.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

Expand Down Expand Up @@ -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 |

Expand Down Expand Up @@ -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 |

Expand Down Expand Up @@ -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 |

Expand Down Expand Up @@ -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 |

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

1 comment on commit d22050b

@vercel
Copy link

@vercel vercel bot commented on d22050b Jul 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

terraform-docs-common – ./

terraform-docs-common.vercel.app
terraform-docs-common-hashicorp.vercel.app
terraform-docs-common-git-main-hashicorp.vercel.app

Please sign in to comment.