Skip to content

Update of JSON schema for run task results link #944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+2 −2
Open

Update of JSON schema for run task results link #944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fc6087
Update run-tasks-integration.mdx
yordanivh Sep 15, 2025
05a87e9
Update index.mdx
yordanivh Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...raform-docs-common/docs/cloud-docs/api-docs/run-tasks/run-tasks-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ You can send outcomes with a status of `running`, `passed`, or `failed`, but it

### Request Body

The PATCH request submits a JSON object with the following properties as a request payload. This payload is also described in the [JSON schema for run task results](https://github.com/hashicorp/web-unified-docs/content/terraform-docs-common/public/schema/run-tasks/runtask-result.json).
The PATCH request submits a JSON object with the following properties as a request payload. This payload is also described in the [JSON schema for run task results](https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/public/schema/run-tasks/runtask-result.json).

| Key path | Type | Description |
| ----------------------------- | ------ | --------------------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion content/terraform-docs-common/docs/cloud-docs/integrations/run-tasks/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Here's what the data flow looks like:
![Screenshot: a diagram of the user and data flow for an HCP Terraform run task](/img/docs/terraform-cloud-run-tasks-diagram.png)


Refer to the [run task integration API](/terraform/cloud-docs/api-docs/run-tasks/run-tasks-integration#structured-results) for the exact payload specifications, and the [JSON schema for run task results](https://github.com/hashicorp/web-unified-docs/content/terraform-docs-common/public/schema/run-tasks/runtask-result.json) for code generation and payload validation.
Refer to the [run task integration API](/terraform/cloud-docs/api-docs/run-tasks/run-tasks-integration#structured-results) for the exact payload specifications, and the [JSON schema for run task results](https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-docs-common/public/schema/run-tasks/runtask-result.json) for code generation and payload validation.


## Securing your Run Task
Expand Down
Loading