Created
August 11, 2017 22:17
-
-
Save skierkowski/5ebd6eebf64b58db0c8ad7b217d3ffae to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"swagger" : "2.0", | |
"info" : { | |
"version" : "2.0.0", | |
"title" : "JSON API TFE" | |
}, | |
"basePath" : "/api/v2", | |
"tags" : [ { | |
"name" : "Apply" | |
}, { | |
"name" : "Attribute" | |
}, { | |
"name" : "AttributeDefinition" | |
}, { | |
"name" : "Collaboration" | |
}, { | |
"name" : "ConfigurationVersion" | |
}, { | |
"name" : "IngressAttributes" | |
}, { | |
"name" : "IngressTrigger" | |
}, { | |
"name" : "OAuthClient" | |
}, { | |
"name" : "OAuthToken" | |
}, { | |
"name" : "Organization" | |
}, { | |
"name" : "Plan" | |
}, { | |
"name" : "Run" | |
}, { | |
"name" : "RunEvent" | |
}, { | |
"name" : "SshKey" | |
}, { | |
"name" : "StateVersion" | |
}, { | |
"name" : "Team" | |
}, { | |
"name" : "ToolVersion" | |
}, { | |
"name" : "Var" | |
}, { | |
"name" : "VcsRepo" | |
}, { | |
"name" : "Workspace" | |
}, { | |
"name" : "WorkspaceComment" | |
}, { | |
"name" : "WorkspaceConfigurationVersion" | |
}, { | |
"name" : "WorkspaceRunAlert" | |
} ], | |
"consumes" : [ "application/vnd.api+json" ], | |
"produces" : [ "application/vnd.api+json" ], | |
"paths" : { | |
"/applies" : { | |
"get" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Index all Applies", | |
"operationId" : "indexApplies", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Apply", | |
"attributes" : { | |
"run_id" : 1, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:42:36.425+0000", | |
"updated_at" : "2017-06-30T15:42:36.425+0000", | |
"archivist_upload_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "Apply", | |
"attributes" : { | |
"run_id" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:42:37.096+0000", | |
"updated_at" : "2017-06-30T15:42:37.096+0000", | |
"archivist_upload_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "Apply", | |
"attributes" : { | |
"run_id" : 3, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:42:37.503+0000", | |
"updated_at" : "2017-06-30T15:42:37.503+0000", | |
"archivist_upload_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Create a Apply", | |
"operationId" : "createApply", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Apply", | |
"attributes" : { | |
"run_id" : 1, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:42:36.425+0000", | |
"updated_at" : "2017-06-30T15:42:36.425+0000", | |
"archivist_upload_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/applies/{id}" : { | |
"get" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Fetch a Apply", | |
"operationId" : "getApply", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Apply", | |
"attributes" : { | |
"run_id" : 1, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:42:36.425+0000", | |
"updated_at" : "2017-06-30T15:42:36.425+0000", | |
"archivist_upload_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Delete a Apply", | |
"operationId" : "deleteApply", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Update a Apply", | |
"operationId" : "patchApply", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_1" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Apply", | |
"attributes" : { | |
"run_id" : 1, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:42:36.425+0000", | |
"updated_at" : "2017-06-30T15:42:36.425+0000", | |
"archivist_upload_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/applies/{id}/relationships/run" : { | |
"get" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Fetch Apply-Run relationship", | |
"operationId" : "getApply-Run-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/run", | |
"related" : "/applies/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Patch Apply-Run relationship", | |
"operationId" : "patchApply-Run-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/run", | |
"related" : "/applies/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/applies/{id}/relationships/run-events" : { | |
"get" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Index all Apply-RunEvents relationships", | |
"operationId" : "indexApply-RunEvents-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/run-events", | |
"related" : "/applies/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Add Apply-RunEvents relationships", | |
"operationId" : "postApply-RunEvents-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/run-events", | |
"related" : "/applies/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Delete Apply-RunEvents relationships", | |
"operationId" : "deleteApply-RunEvents-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/run-events", | |
"related" : "/applies/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Patch Apply-RunEvents relationships", | |
"operationId" : "patchApply-RunEvents-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/run-events", | |
"related" : "/applies/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/applies/{id}/relationships/state-versions" : { | |
"get" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Index all Apply-StateVersions relationships", | |
"operationId" : "indexApply-StateVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/state-versions", | |
"related" : "/applies/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Add Apply-StateVersions relationships", | |
"operationId" : "postApply-StateVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/state-versions", | |
"related" : "/applies/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Delete Apply-StateVersions relationships", | |
"operationId" : "deleteApply-StateVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/state-versions", | |
"related" : "/applies/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Patch Apply-StateVersions relationships", | |
"operationId" : "patchApply-StateVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/state-versions", | |
"related" : "/applies/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/applies/{id}/run" : { | |
"get" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Fetch Apply-Run", | |
"operationId" : "getApply-Run", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/applies/{id}/run-events" : { | |
"get" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Index all Apply-RunEvents", | |
"operationId" : "indexApply-RunEvents", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_2" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-a32kyYPZssmyjzPY", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 1, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.220+0000", | |
"updated_at" : "2017-06-30T15:45:37.220+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-hxcbvhUtm72tX2Hg", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 2, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.709+0000", | |
"updated_at" : "2017-06-30T15:45:37.709+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-LqEa2on28ZQAGYv9", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 3, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:38.250+0000", | |
"updated_at" : "2017-06-30T15:45:38.250+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/applies/{id}/state-versions" : { | |
"get" : { | |
"tags" : [ "Apply" ], | |
"summary" : "Index all Apply-StateVersions", | |
"operationId" : "indexApply-StateVersions", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_3" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-G2fHqr9njUzpCtJj", | |
"serial" : 92, | |
"created_by_id" : 1, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 1, | |
"created_at" : "2017-06-30T15:46:09.815+0000", | |
"updated_at" : "2017-06-30T15:46:09.815+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-3NFHTDYk7aQtixha", | |
"serial" : 75, | |
"created_by_id" : 2, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 2, | |
"created_at" : "2017-06-30T15:46:09.991+0000", | |
"updated_at" : "2017-06-30T15:46:09.991+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-Na1RijiwR8BdGvZS", | |
"serial" : 27, | |
"created_by_id" : 3, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 3, | |
"created_at" : "2017-06-30T15:46:10.158+0000", | |
"updated_at" : "2017-06-30T15:46:10.158+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/attribute" : { | |
"get" : { | |
"tags" : [ "Attribute" ], | |
"summary" : "Index all Attributes", | |
"operationId" : "indexAttributes", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_4" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.900+0000", | |
"updated_at" : "2017-06-30T15:43:07.900+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.919+0000", | |
"updated_at" : "2017-06-30T15:43:07.919+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Attribute" ], | |
"summary" : "Create a Attribute", | |
"operationId" : "createAttribute", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_2" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/attribute-definitions" : { | |
"get" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Index all AttributeDefinitions", | |
"operationId" : "indexAttributeDefinitions", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_5" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "AttributeDefinition", | |
"attributes" : { | |
"name" : "SlothSpeed", | |
"external_id" : "attrdef-tQbn7rtU1gtTKxKU", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "AttributeDefinition", | |
"attributes" : { | |
"name" : "SlothSpeed", | |
"external_id" : "attrdef-ubNCjxQyRd5zPAjZ", | |
"organization_id" : 2, | |
"created_at" : "2017-06-30T15:43:07.900+0000", | |
"updated_at" : "2017-06-30T15:43:07.900+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "AttributeDefinition", | |
"attributes" : { | |
"name" : "SlothSpeed", | |
"external_id" : "attrdef-xhkSkTCjW6ucWPwm", | |
"organization_id" : 3, | |
"created_at" : "2017-06-30T15:43:07.919+0000", | |
"updated_at" : "2017-06-30T15:43:07.919+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Create a AttributeDefinition", | |
"operationId" : "createAttributeDefinition", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_3" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_2" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "AttributeDefinition", | |
"attributes" : { | |
"name" : "SlothSpeed", | |
"external_id" : "attrdef-tQbn7rtU1gtTKxKU", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/attribute-definitions/{id}" : { | |
"get" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Fetch a AttributeDefinition", | |
"operationId" : "getAttributeDefinition", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_2" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "AttributeDefinition", | |
"attributes" : { | |
"name" : "SlothSpeed", | |
"external_id" : "attrdef-tQbn7rtU1gtTKxKU", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Delete a AttributeDefinition", | |
"operationId" : "deleteAttributeDefinition", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Update a AttributeDefinition", | |
"operationId" : "patchAttributeDefinition", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_4" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_2" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "AttributeDefinition", | |
"attributes" : { | |
"name" : "SlothSpeed", | |
"external_id" : "attrdef-tQbn7rtU1gtTKxKU", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/attribute-definitions/{id}/attributes" : { | |
"get" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Index all AttributeDefinition-Attributes", | |
"operationId" : "indexAttributeDefinition-Attributes", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_4" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.900+0000", | |
"updated_at" : "2017-06-30T15:43:07.900+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.919+0000", | |
"updated_at" : "2017-06-30T15:43:07.919+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/attribute-definitions/{id}/organization" : { | |
"get" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Fetch AttributeDefinition-Organization", | |
"operationId" : "getAttributeDefinition-Organization", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_6df0476b", | |
"default_user_id" : null, | |
"email" : "organization_8ebe62b4@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.360+0000", | |
"updated_at" : "2017-06-30T15:44:45.388+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-KLmdPaFek7cGpaTx", | |
"v2_opt_in" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/attribute-definitions/{id}/relationships/attributes" : { | |
"get" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Index all AttributeDefinition-Attributes relationships", | |
"operationId" : "indexAttributeDefinition-Attributes-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attribute-definitions/1/relationships/attributes", | |
"related" : "/attribute-definitions/1/attributes" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Attribute" | |
}, { | |
"id" : 2, | |
"type" : "Attribute" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Add AttributeDefinition-Attributes relationships", | |
"operationId" : "postAttributeDefinition-Attributes-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attribute-definitions/1/relationships/attributes", | |
"related" : "/attribute-definitions/1/attributes" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Attribute" | |
}, { | |
"id" : 2, | |
"type" : "Attribute" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Delete AttributeDefinition-Attributes relationships", | |
"operationId" : "deleteAttributeDefinition-Attributes-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attribute-definitions/1/relationships/attributes", | |
"related" : "/attribute-definitions/1/attributes" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Attribute" | |
}, { | |
"id" : 2, | |
"type" : "Attribute" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Patch AttributeDefinition-Attributes relationships", | |
"operationId" : "patchAttributeDefinition-Attributes-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attribute-definitions/1/relationships/attributes", | |
"related" : "/attribute-definitions/1/attributes" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Attribute" | |
}, { | |
"id" : 2, | |
"type" : "Attribute" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/attribute-definitions/{id}/relationships/organization" : { | |
"get" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Fetch AttributeDefinition-Organization relationship", | |
"operationId" : "getAttributeDefinition-Organization-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attribute-definitions/1/relationships/organization", | |
"related" : "/attribute-definitions/1/organization" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Organization" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "AttributeDefinition" ], | |
"summary" : "Patch AttributeDefinition-Organization relationship", | |
"operationId" : "patchAttributeDefinition-Organization-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attribute-definitions/1/relationships/organization", | |
"related" : "/attribute-definitions/1/organization" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Organization" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/attribute/{id}" : { | |
"get" : { | |
"tags" : [ "Attribute" ], | |
"summary" : "Fetch a Attribute", | |
"operationId" : "getAttribute", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Attribute" ], | |
"summary" : "Delete a Attribute", | |
"operationId" : "deleteAttribute", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Attribute" ], | |
"summary" : "Update a Attribute", | |
"operationId" : "patchAttribute", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_5" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/attributes/{id}/attribute-definition" : { | |
"get" : { | |
"tags" : [ "Attribute" ], | |
"summary" : "Fetch Attribute-AttributeDefinition", | |
"operationId" : "getAttribute-AttributeDefinition", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_2" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "AttributeDefinition", | |
"attributes" : { | |
"name" : "SlothSpeed", | |
"external_id" : "attrdef-tQbn7rtU1gtTKxKU", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/attributes/{id}/relationships/attribute-definition" : { | |
"get" : { | |
"tags" : [ "Attribute" ], | |
"summary" : "Fetch Attribute-AttributeDefinition relationship", | |
"operationId" : "getAttribute-AttributeDefinition-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attributes/1/relationships/attribute-definition", | |
"related" : "/attributes/1/attribute-definition" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "AttributeDefinition" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Attribute" ], | |
"summary" : "Patch Attribute-AttributeDefinition relationship", | |
"operationId" : "patchAttribute-AttributeDefinition-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attributes/1/relationships/attribute-definition", | |
"related" : "/attributes/1/attribute-definition" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "AttributeDefinition" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/attributes/{id}/relationships/workspace" : { | |
"get" : { | |
"tags" : [ "Attribute" ], | |
"summary" : "Fetch Attribute-Workspace relationship", | |
"operationId" : "getAttribute-Workspace-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attributes/1/relationships/workspace", | |
"related" : "/attributes/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Attribute" ], | |
"summary" : "Patch Attribute-Workspace relationship", | |
"operationId" : "patchAttribute-Workspace-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attributes/1/relationships/workspace", | |
"related" : "/attributes/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/attributes/{id}/workspace" : { | |
"get" : { | |
"tags" : [ "Attribute" ], | |
"summary" : "Fetch Attribute-Workspace", | |
"operationId" : "getAttribute-Workspace", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/collaborations" : { | |
"get" : { | |
"tags" : [ "Collaboration" ], | |
"summary" : "Index all Collaborations", | |
"operationId" : "indexCollaborations", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_8" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 2, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.725+0000", | |
"updated_at" : "2017-06-30T15:43:25.725+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 4, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.764+0000", | |
"updated_at" : "2017-06-30T15:43:25.764+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 6, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.800+0000", | |
"updated_at" : "2017-06-30T15:43:25.800+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Collaboration" ], | |
"summary" : "Create a Collaboration", | |
"operationId" : "createCollaboration", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_6" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_3" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 2, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.725+0000", | |
"updated_at" : "2017-06-30T15:43:25.725+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/collaborations/{id}" : { | |
"get" : { | |
"tags" : [ "Collaboration" ], | |
"summary" : "Fetch a Collaboration", | |
"operationId" : "getCollaboration", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_3" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 2, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.725+0000", | |
"updated_at" : "2017-06-30T15:43:25.725+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Collaboration" ], | |
"summary" : "Delete a Collaboration", | |
"operationId" : "deleteCollaboration", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Collaboration" ], | |
"summary" : "Update a Collaboration", | |
"operationId" : "patchCollaboration", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_7" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_3" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 2, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.725+0000", | |
"updated_at" : "2017-06-30T15:43:25.725+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/collaborations/{id}/item" : { | |
"get" : { | |
"tags" : [ "Collaboration" ], | |
"summary" : "Fetch Collaboration-Item", | |
"operationId" : "getCollaboration-Item", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/Item200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/collaborations/{id}/relationships/item" : { | |
"get" : { | |
"tags" : [ "Collaboration" ], | |
"summary" : "Fetch Collaboration-Item relationship", | |
"operationId" : "getCollaboration-Item-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/collaborations/1/relationships/item", | |
"related" : "/collaborations/1/item" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Item" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Collaboration" ], | |
"summary" : "Patch Collaboration-Item relationship", | |
"operationId" : "patchCollaboration-Item-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/collaborations/1/relationships/item", | |
"related" : "/collaborations/1/item" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Item" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/collaborations/{id}/relationships/team" : { | |
"get" : { | |
"tags" : [ "Collaboration" ], | |
"summary" : "Fetch Collaboration-Team relationship", | |
"operationId" : "getCollaboration-Team-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/collaborations/1/relationships/team", | |
"related" : "/collaborations/1/team" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Team" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Collaboration" ], | |
"summary" : "Patch Collaboration-Team relationship", | |
"operationId" : "patchCollaboration-Team-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/collaborations/1/relationships/team", | |
"related" : "/collaborations/1/team" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Team" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/collaborations/{id}/team" : { | |
"get" : { | |
"tags" : [ "Collaboration" ], | |
"summary" : "Fetch Collaboration-Team", | |
"operationId" : "getCollaboration-Team", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_9" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 1, | |
"name" : "team_1", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.211+0000", | |
"updated_at" : "2017-06-30T15:46:25.211+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/configuration-versions" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Index all ConfigurationVersions", | |
"operationId" : "indexConfigurationVersions", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_10" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 1, | |
"version" : 1, | |
"created_by" : 1, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.386+0000", | |
"updated_at" : "2017-06-30T15:43:42.386+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 1 | |
} | |
}, { | |
"id" : 1, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 2, | |
"version" : 1, | |
"created_by" : 2, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.675+0000", | |
"updated_at" : "2017-06-30T15:43:42.675+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 2 | |
} | |
}, { | |
"id" : 2, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 3, | |
"version" : 1, | |
"created_by" : 3, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.939+0000", | |
"updated_at" : "2017-06-30T15:43:42.939+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 3 | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Create a ConfigurationVersion", | |
"operationId" : "createConfigurationVersion", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_8" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_4" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 1, | |
"version" : 1, | |
"created_by" : 1, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.386+0000", | |
"updated_at" : "2017-06-30T15:43:42.386+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 1 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Fetch a ConfigurationVersion", | |
"operationId" : "getConfigurationVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_4" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 1, | |
"version" : 1, | |
"created_by" : 1, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.386+0000", | |
"updated_at" : "2017-06-30T15:43:42.386+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 1 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Delete a ConfigurationVersion", | |
"operationId" : "deleteConfigurationVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Update a ConfigurationVersion", | |
"operationId" : "patchConfigurationVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_9" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_4" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 1, | |
"version" : 1, | |
"created_by" : 1, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.386+0000", | |
"updated_at" : "2017-06-30T15:43:42.386+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 1 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}/ingress-attributes" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Fetch ConfigurationVersion-IngressAttributes", | |
"operationId" : "getConfigurationVersion-IngressAttributes", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_11" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressAttributes", | |
"attributes" : { | |
"branch" : "master", | |
"clone_url" : "https://github.com/foobar/atlas.git", | |
"commit_sha" : "aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"commit_url" : "https://github.com/hashicorp/atlas/commit/aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"compare_url" : "https://api.github.com/repos/atlas/testing/compare/{base}...{head}", | |
"is_pull_request" : true, | |
"commit_message" : "add some stuff", | |
"on_default_branch" : false, | |
"path" : "foo/bar", | |
"template_path" : "bar/baz", | |
"pull_request_number" : 12, | |
"pull_request_url" : "https://api.github.com/repos/atlas/testing/pulls/1", | |
"identifier" : "foobar/atlas", | |
"tag" : "0.4", | |
"username" : "larrydavid", | |
"created_by_id" : 2, | |
"vcs_webhook_payload_id" : 1, | |
"ingress_attributable_id" : 1, | |
"ingress_attributable_type" : "Operations::BuildConfigurationVersion", | |
"created_at" : "2017-06-30T15:47:12.745+0000", | |
"updated_at" : "2017-06-30T15:47:12.745+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}/ingress-trigger" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Fetch ConfigurationVersion-IngressTrigger", | |
"operationId" : "getConfigurationVersion-IngressTrigger", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_12" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-PP6uSDXKXEhWQApo", | |
"vcs_repo_id" : 1, | |
"workspace_id" : 1, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.341+0000", | |
"updated_at" : "2017-06-30T15:43:59.341+0000", | |
"ingress_submodules" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}/organization" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Fetch ConfigurationVersion-Organization", | |
"operationId" : "getConfigurationVersion-Organization", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_6df0476b", | |
"default_user_id" : null, | |
"email" : "organization_8ebe62b4@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.360+0000", | |
"updated_at" : "2017-06-30T15:44:45.388+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-KLmdPaFek7cGpaTx", | |
"v2_opt_in" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}/relationships/ingress-attributes" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Fetch ConfigurationVersion-IngressAttributes relationship", | |
"operationId" : "getConfigurationVersion-IngressAttributes-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/ingress-attributes", | |
"related" : "/configuration-versions/1/ingress-attributes" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "IngressAttributes" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Patch ConfigurationVersion-IngressAttributes relationship", | |
"operationId" : "patchConfigurationVersion-IngressAttributes-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/ingress-attributes", | |
"related" : "/configuration-versions/1/ingress-attributes" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "IngressAttributes" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}/relationships/ingress-trigger" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Fetch ConfigurationVersion-IngressTrigger relationship", | |
"operationId" : "getConfigurationVersion-IngressTrigger-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/ingress-trigger", | |
"related" : "/configuration-versions/1/ingress-trigger" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "IngressTrigger" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Patch ConfigurationVersion-IngressTrigger relationship", | |
"operationId" : "patchConfigurationVersion-IngressTrigger-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/ingress-trigger", | |
"related" : "/configuration-versions/1/ingress-trigger" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "IngressTrigger" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}/relationships/organization" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Fetch ConfigurationVersion-Organization relationship", | |
"operationId" : "getConfigurationVersion-Organization-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/organization", | |
"related" : "/configuration-versions/1/organization" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Organization" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Patch ConfigurationVersion-Organization relationship", | |
"operationId" : "patchConfigurationVersion-Organization-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/organization", | |
"related" : "/configuration-versions/1/organization" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Organization" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}/relationships/vcs-repo" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Fetch ConfigurationVersion-VcsRepo relationship", | |
"operationId" : "getConfigurationVersion-VcsRepo-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/vcs-repo", | |
"related" : "/configuration-versions/1/vcs-repo" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "VcsRepo" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Patch ConfigurationVersion-VcsRepo relationship", | |
"operationId" : "patchConfigurationVersion-VcsRepo-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/vcs-repo", | |
"related" : "/configuration-versions/1/vcs-repo" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "VcsRepo" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}/relationships/workspace-configuration-versions" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Index all ConfigurationVersion-WorkspaceConfigurationVersions relationships", | |
"operationId" : "indexConfigurationVersion-WorkspaceConfigurationVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/workspace-configuration-versions", | |
"related" : "/configuration-versions/1/workspace-configuration-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceConfigurationVersion" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceConfigurationVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Add ConfigurationVersion-WorkspaceConfigurationVersions relationships", | |
"operationId" : "postConfigurationVersion-WorkspaceConfigurationVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/workspace-configuration-versions", | |
"related" : "/configuration-versions/1/workspace-configuration-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceConfigurationVersion" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceConfigurationVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Delete ConfigurationVersion-WorkspaceConfigurationVersions relationships", | |
"operationId" : "deleteConfigurationVersion-WorkspaceConfigurationVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/workspace-configuration-versions", | |
"related" : "/configuration-versions/1/workspace-configuration-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceConfigurationVersion" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceConfigurationVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Patch ConfigurationVersion-WorkspaceConfigurationVersions relationships", | |
"operationId" : "patchConfigurationVersion-WorkspaceConfigurationVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/workspace-configuration-versions", | |
"related" : "/configuration-versions/1/workspace-configuration-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceConfigurationVersion" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceConfigurationVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}/relationships/workspaces" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Index all ConfigurationVersion-Workspaces relationships", | |
"operationId" : "indexConfigurationVersion-Workspaces-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/workspaces", | |
"related" : "/configuration-versions/1/workspaces" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Workspace" | |
}, { | |
"id" : 2, | |
"type" : "Workspace" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Add ConfigurationVersion-Workspaces relationships", | |
"operationId" : "postConfigurationVersion-Workspaces-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/workspaces", | |
"related" : "/configuration-versions/1/workspaces" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Workspace" | |
}, { | |
"id" : 2, | |
"type" : "Workspace" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Delete ConfigurationVersion-Workspaces relationships", | |
"operationId" : "deleteConfigurationVersion-Workspaces-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/workspaces", | |
"related" : "/configuration-versions/1/workspaces" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Workspace" | |
}, { | |
"id" : 2, | |
"type" : "Workspace" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Patch ConfigurationVersion-Workspaces relationships", | |
"operationId" : "patchConfigurationVersion-Workspaces-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/workspaces", | |
"related" : "/configuration-versions/1/workspaces" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Workspace" | |
}, { | |
"id" : 2, | |
"type" : "Workspace" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}/vcs-repo" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Fetch ConfigurationVersion-VcsRepo", | |
"operationId" : "getConfigurationVersion-VcsRepo", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}/workspace-configuration-versions" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Index all ConfigurationVersion-WorkspaceConfigurationVersions", | |
"operationId" : "indexConfigurationVersion-WorkspaceConfigurationVersions", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_14" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/configuration-versions/{id}/workspaces" : { | |
"get" : { | |
"tags" : [ "ConfigurationVersion" ], | |
"summary" : "Index all ConfigurationVersion-Workspaces", | |
"operationId" : "indexConfigurationVersion-Workspaces", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_15" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothspace-0d6ab925-2dc9-4373-9d3b-ca859147c6f1", | |
"external_id" : "ws-jPfYBzKbkXf9kUFG", | |
"organization_id" : 2, | |
"created_at" : "2017-06-30T15:47:44.231+0000", | |
"updated_at" : "2017-06-30T15:47:44.231+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.2-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothspace-7ad09d61-36e6-468a-b873-1c06d2f2be38", | |
"external_id" : "ws-9kF4y9q3DZ9bvJtL", | |
"organization_id" : 3, | |
"created_at" : "2017-06-30T15:47:44.262+0000", | |
"updated_at" : "2017-06-30T15:47:44.262+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.3-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/ingress-attributes" : { | |
"get" : { | |
"tags" : [ "IngressAttributes" ], | |
"summary" : "Index all IngressAttributes", | |
"operationId" : "indexIngressAttributes", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_11" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressAttributes", | |
"attributes" : { | |
"branch" : "master", | |
"clone_url" : "https://github.com/foobar/atlas.git", | |
"commit_sha" : "aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"commit_url" : "https://github.com/hashicorp/atlas/commit/aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"compare_url" : "https://api.github.com/repos/atlas/testing/compare/{base}...{head}", | |
"is_pull_request" : true, | |
"commit_message" : "add some stuff", | |
"on_default_branch" : false, | |
"path" : "foo/bar", | |
"template_path" : "bar/baz", | |
"pull_request_number" : 12, | |
"pull_request_url" : "https://api.github.com/repos/atlas/testing/pulls/1", | |
"identifier" : "foobar/atlas", | |
"tag" : "0.4", | |
"username" : "larrydavid", | |
"created_by_id" : 2, | |
"vcs_webhook_payload_id" : 1, | |
"ingress_attributable_id" : 1, | |
"ingress_attributable_type" : "Operations::BuildConfigurationVersion", | |
"created_at" : "2017-06-30T15:47:12.745+0000", | |
"updated_at" : "2017-06-30T15:47:12.745+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "IngressAttributes" ], | |
"summary" : "Create a IngressAttributes", | |
"operationId" : "createIngressAttributes", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_10" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_11" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressAttributes", | |
"attributes" : { | |
"branch" : "master", | |
"clone_url" : "https://github.com/foobar/atlas.git", | |
"commit_sha" : "aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"commit_url" : "https://github.com/hashicorp/atlas/commit/aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"compare_url" : "https://api.github.com/repos/atlas/testing/compare/{base}...{head}", | |
"is_pull_request" : true, | |
"commit_message" : "add some stuff", | |
"on_default_branch" : false, | |
"path" : "foo/bar", | |
"template_path" : "bar/baz", | |
"pull_request_number" : 12, | |
"pull_request_url" : "https://api.github.com/repos/atlas/testing/pulls/1", | |
"identifier" : "foobar/atlas", | |
"tag" : "0.4", | |
"username" : "larrydavid", | |
"created_by_id" : 2, | |
"vcs_webhook_payload_id" : 1, | |
"ingress_attributable_id" : 1, | |
"ingress_attributable_type" : "Operations::BuildConfigurationVersion", | |
"created_at" : "2017-06-30T15:47:12.745+0000", | |
"updated_at" : "2017-06-30T15:47:12.745+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/ingress-attributes/{id}" : { | |
"get" : { | |
"tags" : [ "IngressAttributes" ], | |
"summary" : "Fetch a IngressAttributes", | |
"operationId" : "getIngressAttributes", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_11" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressAttributes", | |
"attributes" : { | |
"branch" : "master", | |
"clone_url" : "https://github.com/foobar/atlas.git", | |
"commit_sha" : "aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"commit_url" : "https://github.com/hashicorp/atlas/commit/aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"compare_url" : "https://api.github.com/repos/atlas/testing/compare/{base}...{head}", | |
"is_pull_request" : true, | |
"commit_message" : "add some stuff", | |
"on_default_branch" : false, | |
"path" : "foo/bar", | |
"template_path" : "bar/baz", | |
"pull_request_number" : 12, | |
"pull_request_url" : "https://api.github.com/repos/atlas/testing/pulls/1", | |
"identifier" : "foobar/atlas", | |
"tag" : "0.4", | |
"username" : "larrydavid", | |
"created_by_id" : 2, | |
"vcs_webhook_payload_id" : 1, | |
"ingress_attributable_id" : 1, | |
"ingress_attributable_type" : "Operations::BuildConfigurationVersion", | |
"created_at" : "2017-06-30T15:47:12.745+0000", | |
"updated_at" : "2017-06-30T15:47:12.745+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "IngressAttributes" ], | |
"summary" : "Delete a IngressAttributes", | |
"operationId" : "deleteIngressAttributes", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "IngressAttributes" ], | |
"summary" : "Update a IngressAttributes", | |
"operationId" : "patchIngressAttributes", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_11" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_11" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressAttributes", | |
"attributes" : { | |
"branch" : "master", | |
"clone_url" : "https://github.com/foobar/atlas.git", | |
"commit_sha" : "aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"commit_url" : "https://github.com/hashicorp/atlas/commit/aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"compare_url" : "https://api.github.com/repos/atlas/testing/compare/{base}...{head}", | |
"is_pull_request" : true, | |
"commit_message" : "add some stuff", | |
"on_default_branch" : false, | |
"path" : "foo/bar", | |
"template_path" : "bar/baz", | |
"pull_request_number" : 12, | |
"pull_request_url" : "https://api.github.com/repos/atlas/testing/pulls/1", | |
"identifier" : "foobar/atlas", | |
"tag" : "0.4", | |
"username" : "larrydavid", | |
"created_by_id" : 2, | |
"vcs_webhook_payload_id" : 1, | |
"ingress_attributable_id" : 1, | |
"ingress_attributable_type" : "Operations::BuildConfigurationVersion", | |
"created_at" : "2017-06-30T15:47:12.745+0000", | |
"updated_at" : "2017-06-30T15:47:12.745+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/ingress-attributes/{id}/ingress-attributable" : { | |
"get" : { | |
"tags" : [ "IngressAttributes" ], | |
"summary" : "Fetch IngressAttributes-IngressAttributable", | |
"operationId" : "getIngressAttributes-IngressAttributable", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/IngressAttributable200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/ingress-attributes/{id}/relationships/ingress-attributable" : { | |
"get" : { | |
"tags" : [ "IngressAttributes" ], | |
"summary" : "Fetch IngressAttributes-IngressAttributable relationship", | |
"operationId" : "getIngressAttributes-IngressAttributable-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/ingress-attributes/1/relationships/ingress-attributable", | |
"related" : "/ingress-attributes/1/ingress-attributable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "IngressAttributable" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "IngressAttributes" ], | |
"summary" : "Patch IngressAttributes-IngressAttributable relationship", | |
"operationId" : "patchIngressAttributes-IngressAttributable-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/ingress-attributes/1/relationships/ingress-attributable", | |
"related" : "/ingress-attributes/1/ingress-attributable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "IngressAttributable" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/ingress-triggers" : { | |
"get" : { | |
"tags" : [ "IngressTrigger" ], | |
"summary" : "Index all IngressTriggers", | |
"operationId" : "indexIngressTriggers", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_16" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-PP6uSDXKXEhWQApo", | |
"vcs_repo_id" : 1, | |
"workspace_id" : 1, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.341+0000", | |
"updated_at" : "2017-06-30T15:43:59.341+0000", | |
"ingress_submodules" : false | |
} | |
}, { | |
"id" : 1, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-C7hMqwcVGHQJcjJf", | |
"vcs_repo_id" : 2, | |
"workspace_id" : 2, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.676+0000", | |
"updated_at" : "2017-06-30T15:43:59.676+0000", | |
"ingress_submodules" : false | |
} | |
}, { | |
"id" : 2, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-yeaVSijweiMGKzKY", | |
"vcs_repo_id" : 3, | |
"workspace_id" : 3, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.877+0000", | |
"updated_at" : "2017-06-30T15:43:59.877+0000", | |
"ingress_submodules" : false | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "IngressTrigger" ], | |
"summary" : "Create a IngressTrigger", | |
"operationId" : "createIngressTrigger", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_12" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_12" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-PP6uSDXKXEhWQApo", | |
"vcs_repo_id" : 1, | |
"workspace_id" : 1, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.341+0000", | |
"updated_at" : "2017-06-30T15:43:59.341+0000", | |
"ingress_submodules" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/ingress-triggers/{id}" : { | |
"get" : { | |
"tags" : [ "IngressTrigger" ], | |
"summary" : "Fetch a IngressTrigger", | |
"operationId" : "getIngressTrigger", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_12" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-PP6uSDXKXEhWQApo", | |
"vcs_repo_id" : 1, | |
"workspace_id" : 1, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.341+0000", | |
"updated_at" : "2017-06-30T15:43:59.341+0000", | |
"ingress_submodules" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "IngressTrigger" ], | |
"summary" : "Delete a IngressTrigger", | |
"operationId" : "deleteIngressTrigger", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "IngressTrigger" ], | |
"summary" : "Update a IngressTrigger", | |
"operationId" : "patchIngressTrigger", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_13" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_12" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-PP6uSDXKXEhWQApo", | |
"vcs_repo_id" : 1, | |
"workspace_id" : 1, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.341+0000", | |
"updated_at" : "2017-06-30T15:43:59.341+0000", | |
"ingress_submodules" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/ingress-triggers/{id}/relationships/vcs-repo" : { | |
"get" : { | |
"tags" : [ "IngressTrigger" ], | |
"summary" : "Fetch IngressTrigger-VcsRepo relationship", | |
"operationId" : "getIngressTrigger-VcsRepo-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/ingress-triggers/1/relationships/vcs-repo", | |
"related" : "/ingress-triggers/1/vcs-repo" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "VcsRepo" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "IngressTrigger" ], | |
"summary" : "Patch IngressTrigger-VcsRepo relationship", | |
"operationId" : "patchIngressTrigger-VcsRepo-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/ingress-triggers/1/relationships/vcs-repo", | |
"related" : "/ingress-triggers/1/vcs-repo" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "VcsRepo" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/ingress-triggers/{id}/relationships/workspace" : { | |
"get" : { | |
"tags" : [ "IngressTrigger" ], | |
"summary" : "Fetch IngressTrigger-Workspace relationship", | |
"operationId" : "getIngressTrigger-Workspace-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/ingress-triggers/1/relationships/workspace", | |
"related" : "/ingress-triggers/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "IngressTrigger" ], | |
"summary" : "Patch IngressTrigger-Workspace relationship", | |
"operationId" : "patchIngressTrigger-Workspace-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/ingress-triggers/1/relationships/workspace", | |
"related" : "/ingress-triggers/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/ingress-triggers/{id}/vcs-repo" : { | |
"get" : { | |
"tags" : [ "IngressTrigger" ], | |
"summary" : "Fetch IngressTrigger-VcsRepo", | |
"operationId" : "getIngressTrigger-VcsRepo", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/ingress-triggers/{id}/workspace" : { | |
"get" : { | |
"tags" : [ "IngressTrigger" ], | |
"summary" : "Fetch IngressTrigger-Workspace", | |
"operationId" : "getIngressTrigger-Workspace", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/o-auth-clients" : { | |
"get" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Index all OAuthClients", | |
"operationId" : "indexOAuthClients", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_17" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Create a OAuthClient", | |
"operationId" : "createOAuthClient", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_14" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_5" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/o-auth-clients/{id}" : { | |
"get" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Fetch a OAuthClient", | |
"operationId" : "getOAuthClient", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_5" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Delete a OAuthClient", | |
"operationId" : "deleteOAuthClient", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Update a OAuthClient", | |
"operationId" : "patchOAuthClient", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_15" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_5" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/o-auth-clients/{id}/o-auth-clientable" : { | |
"get" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Fetch OAuthClient-OAuthClientable", | |
"operationId" : "getOAuthClient-OAuthClientable", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/OAuthClientable200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/o-auth-clients/{id}/o-auth-tokens" : { | |
"get" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Index all OAuthClient-OAuthTokens", | |
"operationId" : "indexOAuthClient-OAuthTokens", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_18" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/o-auth-clients/{id}/relationships/o-auth-clientable" : { | |
"get" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Fetch OAuthClient-OAuthClientable relationship", | |
"operationId" : "getOAuthClient-OAuthClientable-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-clients/1/relationships/o-auth-clientable", | |
"related" : "/o-auth-clients/1/o-auth-clientable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "OAuthClientable" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Patch OAuthClient-OAuthClientable relationship", | |
"operationId" : "patchOAuthClient-OAuthClientable-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-clients/1/relationships/o-auth-clientable", | |
"related" : "/o-auth-clients/1/o-auth-clientable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "OAuthClientable" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/o-auth-clients/{id}/relationships/o-auth-tokens" : { | |
"get" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Index all OAuthClient-OAuthTokens relationships", | |
"operationId" : "indexOAuthClient-OAuthTokens-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-clients/1/relationships/o-auth-tokens", | |
"related" : "/o-auth-clients/1/o-auth-tokens" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthToken" | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Add OAuthClient-OAuthTokens relationships", | |
"operationId" : "postOAuthClient-OAuthTokens-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-clients/1/relationships/o-auth-tokens", | |
"related" : "/o-auth-clients/1/o-auth-tokens" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthToken" | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Delete OAuthClient-OAuthTokens relationships", | |
"operationId" : "deleteOAuthClient-OAuthTokens-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-clients/1/relationships/o-auth-tokens", | |
"related" : "/o-auth-clients/1/o-auth-tokens" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthToken" | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "OAuthClient" ], | |
"summary" : "Patch OAuthClient-OAuthTokens relationships", | |
"operationId" : "patchOAuthClient-OAuthTokens-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-clients/1/relationships/o-auth-tokens", | |
"related" : "/o-auth-clients/1/o-auth-tokens" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthToken" | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/o-auth-tokens" : { | |
"get" : { | |
"tags" : [ "OAuthToken" ], | |
"summary" : "Index all OAuthTokens", | |
"operationId" : "indexOAuthTokens", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_18" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "OAuthToken" ], | |
"summary" : "Create a OAuthToken", | |
"operationId" : "createOAuthToken", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_16" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/o-auth-tokens/{id}" : { | |
"get" : { | |
"tags" : [ "OAuthToken" ], | |
"summary" : "Fetch a OAuthToken", | |
"operationId" : "getOAuthToken", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "OAuthToken" ], | |
"summary" : "Delete a OAuthToken", | |
"operationId" : "deleteOAuthToken", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "OAuthToken" ], | |
"summary" : "Update a OAuthToken", | |
"operationId" : "patchOAuthToken", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_17" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/o-auth-tokens/{id}/o-auth-client" : { | |
"get" : { | |
"tags" : [ "OAuthToken" ], | |
"summary" : "Fetch OAuthToken-OAuthClient", | |
"operationId" : "getOAuthToken-OAuthClient", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_5" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/o-auth-tokens/{id}/o-auth-tokenable" : { | |
"get" : { | |
"tags" : [ "OAuthToken" ], | |
"summary" : "Fetch OAuthToken-OAuthTokenable", | |
"operationId" : "getOAuthToken-OAuthTokenable", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/OAuthTokenable200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/o-auth-tokens/{id}/relationships/o-auth-client" : { | |
"get" : { | |
"tags" : [ "OAuthToken" ], | |
"summary" : "Fetch OAuthToken-OAuthClient relationship", | |
"operationId" : "getOAuthToken-OAuthClient-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-tokens/1/relationships/o-auth-client", | |
"related" : "/o-auth-tokens/1/o-auth-client" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "OAuthClient" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "OAuthToken" ], | |
"summary" : "Patch OAuthToken-OAuthClient relationship", | |
"operationId" : "patchOAuthToken-OAuthClient-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-tokens/1/relationships/o-auth-client", | |
"related" : "/o-auth-tokens/1/o-auth-client" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "OAuthClient" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/o-auth-tokens/{id}/relationships/o-auth-tokenable" : { | |
"get" : { | |
"tags" : [ "OAuthToken" ], | |
"summary" : "Fetch OAuthToken-OAuthTokenable relationship", | |
"operationId" : "getOAuthToken-OAuthTokenable-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-tokens/1/relationships/o-auth-tokenable", | |
"related" : "/o-auth-tokens/1/o-auth-tokenable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "OAuthTokenable" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "OAuthToken" ], | |
"summary" : "Patch OAuthToken-OAuthTokenable relationship", | |
"operationId" : "patchOAuthToken-OAuthTokenable-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-tokens/1/relationships/o-auth-tokenable", | |
"related" : "/o-auth-tokens/1/o-auth-tokenable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "OAuthTokenable" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/organizations" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organizations", | |
"operationId" : "indexOrganizations", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_19" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_6df0476b", | |
"default_user_id" : null, | |
"email" : "organization_8ebe62b4@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.360+0000", | |
"updated_at" : "2017-06-30T15:44:45.388+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-KLmdPaFek7cGpaTx", | |
"v2_opt_in" : false | |
} | |
}, { | |
"id" : 1, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_c2ec75fd", | |
"default_user_id" : null, | |
"email" : "organization_4d946ad5@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.428+0000", | |
"updated_at" : "2017-06-30T15:44:45.435+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-QGh7ULqLHiDh3YjE", | |
"v2_opt_in" : false | |
} | |
}, { | |
"id" : 2, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_66ea7c5b", | |
"default_user_id" : null, | |
"email" : "organization_fb687c8e@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.446+0000", | |
"updated_at" : "2017-06-30T15:44:45.452+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-ov7EiPt8aQgWVX31", | |
"v2_opt_in" : false | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Create a Organization", | |
"operationId" : "createOrganization", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_18" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_6df0476b", | |
"default_user_id" : null, | |
"email" : "organization_8ebe62b4@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.360+0000", | |
"updated_at" : "2017-06-30T15:44:45.388+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-KLmdPaFek7cGpaTx", | |
"v2_opt_in" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Fetch a Organization", | |
"operationId" : "getOrganization", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_6df0476b", | |
"default_user_id" : null, | |
"email" : "organization_8ebe62b4@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.360+0000", | |
"updated_at" : "2017-06-30T15:44:45.388+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-KLmdPaFek7cGpaTx", | |
"v2_opt_in" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Delete a Organization", | |
"operationId" : "deleteOrganization", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Update a Organization", | |
"operationId" : "patchOrganization", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_19" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_6df0476b", | |
"default_user_id" : null, | |
"email" : "organization_8ebe62b4@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.360+0000", | |
"updated_at" : "2017-06-30T15:44:45.388+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-KLmdPaFek7cGpaTx", | |
"v2_opt_in" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/o-auth-clients" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organization-OAuthClients", | |
"operationId" : "indexOrganization-OAuthClients", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_17" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/o-auth-tokens" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organization-OAuthTokens", | |
"operationId" : "indexOrganization-OAuthTokens", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_18" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/relationships/o-auth-clients" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organization-OAuthClients relationships", | |
"operationId" : "indexOrganization-OAuthClients-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/o-auth-clients", | |
"related" : "/organizations/1/o-auth-clients" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthClient" | |
}, { | |
"id" : 2, | |
"type" : "OAuthClient" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Add Organization-OAuthClients relationships", | |
"operationId" : "postOrganization-OAuthClients-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/o-auth-clients", | |
"related" : "/organizations/1/o-auth-clients" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthClient" | |
}, { | |
"id" : 2, | |
"type" : "OAuthClient" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Delete Organization-OAuthClients relationships", | |
"operationId" : "deleteOrganization-OAuthClients-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/o-auth-clients", | |
"related" : "/organizations/1/o-auth-clients" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthClient" | |
}, { | |
"id" : 2, | |
"type" : "OAuthClient" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Patch Organization-OAuthClients relationships", | |
"operationId" : "patchOrganization-OAuthClients-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/o-auth-clients", | |
"related" : "/organizations/1/o-auth-clients" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthClient" | |
}, { | |
"id" : 2, | |
"type" : "OAuthClient" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/relationships/o-auth-tokens" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organization-OAuthTokens relationships", | |
"operationId" : "indexOrganization-OAuthTokens-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/o-auth-tokens", | |
"related" : "/organizations/1/o-auth-tokens" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthToken" | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Add Organization-OAuthTokens relationships", | |
"operationId" : "postOrganization-OAuthTokens-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/o-auth-tokens", | |
"related" : "/organizations/1/o-auth-tokens" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthToken" | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Delete Organization-OAuthTokens relationships", | |
"operationId" : "deleteOrganization-OAuthTokens-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/o-auth-tokens", | |
"related" : "/organizations/1/o-auth-tokens" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthToken" | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Patch Organization-OAuthTokens relationships", | |
"operationId" : "patchOrganization-OAuthTokens-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/o-auth-tokens", | |
"related" : "/organizations/1/o-auth-tokens" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthToken" | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/relationships/ssh-keys" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organization-SshKeys relationships", | |
"operationId" : "indexOrganization-SshKeys-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/ssh-keys", | |
"related" : "/organizations/1/ssh-keys" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "SshKey" | |
}, { | |
"id" : 2, | |
"type" : "SshKey" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Add Organization-SshKeys relationships", | |
"operationId" : "postOrganization-SshKeys-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/ssh-keys", | |
"related" : "/organizations/1/ssh-keys" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "SshKey" | |
}, { | |
"id" : 2, | |
"type" : "SshKey" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Delete Organization-SshKeys relationships", | |
"operationId" : "deleteOrganization-SshKeys-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/ssh-keys", | |
"related" : "/organizations/1/ssh-keys" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "SshKey" | |
}, { | |
"id" : 2, | |
"type" : "SshKey" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Patch Organization-SshKeys relationships", | |
"operationId" : "patchOrganization-SshKeys-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/ssh-keys", | |
"related" : "/organizations/1/ssh-keys" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "SshKey" | |
}, { | |
"id" : 2, | |
"type" : "SshKey" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/relationships/teams" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organization-Teams relationships", | |
"operationId" : "indexOrganization-Teams-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/teams", | |
"related" : "/organizations/1/teams" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Team" | |
}, { | |
"id" : 2, | |
"type" : "Team" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Add Organization-Teams relationships", | |
"operationId" : "postOrganization-Teams-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/teams", | |
"related" : "/organizations/1/teams" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Team" | |
}, { | |
"id" : 2, | |
"type" : "Team" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Delete Organization-Teams relationships", | |
"operationId" : "deleteOrganization-Teams-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/teams", | |
"related" : "/organizations/1/teams" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Team" | |
}, { | |
"id" : 2, | |
"type" : "Team" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Patch Organization-Teams relationships", | |
"operationId" : "patchOrganization-Teams-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/teams", | |
"related" : "/organizations/1/teams" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Team" | |
}, { | |
"id" : 2, | |
"type" : "Team" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/relationships/vars" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organization-Vars relationships", | |
"operationId" : "indexOrganization-Vars-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/vars", | |
"related" : "/organizations/1/vars" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Var" | |
}, { | |
"id" : 2, | |
"type" : "Var" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Add Organization-Vars relationships", | |
"operationId" : "postOrganization-Vars-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/vars", | |
"related" : "/organizations/1/vars" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Var" | |
}, { | |
"id" : 2, | |
"type" : "Var" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Delete Organization-Vars relationships", | |
"operationId" : "deleteOrganization-Vars-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/vars", | |
"related" : "/organizations/1/vars" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Var" | |
}, { | |
"id" : 2, | |
"type" : "Var" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Patch Organization-Vars relationships", | |
"operationId" : "patchOrganization-Vars-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/vars", | |
"related" : "/organizations/1/vars" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Var" | |
}, { | |
"id" : 2, | |
"type" : "Var" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/relationships/workspaces" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organization-Workspaces relationships", | |
"operationId" : "indexOrganization-Workspaces-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/workspaces", | |
"related" : "/organizations/1/workspaces" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Workspace" | |
}, { | |
"id" : 2, | |
"type" : "Workspace" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Add Organization-Workspaces relationships", | |
"operationId" : "postOrganization-Workspaces-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/workspaces", | |
"related" : "/organizations/1/workspaces" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Workspace" | |
}, { | |
"id" : 2, | |
"type" : "Workspace" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Delete Organization-Workspaces relationships", | |
"operationId" : "deleteOrganization-Workspaces-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/workspaces", | |
"related" : "/organizations/1/workspaces" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Workspace" | |
}, { | |
"id" : 2, | |
"type" : "Workspace" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Patch Organization-Workspaces relationships", | |
"operationId" : "patchOrganization-Workspaces-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/workspaces", | |
"related" : "/organizations/1/workspaces" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Workspace" | |
}, { | |
"id" : 2, | |
"type" : "Workspace" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/ssh-keys" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organization-SshKeys", | |
"operationId" : "indexOrganization-SshKeys", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_20" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 1, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.910+0000", | |
"updated_at" : "2017-06-30T15:45:53.910+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 2, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.937+0000", | |
"updated_at" : "2017-06-30T15:45:53.937+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 3, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.963+0000", | |
"updated_at" : "2017-06-30T15:45:53.963+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/teams" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organization-Teams", | |
"operationId" : "indexOrganization-Teams", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_21" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 1, | |
"name" : "team_1", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.211+0000", | |
"updated_at" : "2017-06-30T15:46:25.211+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 2, | |
"name" : "team_2", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.235+0000", | |
"updated_at" : "2017-06-30T15:46:25.235+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 3, | |
"name" : "team_3", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.259+0000", | |
"updated_at" : "2017-06-30T15:46:25.259+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/vars" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organization-Vars", | |
"operationId" : "indexOrganization-Vars", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_22" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "769dab7890db549bfc7c194074bc2107", | |
"value_encrypted" : "r6wQb715eC9oKqG1MLPLlI1XJ52j4HYs3qKMSbVGv/b2Dj1RkAxXPst28TOMSvin", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "packer", | |
"configurable_id" : 1, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.134+0000", | |
"updated_at" : "2017-06-30T15:46:56.134+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "b0e644210599d1b014493eb497394d88", | |
"value_encrypted" : "29p2ifp8aonHVTnvGcBcNigi/rErHip28RVmReAbRXR+1bUcuKUSLNtdDKE55B9v", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "terraform", | |
"configurable_id" : 2, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.176+0000", | |
"updated_at" : "2017-06-30T15:46:56.176+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "4e29784bb2a65ca013684cbbe375e4fe", | |
"value_encrypted" : "qkBSH9uKGkVG92tnS8A9TqevQ0PIGcnS8DWp8K0a3PjI5tvg0a1GwaYlGFBQmkwj", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "packer", | |
"configurable_id" : 3, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.215+0000", | |
"updated_at" : "2017-06-30T15:46:56.215+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/workspaces" : { | |
"get" : { | |
"tags" : [ "Organization" ], | |
"summary" : "Index all Organization-Workspaces", | |
"operationId" : "indexOrganization-Workspaces", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_15" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothspace-0d6ab925-2dc9-4373-9d3b-ca859147c6f1", | |
"external_id" : "ws-jPfYBzKbkXf9kUFG", | |
"organization_id" : 2, | |
"created_at" : "2017-06-30T15:47:44.231+0000", | |
"updated_at" : "2017-06-30T15:47:44.231+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.2-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothspace-7ad09d61-36e6-468a-b873-1c06d2f2be38", | |
"external_id" : "ws-9kF4y9q3DZ9bvJtL", | |
"organization_id" : 3, | |
"created_at" : "2017-06-30T15:47:44.262+0000", | |
"updated_at" : "2017-06-30T15:47:44.262+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.3-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/plans" : { | |
"get" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Index all Plans", | |
"operationId" : "indexPlans", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_23" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Plan", | |
"attributes" : { | |
"run_id" : 1, | |
"has_changes" : true, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:02.035+0000", | |
"updated_at" : "2017-06-30T15:45:02.182+0000", | |
"archivist_upload_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "Plan", | |
"attributes" : { | |
"run_id" : 2, | |
"has_changes" : true, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:02.709+0000", | |
"updated_at" : "2017-06-30T15:45:02.764+0000", | |
"archivist_upload_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "Plan", | |
"attributes" : { | |
"run_id" : 3, | |
"has_changes" : true, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:03.115+0000", | |
"updated_at" : "2017-06-30T15:45:03.169+0000", | |
"archivist_upload_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Create a Plan", | |
"operationId" : "createPlan", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_20" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Plan", | |
"attributes" : { | |
"run_id" : 1, | |
"has_changes" : true, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:02.035+0000", | |
"updated_at" : "2017-06-30T15:45:02.182+0000", | |
"archivist_upload_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/plans/{id}" : { | |
"get" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Fetch a Plan", | |
"operationId" : "getPlan", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Plan", | |
"attributes" : { | |
"run_id" : 1, | |
"has_changes" : true, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:02.035+0000", | |
"updated_at" : "2017-06-30T15:45:02.182+0000", | |
"archivist_upload_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Delete a Plan", | |
"operationId" : "deletePlan", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Update a Plan", | |
"operationId" : "patchPlan", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_21" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Plan", | |
"attributes" : { | |
"run_id" : 1, | |
"has_changes" : true, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:02.035+0000", | |
"updated_at" : "2017-06-30T15:45:02.182+0000", | |
"archivist_upload_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/plans/{id}/configuration-version" : { | |
"get" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Fetch Plan-ConfigurationVersion", | |
"operationId" : "getPlan-ConfigurationVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_4" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 1, | |
"version" : 1, | |
"created_by" : 1, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.386+0000", | |
"updated_at" : "2017-06-30T15:43:42.386+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 1 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/plans/{id}/relationships/configuration-version" : { | |
"get" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Fetch Plan-ConfigurationVersion relationship", | |
"operationId" : "getPlan-ConfigurationVersion-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/configuration-version", | |
"related" : "/plans/1/configuration-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Patch Plan-ConfigurationVersion relationship", | |
"operationId" : "patchPlan-ConfigurationVersion-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/configuration-version", | |
"related" : "/plans/1/configuration-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/plans/{id}/relationships/run" : { | |
"get" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Fetch Plan-Run relationship", | |
"operationId" : "getPlan-Run-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/run", | |
"related" : "/plans/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Patch Plan-Run relationship", | |
"operationId" : "patchPlan-Run-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/run", | |
"related" : "/plans/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/plans/{id}/relationships/run-events" : { | |
"get" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Index all Plan-RunEvents relationships", | |
"operationId" : "indexPlan-RunEvents-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/run-events", | |
"related" : "/plans/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Add Plan-RunEvents relationships", | |
"operationId" : "postPlan-RunEvents-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/run-events", | |
"related" : "/plans/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Delete Plan-RunEvents relationships", | |
"operationId" : "deletePlan-RunEvents-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/run-events", | |
"related" : "/plans/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Patch Plan-RunEvents relationships", | |
"operationId" : "patchPlan-RunEvents-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/run-events", | |
"related" : "/plans/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/plans/{id}/relationships/state-versions" : { | |
"get" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Index all Plan-StateVersions relationships", | |
"operationId" : "indexPlan-StateVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/state-versions", | |
"related" : "/plans/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Add Plan-StateVersions relationships", | |
"operationId" : "postPlan-StateVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/state-versions", | |
"related" : "/plans/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Delete Plan-StateVersions relationships", | |
"operationId" : "deletePlan-StateVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/state-versions", | |
"related" : "/plans/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Patch Plan-StateVersions relationships", | |
"operationId" : "patchPlan-StateVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/state-versions", | |
"related" : "/plans/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/plans/{id}/run" : { | |
"get" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Fetch Plan-Run", | |
"operationId" : "getPlan-Run", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/plans/{id}/run-events" : { | |
"get" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Index all Plan-RunEvents", | |
"operationId" : "indexPlan-RunEvents", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_2" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-a32kyYPZssmyjzPY", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 1, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.220+0000", | |
"updated_at" : "2017-06-30T15:45:37.220+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-hxcbvhUtm72tX2Hg", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 2, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.709+0000", | |
"updated_at" : "2017-06-30T15:45:37.709+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-LqEa2on28ZQAGYv9", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 3, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:38.250+0000", | |
"updated_at" : "2017-06-30T15:45:38.250+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/plans/{id}/state-versions" : { | |
"get" : { | |
"tags" : [ "Plan" ], | |
"summary" : "Index all Plan-StateVersions", | |
"operationId" : "indexPlan-StateVersions", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_3" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-G2fHqr9njUzpCtJj", | |
"serial" : 92, | |
"created_by_id" : 1, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 1, | |
"created_at" : "2017-06-30T15:46:09.815+0000", | |
"updated_at" : "2017-06-30T15:46:09.815+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-3NFHTDYk7aQtixha", | |
"serial" : 75, | |
"created_by_id" : 2, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 2, | |
"created_at" : "2017-06-30T15:46:09.991+0000", | |
"updated_at" : "2017-06-30T15:46:09.991+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-Na1RijiwR8BdGvZS", | |
"serial" : 27, | |
"created_by_id" : 3, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 3, | |
"created_at" : "2017-06-30T15:46:10.158+0000", | |
"updated_at" : "2017-06-30T15:46:10.158+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/run-events" : { | |
"get" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Index all RunEvents", | |
"operationId" : "indexRunEvents", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_2" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-a32kyYPZssmyjzPY", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 1, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.220+0000", | |
"updated_at" : "2017-06-30T15:45:37.220+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-hxcbvhUtm72tX2Hg", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 2, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.709+0000", | |
"updated_at" : "2017-06-30T15:45:37.709+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-LqEa2on28ZQAGYv9", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 3, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:38.250+0000", | |
"updated_at" : "2017-06-30T15:45:38.250+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Create a RunEvent", | |
"operationId" : "createRunEvent", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_22" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_8" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-a32kyYPZssmyjzPY", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 1, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.220+0000", | |
"updated_at" : "2017-06-30T15:45:37.220+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/run-events/{id}" : { | |
"get" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Fetch a RunEvent", | |
"operationId" : "getRunEvent", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_8" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-a32kyYPZssmyjzPY", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 1, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.220+0000", | |
"updated_at" : "2017-06-30T15:45:37.220+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Delete a RunEvent", | |
"operationId" : "deleteRunEvent", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Update a RunEvent", | |
"operationId" : "patchRunEvent", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_23" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_8" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-a32kyYPZssmyjzPY", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 1, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.220+0000", | |
"updated_at" : "2017-06-30T15:45:37.220+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/run-events/{id}/actor" : { | |
"get" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Fetch RunEvent-Actor", | |
"operationId" : "getRunEvent-Actor", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/Actor200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/run-events/{id}/relationships/actor" : { | |
"get" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Fetch RunEvent-Actor relationship", | |
"operationId" : "getRunEvent-Actor-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/run-events/1/relationships/actor", | |
"related" : "/run-events/1/actor" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Actor" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Patch RunEvent-Actor relationship", | |
"operationId" : "patchRunEvent-Actor-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/run-events/1/relationships/actor", | |
"related" : "/run-events/1/actor" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Actor" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/run-events/{id}/relationships/run" : { | |
"get" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Fetch RunEvent-Run relationship", | |
"operationId" : "getRunEvent-Run-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/run-events/1/relationships/run", | |
"related" : "/run-events/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Patch RunEvent-Run relationship", | |
"operationId" : "patchRunEvent-Run-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/run-events/1/relationships/run", | |
"related" : "/run-events/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/run-events/{id}/relationships/target" : { | |
"get" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Fetch RunEvent-Target relationship", | |
"operationId" : "getRunEvent-Target-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/run-events/1/relationships/target", | |
"related" : "/run-events/1/target" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Target" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Patch RunEvent-Target relationship", | |
"operationId" : "patchRunEvent-Target-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/run-events/1/relationships/target", | |
"related" : "/run-events/1/target" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Target" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/run-events/{id}/relationships/workspace-comment" : { | |
"get" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Fetch RunEvent-WorkspaceComment relationship", | |
"operationId" : "getRunEvent-WorkspaceComment-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/run-events/1/relationships/workspace-comment", | |
"related" : "/run-events/1/workspace-comment" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "WorkspaceComment" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Patch RunEvent-WorkspaceComment relationship", | |
"operationId" : "patchRunEvent-WorkspaceComment-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/run-events/1/relationships/workspace-comment", | |
"related" : "/run-events/1/workspace-comment" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "WorkspaceComment" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/run-events/{id}/run" : { | |
"get" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Fetch RunEvent-Run", | |
"operationId" : "getRunEvent-Run", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/run-events/{id}/target" : { | |
"get" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Fetch RunEvent-Target", | |
"operationId" : "getRunEvent-Target", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/Target200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/run-events/{id}/workspace-comment" : { | |
"get" : { | |
"tags" : [ "RunEvent" ], | |
"summary" : "Fetch RunEvent-WorkspaceComment", | |
"operationId" : "getRunEvent-WorkspaceComment", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_24" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 1, | |
"commentable_type" : "Run", | |
"user_id" : 4, | |
"run_event_id" : 2, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:01.125+0000", | |
"updated_at" : "2017-06-30T15:48:01.125+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/runs" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Index all Runs", | |
"operationId" : "indexRuns", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_25" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
}, { | |
"id" : 1, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 2, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 4, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:20.251+0000", | |
"updated_at" : "2017-06-30T15:45:20.280+0000", | |
"error_text" : null, | |
"state_id" : 2, | |
"environment_id" : 6, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.4-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 4 | |
} | |
}, { | |
"id" : 2, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 3, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 6, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:20.646+0000", | |
"updated_at" : "2017-06-30T15:45:20.673+0000", | |
"error_text" : null, | |
"state_id" : 3, | |
"environment_id" : 9, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.6-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 6 | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Run" ], | |
"summary" : "Create a Run", | |
"operationId" : "createRun", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_24" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/runs/{id}" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Fetch a Run", | |
"operationId" : "getRun", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Run" ], | |
"summary" : "Delete a Run", | |
"operationId" : "deleteRun", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Run" ], | |
"summary" : "Update a Run", | |
"operationId" : "patchRun", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_25" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/apply" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Fetch Run-Apply", | |
"operationId" : "getRun-Apply", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Apply", | |
"attributes" : { | |
"run_id" : 1, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:42:36.425+0000", | |
"updated_at" : "2017-06-30T15:42:36.425+0000", | |
"archivist_upload_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/configuration-version" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Fetch Run-ConfigurationVersion", | |
"operationId" : "getRun-ConfigurationVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_4" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 1, | |
"version" : 1, | |
"created_by" : 1, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.386+0000", | |
"updated_at" : "2017-06-30T15:43:42.386+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 1 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/input-state-version" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Fetch Run-InputStateVersion", | |
"operationId" : "getRun-InputStateVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/InputStateVersion200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/plan" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Fetch Run-Plan", | |
"operationId" : "getRun-Plan", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Plan", | |
"attributes" : { | |
"run_id" : 1, | |
"has_changes" : true, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:02.035+0000", | |
"updated_at" : "2017-06-30T15:45:02.182+0000", | |
"archivist_upload_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/relationships/apply" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Fetch Run-Apply relationship", | |
"operationId" : "getRun-Apply-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/apply", | |
"related" : "/runs/1/apply" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Apply" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Run" ], | |
"summary" : "Patch Run-Apply relationship", | |
"operationId" : "patchRun-Apply-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/apply", | |
"related" : "/runs/1/apply" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Apply" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/relationships/configuration-version" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Fetch Run-ConfigurationVersion relationship", | |
"operationId" : "getRun-ConfigurationVersion-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/configuration-version", | |
"related" : "/runs/1/configuration-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Run" ], | |
"summary" : "Patch Run-ConfigurationVersion relationship", | |
"operationId" : "patchRun-ConfigurationVersion-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/configuration-version", | |
"related" : "/runs/1/configuration-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/relationships/input-state-version" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Fetch Run-InputStateVersion relationship", | |
"operationId" : "getRun-InputStateVersion-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/input-state-version", | |
"related" : "/runs/1/input-state-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "InputStateVersion" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Run" ], | |
"summary" : "Patch Run-InputStateVersion relationship", | |
"operationId" : "patchRun-InputStateVersion-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/input-state-version", | |
"related" : "/runs/1/input-state-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "InputStateVersion" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/relationships/plan" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Fetch Run-Plan relationship", | |
"operationId" : "getRun-Plan-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/plan", | |
"related" : "/runs/1/plan" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Plan" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Run" ], | |
"summary" : "Patch Run-Plan relationship", | |
"operationId" : "patchRun-Plan-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/plan", | |
"related" : "/runs/1/plan" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Plan" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/relationships/run-events" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Index all Run-RunEvents relationships", | |
"operationId" : "indexRun-RunEvents-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/run-events", | |
"related" : "/runs/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Run" ], | |
"summary" : "Add Run-RunEvents relationships", | |
"operationId" : "postRun-RunEvents-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/run-events", | |
"related" : "/runs/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Run" ], | |
"summary" : "Delete Run-RunEvents relationships", | |
"operationId" : "deleteRun-RunEvents-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/run-events", | |
"related" : "/runs/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Run" ], | |
"summary" : "Patch Run-RunEvents relationships", | |
"operationId" : "patchRun-RunEvents-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/run-events", | |
"related" : "/runs/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/relationships/state-versions" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Index all Run-StateVersions relationships", | |
"operationId" : "indexRun-StateVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/state-versions", | |
"related" : "/runs/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Run" ], | |
"summary" : "Add Run-StateVersions relationships", | |
"operationId" : "postRun-StateVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/state-versions", | |
"related" : "/runs/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Run" ], | |
"summary" : "Delete Run-StateVersions relationships", | |
"operationId" : "deleteRun-StateVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/state-versions", | |
"related" : "/runs/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Run" ], | |
"summary" : "Patch Run-StateVersions relationships", | |
"operationId" : "patchRun-StateVersions-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/state-versions", | |
"related" : "/runs/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/relationships/workspace" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Fetch Run-Workspace relationship", | |
"operationId" : "getRun-Workspace-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace", | |
"related" : "/runs/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Run" ], | |
"summary" : "Patch Run-Workspace relationship", | |
"operationId" : "patchRun-Workspace-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace", | |
"related" : "/runs/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/relationships/workspace-comments" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Index all Run-WorkspaceComments relationships", | |
"operationId" : "indexRun-WorkspaceComments-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace-comments", | |
"related" : "/runs/1/workspace-comments" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceComment" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceComment" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Run" ], | |
"summary" : "Add Run-WorkspaceComments relationships", | |
"operationId" : "postRun-WorkspaceComments-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace-comments", | |
"related" : "/runs/1/workspace-comments" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceComment" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceComment" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Run" ], | |
"summary" : "Delete Run-WorkspaceComments relationships", | |
"operationId" : "deleteRun-WorkspaceComments-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace-comments", | |
"related" : "/runs/1/workspace-comments" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceComment" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceComment" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Run" ], | |
"summary" : "Patch Run-WorkspaceComments relationships", | |
"operationId" : "patchRun-WorkspaceComments-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace-comments", | |
"related" : "/runs/1/workspace-comments" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceComment" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceComment" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/relationships/workspace-run-alerts" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Index all Run-WorkspaceRunAlerts relationships", | |
"operationId" : "indexRun-WorkspaceRunAlerts-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace-run-alerts", | |
"related" : "/runs/1/workspace-run-alerts" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceRunAlert" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceRunAlert" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Run" ], | |
"summary" : "Add Run-WorkspaceRunAlerts relationships", | |
"operationId" : "postRun-WorkspaceRunAlerts-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace-run-alerts", | |
"related" : "/runs/1/workspace-run-alerts" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceRunAlert" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceRunAlert" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Run" ], | |
"summary" : "Delete Run-WorkspaceRunAlerts relationships", | |
"operationId" : "deleteRun-WorkspaceRunAlerts-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace-run-alerts", | |
"related" : "/runs/1/workspace-run-alerts" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceRunAlert" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceRunAlert" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Run" ], | |
"summary" : "Patch Run-WorkspaceRunAlerts relationships", | |
"operationId" : "patchRun-WorkspaceRunAlerts-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace-run-alerts", | |
"related" : "/runs/1/workspace-run-alerts" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceRunAlert" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceRunAlert" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/run-events" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Index all Run-RunEvents", | |
"operationId" : "indexRun-RunEvents", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_2" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-a32kyYPZssmyjzPY", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 1, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.220+0000", | |
"updated_at" : "2017-06-30T15:45:37.220+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-hxcbvhUtm72tX2Hg", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 2, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.709+0000", | |
"updated_at" : "2017-06-30T15:45:37.709+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-LqEa2on28ZQAGYv9", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 3, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:38.250+0000", | |
"updated_at" : "2017-06-30T15:45:38.250+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/state-versions" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Index all Run-StateVersions", | |
"operationId" : "indexRun-StateVersions", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_3" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-G2fHqr9njUzpCtJj", | |
"serial" : 92, | |
"created_by_id" : 1, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 1, | |
"created_at" : "2017-06-30T15:46:09.815+0000", | |
"updated_at" : "2017-06-30T15:46:09.815+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-3NFHTDYk7aQtixha", | |
"serial" : 75, | |
"created_by_id" : 2, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 2, | |
"created_at" : "2017-06-30T15:46:09.991+0000", | |
"updated_at" : "2017-06-30T15:46:09.991+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-Na1RijiwR8BdGvZS", | |
"serial" : 27, | |
"created_by_id" : 3, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 3, | |
"created_at" : "2017-06-30T15:46:10.158+0000", | |
"updated_at" : "2017-06-30T15:46:10.158+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/workspace" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Fetch Run-Workspace", | |
"operationId" : "getRun-Workspace", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/workspace-comments" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Index all Run-WorkspaceComments", | |
"operationId" : "indexRun-WorkspaceComments", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_26" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 1, | |
"commentable_type" : "Run", | |
"user_id" : 4, | |
"run_event_id" : 2, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:01.125+0000", | |
"updated_at" : "2017-06-30T15:48:01.125+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 2, | |
"commentable_type" : "Run", | |
"user_id" : 8, | |
"run_event_id" : 4, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:01.885+0000", | |
"updated_at" : "2017-06-30T15:48:01.885+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 3, | |
"commentable_type" : "Run", | |
"user_id" : 12, | |
"run_event_id" : 6, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:02.414+0000", | |
"updated_at" : "2017-06-30T15:48:02.414+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/runs/{id}/workspace-run-alerts" : { | |
"get" : { | |
"tags" : [ "Run" ], | |
"summary" : "Index all Run-WorkspaceRunAlerts", | |
"operationId" : "indexRun-WorkspaceRunAlerts", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_27" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 1, | |
"external_id" : "ra-YxPjc6YND7gf4m6x", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:34.277+0000", | |
"updated_at" : "2017-06-30T15:48:34.277+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 2, | |
"external_id" : "ra-3G8bLcCCet96z6wn", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:34.776+0000", | |
"updated_at" : "2017-06-30T15:48:34.776+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 3, | |
"external_id" : "ra-dVJGFp4rEqXe5BSJ", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:35.407+0000", | |
"updated_at" : "2017-06-30T15:48:35.407+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/ssh-keys" : { | |
"get" : { | |
"tags" : [ "SshKey" ], | |
"summary" : "Index all SshKeys", | |
"operationId" : "indexSshKeys", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_20" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 1, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.910+0000", | |
"updated_at" : "2017-06-30T15:45:53.910+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 2, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.937+0000", | |
"updated_at" : "2017-06-30T15:45:53.937+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 3, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.963+0000", | |
"updated_at" : "2017-06-30T15:45:53.963+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "SshKey" ], | |
"summary" : "Create a SshKey", | |
"operationId" : "createSshKey", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_26" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_9" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 1, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.910+0000", | |
"updated_at" : "2017-06-30T15:45:53.910+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/ssh-keys/{id}" : { | |
"get" : { | |
"tags" : [ "SshKey" ], | |
"summary" : "Fetch a SshKey", | |
"operationId" : "getSshKey", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_9" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 1, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.910+0000", | |
"updated_at" : "2017-06-30T15:45:53.910+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "SshKey" ], | |
"summary" : "Delete a SshKey", | |
"operationId" : "deleteSshKey", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "SshKey" ], | |
"summary" : "Update a SshKey", | |
"operationId" : "patchSshKey", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_27" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_9" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 1, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.910+0000", | |
"updated_at" : "2017-06-30T15:45:53.910+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/ssh-keys/{id}/relationships/ssh-keyable" : { | |
"get" : { | |
"tags" : [ "SshKey" ], | |
"summary" : "Fetch SshKey-SshKeyable relationship", | |
"operationId" : "getSshKey-SshKeyable-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/ssh-keys/1/relationships/ssh-keyable", | |
"related" : "/ssh-keys/1/ssh-keyable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "SshKeyable" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "SshKey" ], | |
"summary" : "Patch SshKey-SshKeyable relationship", | |
"operationId" : "patchSshKey-SshKeyable-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/ssh-keys/1/relationships/ssh-keyable", | |
"related" : "/ssh-keys/1/ssh-keyable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "SshKeyable" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/ssh-keys/{id}/ssh-keyable" : { | |
"get" : { | |
"tags" : [ "SshKey" ], | |
"summary" : "Fetch SshKey-SshKeyable", | |
"operationId" : "getSshKey-SshKeyable", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/SshKeyable200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/state-versions" : { | |
"get" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Index all StateVersions", | |
"operationId" : "indexStateVersions", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_3" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-G2fHqr9njUzpCtJj", | |
"serial" : 92, | |
"created_by_id" : 1, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 1, | |
"created_at" : "2017-06-30T15:46:09.815+0000", | |
"updated_at" : "2017-06-30T15:46:09.815+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-3NFHTDYk7aQtixha", | |
"serial" : 75, | |
"created_by_id" : 2, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 2, | |
"created_at" : "2017-06-30T15:46:09.991+0000", | |
"updated_at" : "2017-06-30T15:46:09.991+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-Na1RijiwR8BdGvZS", | |
"serial" : 27, | |
"created_by_id" : 3, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 3, | |
"created_at" : "2017-06-30T15:46:10.158+0000", | |
"updated_at" : "2017-06-30T15:46:10.158+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Create a StateVersion", | |
"operationId" : "createStateVersion", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_28" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_10" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-G2fHqr9njUzpCtJj", | |
"serial" : 92, | |
"created_by_id" : 1, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 1, | |
"created_at" : "2017-06-30T15:46:09.815+0000", | |
"updated_at" : "2017-06-30T15:46:09.815+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/state-versions/{id}" : { | |
"get" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Fetch a StateVersion", | |
"operationId" : "getStateVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_10" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-G2fHqr9njUzpCtJj", | |
"serial" : 92, | |
"created_by_id" : 1, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 1, | |
"created_at" : "2017-06-30T15:46:09.815+0000", | |
"updated_at" : "2017-06-30T15:46:09.815+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Delete a StateVersion", | |
"operationId" : "deleteStateVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Update a StateVersion", | |
"operationId" : "patchStateVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_29" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_10" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-G2fHqr9njUzpCtJj", | |
"serial" : 92, | |
"created_by_id" : 1, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 1, | |
"created_at" : "2017-06-30T15:46:09.815+0000", | |
"updated_at" : "2017-06-30T15:46:09.815+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/state-versions/{id}/operation" : { | |
"get" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Fetch StateVersion-Operation", | |
"operationId" : "getStateVersion-Operation", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/Operation200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/state-versions/{id}/relationships/operation" : { | |
"get" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Fetch StateVersion-Operation relationship", | |
"operationId" : "getStateVersion-Operation-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/state-versions/1/relationships/operation", | |
"related" : "/state-versions/1/operation" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Operation" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Patch StateVersion-Operation relationship", | |
"operationId" : "patchStateVersion-Operation-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/state-versions/1/relationships/operation", | |
"related" : "/state-versions/1/operation" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Operation" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/state-versions/{id}/relationships/run" : { | |
"get" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Fetch StateVersion-Run relationship", | |
"operationId" : "getStateVersion-Run-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/state-versions/1/relationships/run", | |
"related" : "/state-versions/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Patch StateVersion-Run relationship", | |
"operationId" : "patchStateVersion-Run-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/state-versions/1/relationships/run", | |
"related" : "/state-versions/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/state-versions/{id}/relationships/workspace" : { | |
"get" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Fetch StateVersion-Workspace relationship", | |
"operationId" : "getStateVersion-Workspace-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/state-versions/1/relationships/workspace", | |
"related" : "/state-versions/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Patch StateVersion-Workspace relationship", | |
"operationId" : "patchStateVersion-Workspace-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/state-versions/1/relationships/workspace", | |
"related" : "/state-versions/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/state-versions/{id}/run" : { | |
"get" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Fetch StateVersion-Run", | |
"operationId" : "getStateVersion-Run", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/state-versions/{id}/workspace" : { | |
"get" : { | |
"tags" : [ "StateVersion" ], | |
"summary" : "Fetch StateVersion-Workspace", | |
"operationId" : "getStateVersion-Workspace", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/teams" : { | |
"get" : { | |
"tags" : [ "Team" ], | |
"summary" : "Index all Teams", | |
"operationId" : "indexTeams", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_21" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 1, | |
"name" : "team_1", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.211+0000", | |
"updated_at" : "2017-06-30T15:46:25.211+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 2, | |
"name" : "team_2", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.235+0000", | |
"updated_at" : "2017-06-30T15:46:25.235+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 3, | |
"name" : "team_3", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.259+0000", | |
"updated_at" : "2017-06-30T15:46:25.259+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Team" ], | |
"summary" : "Create a Team", | |
"operationId" : "createTeam", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_30" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_9" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 1, | |
"name" : "team_1", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.211+0000", | |
"updated_at" : "2017-06-30T15:46:25.211+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/teams/{id}" : { | |
"get" : { | |
"tags" : [ "Team" ], | |
"summary" : "Fetch a Team", | |
"operationId" : "getTeam", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_9" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 1, | |
"name" : "team_1", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.211+0000", | |
"updated_at" : "2017-06-30T15:46:25.211+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Team" ], | |
"summary" : "Delete a Team", | |
"operationId" : "deleteTeam", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Team" ], | |
"summary" : "Update a Team", | |
"operationId" : "patchTeam", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_31" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_9" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 1, | |
"name" : "team_1", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.211+0000", | |
"updated_at" : "2017-06-30T15:46:25.211+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/teams/{id}/collaborations" : { | |
"get" : { | |
"tags" : [ "Team" ], | |
"summary" : "Index all Team-Collaborations", | |
"operationId" : "indexTeam-Collaborations", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_8" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 2, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.725+0000", | |
"updated_at" : "2017-06-30T15:43:25.725+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 4, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.764+0000", | |
"updated_at" : "2017-06-30T15:43:25.764+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 6, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.800+0000", | |
"updated_at" : "2017-06-30T15:43:25.800+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/teams/{id}/members" : { | |
"get" : { | |
"tags" : [ "Team" ], | |
"summary" : "Index all Team-Members", | |
"operationId" : "indexTeam-Members", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/Members200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/teams/{id}/memberships" : { | |
"get" : { | |
"tags" : [ "Team" ], | |
"summary" : "Index all Team-Memberships", | |
"operationId" : "indexTeam-Memberships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/Memberships200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/teams/{id}/organization" : { | |
"get" : { | |
"tags" : [ "Team" ], | |
"summary" : "Fetch Team-Organization", | |
"operationId" : "getTeam-Organization", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_6df0476b", | |
"default_user_id" : null, | |
"email" : "organization_8ebe62b4@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.360+0000", | |
"updated_at" : "2017-06-30T15:44:45.388+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-KLmdPaFek7cGpaTx", | |
"v2_opt_in" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/teams/{id}/relationships/collaborations" : { | |
"get" : { | |
"tags" : [ "Team" ], | |
"summary" : "Index all Team-Collaborations relationships", | |
"operationId" : "indexTeam-Collaborations-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/collaborations", | |
"related" : "/teams/1/collaborations" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Collaboration" | |
}, { | |
"id" : 2, | |
"type" : "Collaboration" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Team" ], | |
"summary" : "Add Team-Collaborations relationships", | |
"operationId" : "postTeam-Collaborations-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/collaborations", | |
"related" : "/teams/1/collaborations" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Collaboration" | |
}, { | |
"id" : 2, | |
"type" : "Collaboration" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Team" ], | |
"summary" : "Delete Team-Collaborations relationships", | |
"operationId" : "deleteTeam-Collaborations-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/collaborations", | |
"related" : "/teams/1/collaborations" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Collaboration" | |
}, { | |
"id" : 2, | |
"type" : "Collaboration" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Team" ], | |
"summary" : "Patch Team-Collaborations relationships", | |
"operationId" : "patchTeam-Collaborations-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/collaborations", | |
"related" : "/teams/1/collaborations" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Collaboration" | |
}, { | |
"id" : 2, | |
"type" : "Collaboration" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/teams/{id}/relationships/members" : { | |
"get" : { | |
"tags" : [ "Team" ], | |
"summary" : "Index all Team-Members relationships", | |
"operationId" : "indexTeam-Members-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/members", | |
"related" : "/teams/1/members" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Member" | |
}, { | |
"id" : 2, | |
"type" : "Member" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Team" ], | |
"summary" : "Add Team-Members relationships", | |
"operationId" : "postTeam-Members-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/members", | |
"related" : "/teams/1/members" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Member" | |
}, { | |
"id" : 2, | |
"type" : "Member" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Team" ], | |
"summary" : "Delete Team-Members relationships", | |
"operationId" : "deleteTeam-Members-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/members", | |
"related" : "/teams/1/members" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Member" | |
}, { | |
"id" : 2, | |
"type" : "Member" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Team" ], | |
"summary" : "Patch Team-Members relationships", | |
"operationId" : "patchTeam-Members-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/members", | |
"related" : "/teams/1/members" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Member" | |
}, { | |
"id" : 2, | |
"type" : "Member" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/teams/{id}/relationships/memberships" : { | |
"get" : { | |
"tags" : [ "Team" ], | |
"summary" : "Index all Team-Memberships relationships", | |
"operationId" : "indexTeam-Memberships-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/memberships", | |
"related" : "/teams/1/memberships" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Membership" | |
}, { | |
"id" : 2, | |
"type" : "Membership" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Team" ], | |
"summary" : "Add Team-Memberships relationships", | |
"operationId" : "postTeam-Memberships-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/memberships", | |
"related" : "/teams/1/memberships" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Membership" | |
}, { | |
"id" : 2, | |
"type" : "Membership" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Team" ], | |
"summary" : "Delete Team-Memberships relationships", | |
"operationId" : "deleteTeam-Memberships-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/memberships", | |
"related" : "/teams/1/memberships" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Membership" | |
}, { | |
"id" : 2, | |
"type" : "Membership" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Team" ], | |
"summary" : "Patch Team-Memberships relationships", | |
"operationId" : "patchTeam-Memberships-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/memberships", | |
"related" : "/teams/1/memberships" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Membership" | |
}, { | |
"id" : 2, | |
"type" : "Membership" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/teams/{id}/relationships/organization" : { | |
"get" : { | |
"tags" : [ "Team" ], | |
"summary" : "Fetch Team-Organization relationship", | |
"operationId" : "getTeam-Organization-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/organization", | |
"related" : "/teams/1/organization" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Organization" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Team" ], | |
"summary" : "Patch Team-Organization relationship", | |
"operationId" : "patchTeam-Organization-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/organization", | |
"related" : "/teams/1/organization" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Organization" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/tool-versions" : { | |
"get" : { | |
"tags" : [ "ToolVersion" ], | |
"summary" : "Index all ToolVersions", | |
"operationId" : "indexToolVersions", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_28" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "ToolVersion", | |
"attributes" : { | |
"tool" : "terraform", | |
"version" : "0.0.1-factory", | |
"url" : "https://releases.hashicorp.com/terraform/0.6.16/terraform_0.6.16_linux_amd64.zip", | |
"sha" : "e10987bca7ec15301bc2fd152795d51cfc9fdbe6c70c9708e6e2ed81eaa1f082", | |
"official" : false, | |
"enabled" : true, | |
"beta" : false | |
} | |
}, { | |
"id" : 1, | |
"type" : "ToolVersion", | |
"attributes" : { | |
"tool" : "terraform", | |
"version" : "0.0.2-factory", | |
"url" : "https://releases.hashicorp.com/terraform/0.6.16/terraform_0.6.16_linux_amd64.zip", | |
"sha" : "e10987bca7ec15301bc2fd152795d51cfc9fdbe6c70c9708e6e2ed81eaa1f082", | |
"official" : false, | |
"enabled" : true, | |
"beta" : false | |
} | |
}, { | |
"id" : 2, | |
"type" : "ToolVersion", | |
"attributes" : { | |
"tool" : "terraform", | |
"version" : "0.0.3-factory", | |
"url" : "https://releases.hashicorp.com/terraform/0.6.16/terraform_0.6.16_linux_amd64.zip", | |
"sha" : "e10987bca7ec15301bc2fd152795d51cfc9fdbe6c70c9708e6e2ed81eaa1f082", | |
"official" : false, | |
"enabled" : true, | |
"beta" : false | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "ToolVersion" ], | |
"summary" : "Create a ToolVersion", | |
"operationId" : "createToolVersion", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_32" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_11" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ToolVersion", | |
"attributes" : { | |
"tool" : "terraform", | |
"version" : "0.0.1-factory", | |
"url" : "https://releases.hashicorp.com/terraform/0.6.16/terraform_0.6.16_linux_amd64.zip", | |
"sha" : "e10987bca7ec15301bc2fd152795d51cfc9fdbe6c70c9708e6e2ed81eaa1f082", | |
"official" : false, | |
"enabled" : true, | |
"beta" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/tool-versions/{id}" : { | |
"get" : { | |
"tags" : [ "ToolVersion" ], | |
"summary" : "Fetch a ToolVersion", | |
"operationId" : "getToolVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_11" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ToolVersion", | |
"attributes" : { | |
"tool" : "terraform", | |
"version" : "0.0.1-factory", | |
"url" : "https://releases.hashicorp.com/terraform/0.6.16/terraform_0.6.16_linux_amd64.zip", | |
"sha" : "e10987bca7ec15301bc2fd152795d51cfc9fdbe6c70c9708e6e2ed81eaa1f082", | |
"official" : false, | |
"enabled" : true, | |
"beta" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "ToolVersion" ], | |
"summary" : "Delete a ToolVersion", | |
"operationId" : "deleteToolVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "ToolVersion" ], | |
"summary" : "Update a ToolVersion", | |
"operationId" : "patchToolVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_33" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_11" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ToolVersion", | |
"attributes" : { | |
"tool" : "terraform", | |
"version" : "0.0.1-factory", | |
"url" : "https://releases.hashicorp.com/terraform/0.6.16/terraform_0.6.16_linux_amd64.zip", | |
"sha" : "e10987bca7ec15301bc2fd152795d51cfc9fdbe6c70c9708e6e2ed81eaa1f082", | |
"official" : false, | |
"enabled" : true, | |
"beta" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/vars" : { | |
"get" : { | |
"tags" : [ "Var" ], | |
"summary" : "Index all Vars", | |
"operationId" : "indexVars", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_22" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "769dab7890db549bfc7c194074bc2107", | |
"value_encrypted" : "r6wQb715eC9oKqG1MLPLlI1XJ52j4HYs3qKMSbVGv/b2Dj1RkAxXPst28TOMSvin", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "packer", | |
"configurable_id" : 1, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.134+0000", | |
"updated_at" : "2017-06-30T15:46:56.134+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "b0e644210599d1b014493eb497394d88", | |
"value_encrypted" : "29p2ifp8aonHVTnvGcBcNigi/rErHip28RVmReAbRXR+1bUcuKUSLNtdDKE55B9v", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "terraform", | |
"configurable_id" : 2, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.176+0000", | |
"updated_at" : "2017-06-30T15:46:56.176+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "4e29784bb2a65ca013684cbbe375e4fe", | |
"value_encrypted" : "qkBSH9uKGkVG92tnS8A9TqevQ0PIGcnS8DWp8K0a3PjI5tvg0a1GwaYlGFBQmkwj", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "packer", | |
"configurable_id" : 3, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.215+0000", | |
"updated_at" : "2017-06-30T15:46:56.215+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Var" ], | |
"summary" : "Create a Var", | |
"operationId" : "createVar", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_34" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_12" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "769dab7890db549bfc7c194074bc2107", | |
"value_encrypted" : "r6wQb715eC9oKqG1MLPLlI1XJ52j4HYs3qKMSbVGv/b2Dj1RkAxXPst28TOMSvin", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "packer", | |
"configurable_id" : 1, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.134+0000", | |
"updated_at" : "2017-06-30T15:46:56.134+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/vars/{id}" : { | |
"get" : { | |
"tags" : [ "Var" ], | |
"summary" : "Fetch a Var", | |
"operationId" : "getVar", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_12" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "769dab7890db549bfc7c194074bc2107", | |
"value_encrypted" : "r6wQb715eC9oKqG1MLPLlI1XJ52j4HYs3qKMSbVGv/b2Dj1RkAxXPst28TOMSvin", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "packer", | |
"configurable_id" : 1, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.134+0000", | |
"updated_at" : "2017-06-30T15:46:56.134+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Var" ], | |
"summary" : "Delete a Var", | |
"operationId" : "deleteVar", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Var" ], | |
"summary" : "Update a Var", | |
"operationId" : "patchVar", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_35" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_12" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "769dab7890db549bfc7c194074bc2107", | |
"value_encrypted" : "r6wQb715eC9oKqG1MLPLlI1XJ52j4HYs3qKMSbVGv/b2Dj1RkAxXPst28TOMSvin", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "packer", | |
"configurable_id" : 1, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.134+0000", | |
"updated_at" : "2017-06-30T15:46:56.134+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/vars/{id}/configurable" : { | |
"get" : { | |
"tags" : [ "Var" ], | |
"summary" : "Fetch Var-Configurable", | |
"operationId" : "getVar-Configurable", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/Configurable200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/vars/{id}/relationships/configurable" : { | |
"get" : { | |
"tags" : [ "Var" ], | |
"summary" : "Fetch Var-Configurable relationship", | |
"operationId" : "getVar-Configurable-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vars/1/relationships/configurable", | |
"related" : "/vars/1/configurable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Configurable" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Var" ], | |
"summary" : "Patch Var-Configurable relationship", | |
"operationId" : "patchVar-Configurable-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vars/1/relationships/configurable", | |
"related" : "/vars/1/configurable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Configurable" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/vars/{id}/relationships/user" : { | |
"get" : { | |
"tags" : [ "Var" ], | |
"summary" : "Fetch Var-User relationship", | |
"operationId" : "getVar-User-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vars/1/relationships/user", | |
"related" : "/vars/1/user" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "User" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Var" ], | |
"summary" : "Patch Var-User relationship", | |
"operationId" : "patchVar-User-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vars/1/relationships/user", | |
"related" : "/vars/1/user" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "User" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/vars/{id}/user" : { | |
"get" : { | |
"tags" : [ "Var" ], | |
"summary" : "Fetch Var-User", | |
"operationId" : "getVar-User", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/User200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/vcs-repos" : { | |
"get" : { | |
"tags" : [ "VcsRepo" ], | |
"summary" : "Index all VcsRepos", | |
"operationId" : "indexVcsRepos", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_29" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "VcsRepo" ], | |
"summary" : "Create a VcsRepo", | |
"operationId" : "createVcsRepo", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_36" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/vcs-repos/{id}" : { | |
"get" : { | |
"tags" : [ "VcsRepo" ], | |
"summary" : "Fetch a VcsRepo", | |
"operationId" : "getVcsRepo", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "VcsRepo" ], | |
"summary" : "Delete a VcsRepo", | |
"operationId" : "deleteVcsRepo", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "VcsRepo" ], | |
"summary" : "Update a VcsRepo", | |
"operationId" : "patchVcsRepo", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_37" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/vcs/repos/{id}/ingress-triggers" : { | |
"get" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Index all Vcs::Repo-IngressTriggers", | |
"operationId" : "indexVcs::Repo-IngressTriggers", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_16" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-PP6uSDXKXEhWQApo", | |
"vcs_repo_id" : 1, | |
"workspace_id" : 1, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.341+0000", | |
"updated_at" : "2017-06-30T15:43:59.341+0000", | |
"ingress_submodules" : false | |
} | |
}, { | |
"id" : 1, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-C7hMqwcVGHQJcjJf", | |
"vcs_repo_id" : 2, | |
"workspace_id" : 2, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.676+0000", | |
"updated_at" : "2017-06-30T15:43:59.676+0000", | |
"ingress_submodules" : false | |
} | |
}, { | |
"id" : 2, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-yeaVSijweiMGKzKY", | |
"vcs_repo_id" : 3, | |
"workspace_id" : 3, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.877+0000", | |
"updated_at" : "2017-06-30T15:43:59.877+0000", | |
"ingress_submodules" : false | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/vcs/repos/{id}/o-auth-token" : { | |
"get" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Fetch Vcs::Repo-OAuthToken", | |
"operationId" : "getVcs::Repo-OAuthToken", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/vcs/repos/{id}/organization" : { | |
"get" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Fetch Vcs::Repo-Organization", | |
"operationId" : "getVcs::Repo-Organization", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_6df0476b", | |
"default_user_id" : null, | |
"email" : "organization_8ebe62b4@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.360+0000", | |
"updated_at" : "2017-06-30T15:44:45.388+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-KLmdPaFek7cGpaTx", | |
"v2_opt_in" : false | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/vcs/repos/{id}/relationships/ingress-triggers" : { | |
"get" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Index all Vcs::Repo-IngressTriggers relationships", | |
"operationId" : "indexVcs::Repo-IngressTriggers-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/ingress-triggers", | |
"related" : "/vcs/repos/1/ingress-triggers" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "IngressTrigger" | |
}, { | |
"id" : 2, | |
"type" : "IngressTrigger" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Add Vcs::Repo-IngressTriggers relationships", | |
"operationId" : "postVcs::Repo-IngressTriggers-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/ingress-triggers", | |
"related" : "/vcs/repos/1/ingress-triggers" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "IngressTrigger" | |
}, { | |
"id" : 2, | |
"type" : "IngressTrigger" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Delete Vcs::Repo-IngressTriggers relationships", | |
"operationId" : "deleteVcs::Repo-IngressTriggers-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/ingress-triggers", | |
"related" : "/vcs/repos/1/ingress-triggers" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "IngressTrigger" | |
}, { | |
"id" : 2, | |
"type" : "IngressTrigger" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Patch Vcs::Repo-IngressTriggers relationships", | |
"operationId" : "patchVcs::Repo-IngressTriggers-relationships", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/ingress-triggers", | |
"related" : "/vcs/repos/1/ingress-triggers" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "IngressTrigger" | |
}, { | |
"id" : 2, | |
"type" : "IngressTrigger" | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/vcs/repos/{id}/relationships/o-auth-token" : { | |
"get" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Fetch Vcs::Repo-OAuthToken relationship", | |
"operationId" : "getVcs::Repo-OAuthToken-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/o-auth-token", | |
"related" : "/vcs/repos/1/o-auth-token" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "OAuthToken" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Patch Vcs::Repo-OAuthToken relationship", | |
"operationId" : "patchVcs::Repo-OAuthToken-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/o-auth-token", | |
"related" : "/vcs/repos/1/o-auth-token" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "OAuthToken" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/vcs/repos/{id}/relationships/organization" : { | |
"get" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Fetch Vcs::Repo-Organization relationship", | |
"operationId" : "getVcs::Repo-Organization-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/organization", | |
"related" : "/vcs/repos/1/organization" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Organization" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Patch Vcs::Repo-Organization relationship", | |
"operationId" : "patchVcs::Repo-Organization-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/organization", | |
"related" : "/vcs/repos/1/organization" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Organization" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/vcs/repos/{id}/relationships/ssh-key" : { | |
"get" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Fetch Vcs::Repo-SshKey relationship", | |
"operationId" : "getVcs::Repo-SshKey-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/ssh-key", | |
"related" : "/vcs/repos/1/ssh-key" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "SshKey" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Patch Vcs::Repo-SshKey relationship", | |
"operationId" : "patchVcs::Repo-SshKey-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/ssh-key", | |
"related" : "/vcs/repos/1/ssh-key" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "SshKey" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/vcs/repos/{id}/ssh-key" : { | |
"get" : { | |
"tags" : [ "Vcs::Repo" ], | |
"summary" : "Fetch Vcs::Repo-SshKey", | |
"operationId" : "getVcs::Repo-SshKey", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_9" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 1, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.910+0000", | |
"updated_at" : "2017-06-30T15:45:53.910+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/workspace-comments" : { | |
"get" : { | |
"tags" : [ "WorkspaceComment" ], | |
"summary" : "Index all WorkspaceComments", | |
"operationId" : "indexWorkspaceComments", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_26" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 1, | |
"commentable_type" : "Run", | |
"user_id" : 4, | |
"run_event_id" : 2, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:01.125+0000", | |
"updated_at" : "2017-06-30T15:48:01.125+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 2, | |
"commentable_type" : "Run", | |
"user_id" : 8, | |
"run_event_id" : 4, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:01.885+0000", | |
"updated_at" : "2017-06-30T15:48:01.885+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 3, | |
"commentable_type" : "Run", | |
"user_id" : 12, | |
"run_event_id" : 6, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:02.414+0000", | |
"updated_at" : "2017-06-30T15:48:02.414+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "WorkspaceComment" ], | |
"summary" : "Create a WorkspaceComment", | |
"operationId" : "createWorkspaceComment", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_38" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_24" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 1, | |
"commentable_type" : "Run", | |
"user_id" : 4, | |
"run_event_id" : 2, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:01.125+0000", | |
"updated_at" : "2017-06-30T15:48:01.125+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspace-comments/{id}" : { | |
"get" : { | |
"tags" : [ "WorkspaceComment" ], | |
"summary" : "Fetch a WorkspaceComment", | |
"operationId" : "getWorkspaceComment", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_24" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 1, | |
"commentable_type" : "Run", | |
"user_id" : 4, | |
"run_event_id" : 2, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:01.125+0000", | |
"updated_at" : "2017-06-30T15:48:01.125+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "WorkspaceComment" ], | |
"summary" : "Delete a WorkspaceComment", | |
"operationId" : "deleteWorkspaceComment", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "WorkspaceComment" ], | |
"summary" : "Update a WorkspaceComment", | |
"operationId" : "patchWorkspaceComment", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_39" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_24" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 1, | |
"commentable_type" : "Run", | |
"user_id" : 4, | |
"run_event_id" : 2, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:01.125+0000", | |
"updated_at" : "2017-06-30T15:48:01.125+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspace-comments/{id}/commentable" : { | |
"get" : { | |
"tags" : [ "WorkspaceComment" ], | |
"summary" : "Fetch WorkspaceComment-Commentable", | |
"operationId" : "getWorkspaceComment-Commentable", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"$ref" : "#/responses/Commentable200" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/workspace-comments/{id}/relationships/commentable" : { | |
"get" : { | |
"tags" : [ "WorkspaceComment" ], | |
"summary" : "Fetch WorkspaceComment-Commentable relationship", | |
"operationId" : "getWorkspaceComment-Commentable-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-comments/1/relationships/commentable", | |
"related" : "/workspace-comments/1/commentable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Commentable" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "WorkspaceComment" ], | |
"summary" : "Patch WorkspaceComment-Commentable relationship", | |
"operationId" : "patchWorkspaceComment-Commentable-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-comments/1/relationships/commentable", | |
"related" : "/workspace-comments/1/commentable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Commentable" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspace-comments/{id}/relationships/run-event" : { | |
"get" : { | |
"tags" : [ "WorkspaceComment" ], | |
"summary" : "Fetch WorkspaceComment-RunEvent relationship", | |
"operationId" : "getWorkspaceComment-RunEvent-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-comments/1/relationships/run-event", | |
"related" : "/workspace-comments/1/run-event" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "RunEvent" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "WorkspaceComment" ], | |
"summary" : "Patch WorkspaceComment-RunEvent relationship", | |
"operationId" : "patchWorkspaceComment-RunEvent-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-comments/1/relationships/run-event", | |
"related" : "/workspace-comments/1/run-event" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "RunEvent" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspace-comments/{id}/run-event" : { | |
"get" : { | |
"tags" : [ "WorkspaceComment" ], | |
"summary" : "Fetch WorkspaceComment-RunEvent", | |
"operationId" : "getWorkspaceComment-RunEvent", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_8" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-a32kyYPZssmyjzPY", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 1, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.220+0000", | |
"updated_at" : "2017-06-30T15:45:37.220+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/workspace-configuration-versions" : { | |
"get" : { | |
"tags" : [ "WorkspaceConfigurationVersion" ], | |
"summary" : "Index all WorkspaceConfigurationVersions", | |
"operationId" : "indexWorkspaceConfigurationVersions", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_14" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "WorkspaceConfigurationVersion" ], | |
"summary" : "Create a WorkspaceConfigurationVersion", | |
"operationId" : "createWorkspaceConfigurationVersion", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_40" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspace-configuration-versions/{id}" : { | |
"get" : { | |
"tags" : [ "WorkspaceConfigurationVersion" ], | |
"summary" : "Fetch a WorkspaceConfigurationVersion", | |
"operationId" : "getWorkspaceConfigurationVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "WorkspaceConfigurationVersion" ], | |
"summary" : "Delete a WorkspaceConfigurationVersion", | |
"operationId" : "deleteWorkspaceConfigurationVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "WorkspaceConfigurationVersion" ], | |
"summary" : "Update a WorkspaceConfigurationVersion", | |
"operationId" : "patchWorkspaceConfigurationVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_41" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspace-configuration-versions/{id}/configuration-version" : { | |
"get" : { | |
"tags" : [ "WorkspaceConfigurationVersion" ], | |
"summary" : "Fetch WorkspaceConfigurationVersion-ConfigurationVersion", | |
"operationId" : "getWorkspaceConfigurationVersion-ConfigurationVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_4" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 1, | |
"version" : 1, | |
"created_by" : 1, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.386+0000", | |
"updated_at" : "2017-06-30T15:43:42.386+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 1 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/workspace-configuration-versions/{id}/relationships/configuration-version" : { | |
"get" : { | |
"tags" : [ "WorkspaceConfigurationVersion" ], | |
"summary" : "Fetch WorkspaceConfigurationVersion-ConfigurationVersion relationship", | |
"operationId" : "getWorkspaceConfigurationVersion-ConfigurationVersion-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-configuration-versions/1/relationships/configuration-version", | |
"related" : "/workspace-configuration-versions/1/configuration-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "WorkspaceConfigurationVersion" ], | |
"summary" : "Patch WorkspaceConfigurationVersion-ConfigurationVersion relationship", | |
"operationId" : "patchWorkspaceConfigurationVersion-ConfigurationVersion-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-configuration-versions/1/relationships/configuration-version", | |
"related" : "/workspace-configuration-versions/1/configuration-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspace-configuration-versions/{id}/relationships/workspace" : { | |
"get" : { | |
"tags" : [ "WorkspaceConfigurationVersion" ], | |
"summary" : "Fetch WorkspaceConfigurationVersion-Workspace relationship", | |
"operationId" : "getWorkspaceConfigurationVersion-Workspace-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-configuration-versions/1/relationships/workspace", | |
"related" : "/workspace-configuration-versions/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "WorkspaceConfigurationVersion" ], | |
"summary" : "Patch WorkspaceConfigurationVersion-Workspace relationship", | |
"operationId" : "patchWorkspaceConfigurationVersion-Workspace-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-configuration-versions/1/relationships/workspace", | |
"related" : "/workspace-configuration-versions/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspace-configuration-versions/{id}/workspace" : { | |
"get" : { | |
"tags" : [ "WorkspaceConfigurationVersion" ], | |
"summary" : "Fetch WorkspaceConfigurationVersion-Workspace", | |
"operationId" : "getWorkspaceConfigurationVersion-Workspace", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/workspace-run-alerts" : { | |
"get" : { | |
"tags" : [ "WorkspaceRunAlert" ], | |
"summary" : "Index all WorkspaceRunAlerts", | |
"operationId" : "indexWorkspaceRunAlerts", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_27" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 1, | |
"external_id" : "ra-YxPjc6YND7gf4m6x", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:34.277+0000", | |
"updated_at" : "2017-06-30T15:48:34.277+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 2, | |
"external_id" : "ra-3G8bLcCCet96z6wn", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:34.776+0000", | |
"updated_at" : "2017-06-30T15:48:34.776+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 3, | |
"external_id" : "ra-dVJGFp4rEqXe5BSJ", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:35.407+0000", | |
"updated_at" : "2017-06-30T15:48:35.407+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "WorkspaceRunAlert" ], | |
"summary" : "Create a WorkspaceRunAlert", | |
"operationId" : "createWorkspaceRunAlert", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_42" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_14" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 1, | |
"external_id" : "ra-YxPjc6YND7gf4m6x", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:34.277+0000", | |
"updated_at" : "2017-06-30T15:48:34.277+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspace-run-alerts/{id}" : { | |
"get" : { | |
"tags" : [ "WorkspaceRunAlert" ], | |
"summary" : "Fetch a WorkspaceRunAlert", | |
"operationId" : "getWorkspaceRunAlert", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_14" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 1, | |
"external_id" : "ra-YxPjc6YND7gf4m6x", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:34.277+0000", | |
"updated_at" : "2017-06-30T15:48:34.277+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "WorkspaceRunAlert" ], | |
"summary" : "Delete a WorkspaceRunAlert", | |
"operationId" : "deleteWorkspaceRunAlert", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "WorkspaceRunAlert" ], | |
"summary" : "Update a WorkspaceRunAlert", | |
"operationId" : "patchWorkspaceRunAlert", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_43" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_14" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 1, | |
"external_id" : "ra-YxPjc6YND7gf4m6x", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:34.277+0000", | |
"updated_at" : "2017-06-30T15:48:34.277+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspace-run-alerts/{id}/relationships/run" : { | |
"get" : { | |
"tags" : [ "WorkspaceRunAlert" ], | |
"summary" : "Fetch WorkspaceRunAlert-Run relationship", | |
"operationId" : "getWorkspaceRunAlert-Run-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-run-alerts/1/relationships/run", | |
"related" : "/workspace-run-alerts/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "WorkspaceRunAlert" ], | |
"summary" : "Patch WorkspaceRunAlert-Run relationship", | |
"operationId" : "patchWorkspaceRunAlert-Run-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-run-alerts/1/relationships/run", | |
"related" : "/workspace-run-alerts/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspace-run-alerts/{id}/run" : { | |
"get" : { | |
"tags" : [ "WorkspaceRunAlert" ], | |
"summary" : "Fetch WorkspaceRunAlert-Run", | |
"operationId" : "getWorkspaceRunAlert-Run", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/workspaces" : { | |
"get" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Index all Workspaces", | |
"operationId" : "indexWorkspaces", | |
"parameters" : [ ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_15" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 1, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothzone", | |
"external_id" : "ws-jPfYBzKbkXf9kUFG", | |
"organization_id" : 2, | |
"created_at" : "2017-06-30T15:47:44.231+0000", | |
"updated_at" : "2017-06-30T15:47:44.231+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.2-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
}, { | |
"id" : 3, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothspace", | |
"external_id" : "ws-9kF4y9q3DZ9bvJtL", | |
"organization_id" : 3, | |
"created_at" : "2017-06-30T15:47:44.262+0000", | |
"updated_at" : "2017-06-30T15:47:44.262+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.3-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
} | |
} | |
}, | |
"post" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Create a Workspace", | |
"operationId" : "createWorkspace", | |
"parameters" : [ { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_44" | |
} | |
} ], | |
"responses" : { | |
"201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspaces/{id}" : { | |
"get" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Fetch a Workspace", | |
"operationId" : "getWorkspace", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"delete" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Delete a Workspace", | |
"operationId" : "deleteWorkspace", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"204" : { | |
"description" : "No Content" | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Update a Workspace", | |
"operationId" : "patchWorkspace", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_45" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspaces/{id}/configuration-version" : { | |
"get" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Fetch Workspace-ConfigurationVersion", | |
"operationId" : "getWorkspace-ConfigurationVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_4" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 1, | |
"version" : 1, | |
"created_by" : 1, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.386+0000", | |
"updated_at" : "2017-06-30T15:43:42.386+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 1 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/workspaces/{id}/relationships/configuration-version" : { | |
"get" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Fetch Workspace-ConfigurationVersion relationship", | |
"operationId" : "getWorkspace-ConfigurationVersion-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/configuration-version", | |
"related" : "/workspaces/1/configuration-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Patch Workspace-ConfigurationVersion relationship", | |
"operationId" : "patchWorkspace-ConfigurationVersion-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/configuration-version", | |
"related" : "/workspaces/1/configuration-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspaces/{id}/relationships/run" : { | |
"get" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Fetch Workspace-Run relationship", | |
"operationId" : "getWorkspace-Run-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/run", | |
"related" : "/workspaces/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Patch Workspace-Run relationship", | |
"operationId" : "patchWorkspace-Run-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/run", | |
"related" : "/workspaces/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspaces/{id}/relationships/state-version" : { | |
"get" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Fetch Workspace-StateVersion relationship", | |
"operationId" : "getWorkspace-StateVersion-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/state-version", | |
"related" : "/workspaces/1/state-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "StateVersion" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Patch Workspace-StateVersion relationship", | |
"operationId" : "patchWorkspace-StateVersion-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/state-version", | |
"related" : "/workspaces/1/state-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "StateVersion" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspaces/{id}/relationships/var" : { | |
"get" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Fetch Workspace-Var relationship", | |
"operationId" : "getWorkspace-Var-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/var", | |
"related" : "/workspaces/1/var" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Var" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Patch Workspace-Var relationship", | |
"operationId" : "patchWorkspace-Var-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/var", | |
"related" : "/workspaces/1/var" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Var" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspaces/{id}/relationships/vcs-repo" : { | |
"get" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Fetch Workspace-VcsRepo relationship", | |
"operationId" : "getWorkspace-VcsRepo-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/vcs-repo", | |
"related" : "/workspaces/1/vcs-repo" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "VcsRepo" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
}, | |
"patch" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Patch Workspace-VcsRepo relationship", | |
"operationId" : "patchWorkspace-VcsRepo-relationship", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
}, { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/vcs-repo", | |
"related" : "/workspaces/1/vcs-repo" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "VcsRepo" | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
}, | |
"409" : { | |
"description" : "Conflict" | |
} | |
} | |
} | |
}, | |
"/workspaces/{id}/run" : { | |
"get" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Fetch Workspace-Run", | |
"operationId" : "getWorkspace-Run", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/workspaces/{id}/state-version" : { | |
"get" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Fetch Workspace-StateVersion", | |
"operationId" : "getWorkspace-StateVersion", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_10" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-G2fHqr9njUzpCtJj", | |
"serial" : 92, | |
"created_by_id" : 1, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 1, | |
"created_at" : "2017-06-30T15:46:09.815+0000", | |
"updated_at" : "2017-06-30T15:46:09.815+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/workspaces/{id}/var" : { | |
"get" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Fetch Workspace-Var", | |
"operationId" : "getWorkspace-Var", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_12" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "769dab7890db549bfc7c194074bc2107", | |
"value_encrypted" : "r6wQb715eC9oKqG1MLPLlI1XJ52j4HYs3qKMSbVGv/b2Dj1RkAxXPst28TOMSvin", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "packer", | |
"configurable_id" : 1, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.134+0000", | |
"updated_at" : "2017-06-30T15:46:56.134+0000" | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
}, | |
"/workspaces/{id}/vcs-repo" : { | |
"get" : { | |
"tags" : [ "Workspace" ], | |
"summary" : "Fetch Workspace-VcsRepo", | |
"operationId" : "getWorkspace-VcsRepo", | |
"parameters" : [ { | |
"name" : "id", | |
"in" : "path", | |
"required" : true, | |
"type" : "integer" | |
} ], | |
"responses" : { | |
"200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"401" : { | |
"description" : "Unauthorized" | |
}, | |
"403" : { | |
"description" : "Forbidden" | |
}, | |
"404" : { | |
"description" : "Not Found" | |
} | |
} | |
} | |
} | |
}, | |
"definitions" : { | |
"Apply" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/Apply_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/Apply_relationships" | |
} | |
} | |
}, | |
"Attribute" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/Attribute_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/Attribute_relationships" | |
} | |
} | |
}, | |
"AttributeDefinition" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/AttributeDefinition_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/AttributeDefinition_relationships" | |
} | |
} | |
}, | |
"Collaboration" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/Collaboration_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/Collaboration_relationships" | |
} | |
} | |
}, | |
"ConfigurationVersion" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/ConfigurationVersion_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/ConfigurationVersion_relationships" | |
} | |
} | |
}, | |
"IngressAttributes" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/IngressAttributes_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/IngressAttributes_relationships" | |
} | |
} | |
}, | |
"IngressTrigger" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/IngressTrigger_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/IngressTrigger_relationships" | |
} | |
} | |
}, | |
"NewApply" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewApply_attributes" | |
} | |
} | |
}, | |
"NewAttribute" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewAttribute_attributes" | |
} | |
} | |
}, | |
"NewAttributeDefinition" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewAttributeDefinition_attributes" | |
} | |
} | |
}, | |
"NewCollaboration" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewCollaboration_attributes" | |
} | |
} | |
}, | |
"NewConfigurationVersion" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewConfigurationVersion_attributes" | |
} | |
} | |
}, | |
"NewIngressAttributes" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewIngressAttributes_attributes" | |
} | |
} | |
}, | |
"NewIngressTrigger" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewIngressTrigger_attributes" | |
} | |
} | |
}, | |
"NewOAuthClient" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewOAuthClient_attributes" | |
} | |
} | |
}, | |
"NewOAuthToken" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewOAuthToken_attributes" | |
} | |
} | |
}, | |
"NewOrganization" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewOrganization_attributes" | |
} | |
} | |
}, | |
"NewPlan" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewPlan_attributes" | |
} | |
} | |
}, | |
"NewRun" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewRun_attributes" | |
} | |
} | |
}, | |
"NewRunEvent" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewRunEvent_attributes" | |
} | |
} | |
}, | |
"NewSshKey" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewSshKey_attributes" | |
} | |
} | |
}, | |
"NewStateVersion" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewStateVersion_attributes" | |
} | |
} | |
}, | |
"NewTeam" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewTeam_attributes" | |
} | |
} | |
}, | |
"NewToManyRelationship" : { | |
"type" : "object", | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/NewToManyRelationship_data" | |
} | |
} | |
} | |
}, | |
"NewToOneRelationship" : { | |
"type" : "object", | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewToOneRelationship_data" | |
} | |
} | |
}, | |
"NewToolVersion" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewToolVersion_attributes" | |
} | |
} | |
}, | |
"NewVar" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewVar_attributes" | |
} | |
} | |
}, | |
"NewVcsRepo" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewVcsRepo_attributes" | |
} | |
} | |
}, | |
"NewWorkspace" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewWorkspace_attributes" | |
} | |
} | |
}, | |
"NewWorkspaceComment" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewWorkspaceComment_attributes" | |
} | |
} | |
}, | |
"NewWorkspaceConfigurationVersion" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewWorkspaceConfigurationVersion_attributes" | |
} | |
} | |
}, | |
"NewWorkspaceRunAlert" : { | |
"type" : "object", | |
"required" : [ "type" ], | |
"properties" : { | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewWorkspaceRunAlert_attributes" | |
} | |
} | |
}, | |
"OAuthClient" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/OAuthClient_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/OAuthClient_relationships" | |
} | |
} | |
}, | |
"OAuthToken" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/OAuthToken_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/OAuthToken_relationships" | |
} | |
} | |
}, | |
"Organization" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/Organization_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/Organization_relationships" | |
} | |
} | |
}, | |
"Plan" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/Plan_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/Plan_relationships" | |
} | |
} | |
}, | |
"Run" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/Run_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/Run_relationships" | |
} | |
} | |
}, | |
"RunEvent" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/RunEvent_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/RunEvent_relationships" | |
} | |
} | |
}, | |
"SshKey" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/SshKey_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/SshKey_relationships" | |
} | |
} | |
}, | |
"StateVersion" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/StateVersion_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/StateVersion_relationships" | |
} | |
} | |
}, | |
"Team" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/Team_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/Team_relationships" | |
} | |
} | |
}, | |
"ToManyRelationship" : { | |
"type" : "object", | |
"required" : [ "data" ], | |
"properties" : { | |
"links" : { | |
"$ref" : "#/definitions/ToManyRelationship_links" | |
}, | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/NewToManyRelationship_data" | |
} | |
} | |
} | |
}, | |
"ToOneRelationship" : { | |
"type" : "object", | |
"properties" : { | |
"links" : { | |
"$ref" : "#/definitions/ToManyRelationship_links" | |
}, | |
"data" : { | |
"$ref" : "#/definitions/NewToManyRelationship_data" | |
} | |
} | |
}, | |
"ToolVersion" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/NewToolVersion_attributes" | |
}, | |
"relationships" : { | |
"type" : "object", | |
"properties" : { } | |
} | |
} | |
}, | |
"Var" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/Var_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/Var_relationships" | |
} | |
} | |
}, | |
"VcsRepo" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/VcsRepo_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/VcsRepo_relationships" | |
} | |
} | |
}, | |
"Workspace" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/Workspace_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/Workspace_relationships" | |
} | |
} | |
}, | |
"WorkspaceComment" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/WorkspaceComment_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/WorkspaceComment_relationships" | |
} | |
} | |
}, | |
"WorkspaceConfigurationVersion" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/WorkspaceConfigurationVersion_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/WorkspaceConfigurationVersion_relationships" | |
} | |
} | |
}, | |
"WorkspaceRunAlert" : { | |
"type" : "object", | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
}, | |
"attributes" : { | |
"$ref" : "#/definitions/WorkspaceRunAlert_attributes" | |
}, | |
"relationships" : { | |
"$ref" : "#/definitions/WorkspaceRunAlert_relationships" | |
} | |
} | |
}, | |
"inline_response_200" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply" | |
} | |
} | |
} | |
}, | |
"data" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewApply" | |
} | |
} | |
}, | |
"inline_response_201" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Apply" | |
} | |
} | |
}, | |
"data_1" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Apply" | |
} | |
} | |
}, | |
"inline_response_200_1" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Run" | |
} | |
} | |
}, | |
"inline_response_200_2" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/RunEvent" | |
} | |
} | |
} | |
}, | |
"inline_response_200_3" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/StateVersion" | |
} | |
} | |
} | |
}, | |
"inline_response_200_4" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Attribute" | |
} | |
} | |
} | |
}, | |
"data_2" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewAttribute" | |
} | |
} | |
}, | |
"inline_response_201_1" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Attribute" | |
} | |
} | |
}, | |
"inline_response_200_5" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/AttributeDefinition" | |
} | |
} | |
} | |
}, | |
"data_3" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewAttributeDefinition" | |
} | |
} | |
}, | |
"inline_response_201_2" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/AttributeDefinition" | |
} | |
} | |
}, | |
"data_4" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/AttributeDefinition" | |
} | |
} | |
}, | |
"inline_response_200_6" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Organization" | |
} | |
} | |
}, | |
"data_5" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Attribute" | |
} | |
} | |
}, | |
"inline_response_200_7" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Workspace" | |
} | |
} | |
}, | |
"inline_response_200_8" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Collaboration" | |
} | |
} | |
} | |
}, | |
"data_6" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewCollaboration" | |
} | |
} | |
}, | |
"inline_response_201_3" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Collaboration" | |
} | |
} | |
}, | |
"data_7" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Collaboration" | |
} | |
} | |
}, | |
"inline_response_200_9" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Team" | |
} | |
} | |
}, | |
"inline_response_200_10" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"data_8" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewConfigurationVersion" | |
} | |
} | |
}, | |
"inline_response_201_4" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/ConfigurationVersion" | |
} | |
} | |
}, | |
"data_9" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/ConfigurationVersion" | |
} | |
} | |
}, | |
"inline_response_200_11" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/IngressAttributes" | |
} | |
} | |
}, | |
"inline_response_200_12" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/IngressTrigger" | |
} | |
} | |
}, | |
"inline_response_200_13" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/VcsRepo" | |
} | |
} | |
}, | |
"inline_response_200_14" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/WorkspaceConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"inline_response_200_15" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Workspace" | |
} | |
} | |
} | |
}, | |
"data_10" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewIngressAttributes" | |
} | |
} | |
}, | |
"data_11" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/IngressAttributes" | |
} | |
} | |
}, | |
"inline_response_200_16" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/IngressTrigger" | |
} | |
} | |
} | |
}, | |
"data_12" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewIngressTrigger" | |
} | |
} | |
}, | |
"data_13" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/IngressTrigger" | |
} | |
} | |
}, | |
"inline_response_200_17" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/OAuthClient" | |
} | |
} | |
} | |
}, | |
"data_14" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewOAuthClient" | |
} | |
} | |
}, | |
"inline_response_201_5" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/OAuthClient" | |
} | |
} | |
}, | |
"data_15" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/OAuthClient" | |
} | |
} | |
}, | |
"inline_response_200_18" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/OAuthToken" | |
} | |
} | |
} | |
}, | |
"data_16" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewOAuthToken" | |
} | |
} | |
}, | |
"inline_response_201_6" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/OAuthToken" | |
} | |
} | |
}, | |
"data_17" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/OAuthToken" | |
} | |
} | |
}, | |
"inline_response_200_19" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Organization" | |
} | |
} | |
} | |
}, | |
"data_18" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewOrganization" | |
} | |
} | |
}, | |
"data_19" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Organization" | |
} | |
} | |
}, | |
"inline_response_200_20" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/SshKey" | |
} | |
} | |
} | |
}, | |
"inline_response_200_21" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Team" | |
} | |
} | |
} | |
}, | |
"inline_response_200_22" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Var" | |
} | |
} | |
} | |
}, | |
"inline_response_200_23" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Plan" | |
} | |
} | |
} | |
}, | |
"data_20" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewPlan" | |
} | |
} | |
}, | |
"inline_response_201_7" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Plan" | |
} | |
} | |
}, | |
"data_21" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Plan" | |
} | |
} | |
}, | |
"data_22" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewRunEvent" | |
} | |
} | |
}, | |
"inline_response_201_8" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/RunEvent" | |
} | |
} | |
}, | |
"data_23" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/RunEvent" | |
} | |
} | |
}, | |
"inline_response_200_24" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/WorkspaceComment" | |
} | |
} | |
}, | |
"inline_response_200_25" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Run" | |
} | |
} | |
} | |
}, | |
"data_24" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewRun" | |
} | |
} | |
}, | |
"data_25" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Run" | |
} | |
} | |
}, | |
"inline_response_200_26" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/WorkspaceComment" | |
} | |
} | |
} | |
}, | |
"inline_response_200_27" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/WorkspaceRunAlert" | |
} | |
} | |
} | |
}, | |
"data_26" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewSshKey" | |
} | |
} | |
}, | |
"inline_response_201_9" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/SshKey" | |
} | |
} | |
}, | |
"data_27" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/SshKey" | |
} | |
} | |
}, | |
"data_28" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewStateVersion" | |
} | |
} | |
}, | |
"inline_response_201_10" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/StateVersion" | |
} | |
} | |
}, | |
"data_29" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/StateVersion" | |
} | |
} | |
}, | |
"data_30" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewTeam" | |
} | |
} | |
}, | |
"data_31" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Team" | |
} | |
} | |
}, | |
"inline_response_200_28" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/ToolVersion" | |
} | |
} | |
} | |
}, | |
"data_32" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewToolVersion" | |
} | |
} | |
}, | |
"inline_response_201_11" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/ToolVersion" | |
} | |
} | |
}, | |
"data_33" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/ToolVersion" | |
} | |
} | |
}, | |
"data_34" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewVar" | |
} | |
} | |
}, | |
"inline_response_201_12" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Var" | |
} | |
} | |
}, | |
"data_35" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Var" | |
} | |
} | |
}, | |
"inline_response_200_29" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/VcsRepo" | |
} | |
} | |
} | |
}, | |
"data_36" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewVcsRepo" | |
} | |
} | |
}, | |
"data_37" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/VcsRepo" | |
} | |
} | |
}, | |
"data_38" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewWorkspaceComment" | |
} | |
} | |
}, | |
"data_39" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/WorkspaceComment" | |
} | |
} | |
}, | |
"data_40" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewWorkspaceConfigurationVersion" | |
} | |
} | |
}, | |
"inline_response_201_13" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/WorkspaceConfigurationVersion" | |
} | |
} | |
}, | |
"data_41" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/WorkspaceConfigurationVersion" | |
} | |
} | |
}, | |
"data_42" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewWorkspaceRunAlert" | |
} | |
} | |
}, | |
"inline_response_201_14" : { | |
"required" : [ "data" ], | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/WorkspaceRunAlert" | |
} | |
} | |
}, | |
"data_43" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/WorkspaceRunAlert" | |
} | |
} | |
}, | |
"data_44" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/NewWorkspace" | |
} | |
} | |
}, | |
"data_45" : { | |
"properties" : { | |
"data" : { | |
"$ref" : "#/definitions/Workspace" | |
} | |
} | |
}, | |
"Apply_attributes" : { | |
"properties" : { | |
"external-id" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"run-id" : { | |
"type" : "integer" | |
}, | |
"archivist-upload-id" : { | |
"type" : "string" | |
}, | |
"status" : { | |
"type" : "string" | |
}, | |
"status-timestamps" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"Apply_relationships_Run_links" : { | |
"properties" : { | |
"self" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"Apply_relationships_Run" : { | |
"properties" : { | |
"links" : { | |
"$ref" : "#/definitions/Apply_relationships_Run_links" | |
} | |
} | |
}, | |
"Apply_relationships" : { | |
"properties" : { | |
"Run" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"StateVersions" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"RunEvents" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
} | |
}, | |
"Attribute_attributes" : { | |
"properties" : { | |
"value" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
} | |
} | |
}, | |
"Attribute_relationships" : { | |
"properties" : { | |
"AttributeDefinition" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Workspace" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"AttributeDefinition_attributes" : { | |
"properties" : { | |
"name" : { | |
"type" : "string" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"organization-id" : { | |
"type" : "integer" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
} | |
} | |
}, | |
"AttributeDefinition_relationships" : { | |
"properties" : { | |
"Organization" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"WorkspaceAttributes" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
} | |
}, | |
"Collaboration_attributes" : { | |
"properties" : { | |
"item-id" : { | |
"type" : "integer" | |
}, | |
"user-id" : { | |
"type" : "integer" | |
}, | |
"team-id" : { | |
"type" : "integer" | |
}, | |
"permissions" : { | |
"type" : "string" | |
}, | |
"item-type" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
} | |
} | |
}, | |
"Collaboration_relationships" : { | |
"properties" : { | |
"Team" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Item" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"ConfigurationVersion_attributes" : { | |
"properties" : { | |
"created-by-id" : { | |
"type" : "integer" | |
}, | |
"error" : { | |
"type" : "string" | |
}, | |
"status" : { | |
"type" : "string" | |
}, | |
"status-timestamps" : { | |
"type" : "string" | |
}, | |
"internal-error" : { | |
"type" : "string" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"organization-id" : { | |
"type" : "integer" | |
}, | |
"source" : { | |
"type" : "string" | |
}, | |
"vcs-repo-id" : { | |
"type" : "integer" | |
}, | |
"trace-resource-id" : { | |
"type" : "string", | |
"format" : "uuid" | |
} | |
} | |
}, | |
"ConfigurationVersion_relationships" : { | |
"properties" : { | |
"CreatedBy" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Organization" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"VcsRepo" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"WorkspaceConfigurationVersions" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"Workspaces" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"HostedFiles" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"IngressAttributes" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"DownloadableSlug" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"UploadableSlug" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"IngressAttributes_attributes" : { | |
"properties" : { | |
"branch" : { | |
"type" : "string" | |
}, | |
"clone-url" : { | |
"type" : "string" | |
}, | |
"commit-sha" : { | |
"type" : "string" | |
}, | |
"commit-url" : { | |
"type" : "string" | |
}, | |
"compare-url" : { | |
"type" : "string" | |
}, | |
"is-pull-request" : { | |
"type" : "boolean" | |
}, | |
"commit-message" : { | |
"type" : "string" | |
}, | |
"on-default-branch" : { | |
"type" : "boolean" | |
}, | |
"path" : { | |
"type" : "string" | |
}, | |
"template-path" : { | |
"type" : "string" | |
}, | |
"pull-request-number" : { | |
"type" : "integer" | |
}, | |
"pull-request-url" : { | |
"type" : "string" | |
}, | |
"identifier" : { | |
"type" : "string" | |
}, | |
"tag" : { | |
"type" : "string" | |
}, | |
"username" : { | |
"type" : "string" | |
}, | |
"created-by-id" : { | |
"type" : "integer" | |
}, | |
"vcs-webhook-payload-id" : { | |
"type" : "integer" | |
}, | |
"ingress-attributable-id" : { | |
"type" : "integer" | |
}, | |
"ingress-attributable-type" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
} | |
} | |
}, | |
"IngressAttributes_relationships" : { | |
"properties" : { | |
"IngressAttributable" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"CreatedBy" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"VcsWebhookPayload" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"IngressTrigger_attributes" : { | |
"properties" : { | |
"external-id" : { | |
"type" : "string" | |
}, | |
"vcs-repo-id" : { | |
"type" : "integer" | |
}, | |
"workspace-id" : { | |
"type" : "integer" | |
}, | |
"default-branch" : { | |
"type" : "boolean" | |
}, | |
"branch" : { | |
"type" : "string" | |
}, | |
"tags" : { | |
"type" : "boolean" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"ingress-submodules" : { | |
"type" : "boolean" | |
} | |
} | |
}, | |
"IngressTrigger_relationships" : { | |
"properties" : { | |
"VcsRepo" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Workspace" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"NewApply_attributes" : { | |
"properties" : { | |
"external-id" : { | |
"type" : "string" | |
}, | |
"run-id" : { | |
"type" : "integer" | |
}, | |
"archivist-upload-id" : { | |
"type" : "string" | |
}, | |
"status" : { | |
"type" : "string" | |
}, | |
"status-timestamps" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"NewAttribute_attributes" : { | |
"properties" : { | |
"value" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"NewAttributeDefinition_attributes" : { | |
"properties" : { | |
"name" : { | |
"type" : "string" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"organization-id" : { | |
"type" : "integer" | |
} | |
} | |
}, | |
"NewCollaboration_attributes" : { | |
"properties" : { | |
"item-id" : { | |
"type" : "integer" | |
}, | |
"user-id" : { | |
"type" : "integer" | |
}, | |
"team-id" : { | |
"type" : "integer" | |
}, | |
"permissions" : { | |
"type" : "string" | |
}, | |
"item-type" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"NewConfigurationVersion_attributes" : { | |
"properties" : { | |
"created-by-id" : { | |
"type" : "integer" | |
}, | |
"error" : { | |
"type" : "string" | |
}, | |
"status" : { | |
"type" : "string" | |
}, | |
"status-timestamps" : { | |
"type" : "string" | |
}, | |
"internal-error" : { | |
"type" : "string" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"organization-id" : { | |
"type" : "integer" | |
}, | |
"source" : { | |
"type" : "string" | |
}, | |
"vcs-repo-id" : { | |
"type" : "integer" | |
}, | |
"trace-resource-id" : { | |
"type" : "string", | |
"format" : "uuid" | |
} | |
} | |
}, | |
"NewIngressAttributes_attributes" : { | |
"properties" : { | |
"branch" : { | |
"type" : "string" | |
}, | |
"clone-url" : { | |
"type" : "string" | |
}, | |
"commit-sha" : { | |
"type" : "string" | |
}, | |
"commit-url" : { | |
"type" : "string" | |
}, | |
"compare-url" : { | |
"type" : "string" | |
}, | |
"is-pull-request" : { | |
"type" : "boolean" | |
}, | |
"commit-message" : { | |
"type" : "string" | |
}, | |
"on-default-branch" : { | |
"type" : "boolean" | |
}, | |
"path" : { | |
"type" : "string" | |
}, | |
"template-path" : { | |
"type" : "string" | |
}, | |
"pull-request-number" : { | |
"type" : "integer" | |
}, | |
"pull-request-url" : { | |
"type" : "string" | |
}, | |
"identifier" : { | |
"type" : "string" | |
}, | |
"tag" : { | |
"type" : "string" | |
}, | |
"username" : { | |
"type" : "string" | |
}, | |
"created-by-id" : { | |
"type" : "integer" | |
}, | |
"vcs-webhook-payload-id" : { | |
"type" : "integer" | |
}, | |
"ingress-attributable-id" : { | |
"type" : "integer" | |
}, | |
"ingress-attributable-type" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"NewIngressTrigger_attributes" : { | |
"properties" : { | |
"external-id" : { | |
"type" : "string" | |
}, | |
"vcs-repo-id" : { | |
"type" : "integer" | |
}, | |
"workspace-id" : { | |
"type" : "integer" | |
}, | |
"default-branch" : { | |
"type" : "boolean" | |
}, | |
"branch" : { | |
"type" : "string" | |
}, | |
"tags" : { | |
"type" : "boolean" | |
}, | |
"ingress-submodules" : { | |
"type" : "boolean" | |
} | |
} | |
}, | |
"NewOAuthClient_attributes" : { | |
"properties" : { | |
"oauth-clientable-id" : { | |
"type" : "integer" | |
}, | |
"oauth-clientable-type" : { | |
"type" : "string" | |
}, | |
"service-provider" : { | |
"type" : "string" | |
}, | |
"secret-encrypted" : { | |
"type" : "string" | |
}, | |
"key" : { | |
"type" : "string" | |
}, | |
"http-url" : { | |
"type" : "string" | |
}, | |
"api-url" : { | |
"type" : "string" | |
}, | |
"webhook-secret-encrypted" : { | |
"type" : "string" | |
}, | |
"string" : { | |
"type" : "string" | |
}, | |
"uuid" : { | |
"type" : "string", | |
"format" : "uuid" | |
}, | |
"approved" : { | |
"type" : "boolean" | |
}, | |
"global" : { | |
"type" : "boolean" | |
} | |
} | |
}, | |
"NewOAuthToken_attributes" : { | |
"properties" : { | |
"oauth-tokenable-id" : { | |
"type" : "integer" | |
}, | |
"oauth-tokenable-type" : { | |
"type" : "string" | |
}, | |
"oauth-provider-id" : { | |
"type" : "integer" | |
}, | |
"value-encrypted" : { | |
"type" : "string" | |
}, | |
"info-encrypted" : { | |
"type" : "string" | |
}, | |
"uid" : { | |
"type" : "string" | |
}, | |
"oauth-client-id" : { | |
"type" : "integer" | |
}, | |
"anonymous" : { | |
"type" : "boolean" | |
}, | |
"refresh-token-encrypted" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"NewOrganization_attributes" : { | |
"properties" : { | |
"username" : { | |
"type" : "string" | |
}, | |
"default-user-id" : { | |
"type" : "integer" | |
}, | |
"email" : { | |
"type" : "string" | |
}, | |
"profile" : { | |
"type" : "string" | |
}, | |
"trusted" : { | |
"type" : "boolean" | |
}, | |
"stripe-customer-id" : { | |
"type" : "string" | |
}, | |
"plan" : { | |
"type" : "string" | |
}, | |
"current-period-end" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"current-card-last4" : { | |
"type" : "string" | |
}, | |
"delinquent" : { | |
"type" : "boolean" | |
}, | |
"billing-degraded" : { | |
"type" : "boolean" | |
}, | |
"collaborator-auth-policy" : { | |
"type" : "string" | |
}, | |
"access-beta-tools" : { | |
"type" : "boolean" | |
}, | |
"enterprise-billing-enabled" : { | |
"type" : "string" | |
}, | |
"terraform-trial-expiration" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"vagrant-trial-expiration" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"packer-trial-expiration" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"terraform-enterprise-whitelisted" : { | |
"type" : "boolean" | |
}, | |
"vagrant-enterprise-whitelisted" : { | |
"type" : "boolean" | |
}, | |
"packer-enterprise-whitelisted" : { | |
"type" : "boolean" | |
}, | |
"session-timeout" : { | |
"type" : "integer" | |
}, | |
"session-remember" : { | |
"type" : "integer" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"v2-opt-in" : { | |
"type" : "boolean" | |
} | |
} | |
}, | |
"NewPlan_attributes" : { | |
"properties" : { | |
"external-id" : { | |
"type" : "string" | |
}, | |
"run-id" : { | |
"type" : "integer" | |
}, | |
"status" : { | |
"type" : "string" | |
}, | |
"status-timestamps" : { | |
"type" : "string" | |
}, | |
"archivist-upload-id" : { | |
"type" : "string" | |
}, | |
"has-changes" : { | |
"type" : "boolean" | |
} | |
} | |
}, | |
"NewRun_attributes" : { | |
"properties" : { | |
"configuration-version-id" : { | |
"type" : "integer" | |
}, | |
"workspace-id" : { | |
"type" : "integer" | |
}, | |
"input-state-version-id" : { | |
"type" : "integer" | |
}, | |
"created-by-id" : { | |
"type" : "integer" | |
}, | |
"confirmed-by-id" : { | |
"type" : "integer" | |
}, | |
"canceled-by-id" : { | |
"type" : "integer" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"status" : { | |
"type" : "string" | |
}, | |
"status-timestamps" : { | |
"type" : "string" | |
}, | |
"auto-apply" : { | |
"type" : "boolean" | |
}, | |
"source" : { | |
"type" : "string" | |
}, | |
"terraform-version" : { | |
"type" : "string" | |
}, | |
"is-destroy" : { | |
"type" : "boolean" | |
}, | |
"error-text" : { | |
"type" : "string" | |
}, | |
"message" : { | |
"type" : "string" | |
}, | |
"metadata" : { | |
"type" : "string" | |
}, | |
"var-snapshot-encrypted" : { | |
"type" : "string" | |
}, | |
"trace-resource-id" : { | |
"type" : "string", | |
"format" : "uuid" | |
} | |
} | |
}, | |
"NewRunEvent_attributes" : { | |
"properties" : { | |
"action" : { | |
"type" : "string" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"actor-id" : { | |
"type" : "integer" | |
}, | |
"actor-type" : { | |
"type" : "string" | |
}, | |
"run-id" : { | |
"type" : "integer" | |
}, | |
"target-id" : { | |
"type" : "integer" | |
}, | |
"target-type" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"NewSshKey_attributes" : { | |
"properties" : { | |
"ssh-keyable-id" : { | |
"type" : "integer" | |
}, | |
"ssh-keyable-type" : { | |
"type" : "string" | |
}, | |
"value-encrypted" : { | |
"type" : "string" | |
}, | |
"name" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"NewStateVersion_attributes" : { | |
"properties" : { | |
"external-id" : { | |
"type" : "string" | |
}, | |
"serial" : { | |
"type" : "integer" | |
}, | |
"created-by-id" : { | |
"type" : "integer" | |
}, | |
"resources" : { | |
"type" : "string" | |
}, | |
"resources-count" : { | |
"type" : "integer" | |
}, | |
"tfstate-file-encrypted" : { | |
"type" : "string" | |
}, | |
"workspace-id" : { | |
"type" : "integer" | |
}, | |
"operation-id" : { | |
"type" : "integer" | |
}, | |
"operation-type" : { | |
"type" : "string" | |
}, | |
"run-id" : { | |
"type" : "integer" | |
} | |
} | |
}, | |
"NewTeam_attributes" : { | |
"properties" : { | |
"organization-id" : { | |
"type" : "integer" | |
}, | |
"name" : { | |
"type" : "string" | |
}, | |
"default-user-id" : { | |
"type" : "integer" | |
} | |
} | |
}, | |
"NewToManyRelationship_data" : { | |
"required" : [ "id", "type" ], | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"NewToOneRelationship_data" : { | |
"properties" : { | |
"id" : { | |
"type" : "integer" | |
}, | |
"type" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"NewToolVersion_attributes" : { | |
"properties" : { | |
"tool" : { | |
"type" : "string" | |
}, | |
"version" : { | |
"type" : "string" | |
}, | |
"url" : { | |
"type" : "string" | |
}, | |
"sha" : { | |
"type" : "string" | |
}, | |
"official" : { | |
"type" : "boolean" | |
}, | |
"enabled" : { | |
"type" : "boolean" | |
}, | |
"beta" : { | |
"type" : "boolean" | |
} | |
} | |
}, | |
"NewVar_attributes" : { | |
"properties" : { | |
"key" : { | |
"type" : "string" | |
}, | |
"value-encrypted" : { | |
"type" : "string" | |
}, | |
"sensitive" : { | |
"type" : "boolean" | |
}, | |
"hcl" : { | |
"type" : "boolean" | |
}, | |
"category" : { | |
"type" : "string" | |
}, | |
"configurable-id" : { | |
"type" : "integer" | |
}, | |
"configurable-type" : { | |
"type" : "string" | |
}, | |
"variable-set-id" : { | |
"type" : "integer" | |
}, | |
"owner-id" : { | |
"type" : "integer" | |
} | |
} | |
}, | |
"NewVcsRepo_attributes" : { | |
"properties" : { | |
"external-id" : { | |
"type" : "string" | |
}, | |
"identifier" : { | |
"type" : "string" | |
}, | |
"oauth-token-id" : { | |
"type" : "integer" | |
}, | |
"organization-id" : { | |
"type" : "integer" | |
}, | |
"ssh-key-id" : { | |
"type" : "integer" | |
}, | |
"vcs-host-id" : { | |
"type" : "integer" | |
}, | |
"created-by-id" : { | |
"type" : "integer" | |
} | |
} | |
}, | |
"NewWorkspace_attributes" : { | |
"properties" : { | |
"name" : { | |
"type" : "string" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"organization-id" : { | |
"type" : "integer" | |
}, | |
"archived-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"auto-apply" : { | |
"type" : "boolean" | |
}, | |
"periodic-run" : { | |
"type" : "integer" | |
}, | |
"queue-run-on-artifact-upload" : { | |
"type" : "boolean" | |
}, | |
"mfa-setting" : { | |
"type" : "string" | |
}, | |
"terraform-version" : { | |
"type" : "string" | |
}, | |
"variable-set-id" : { | |
"type" : "integer" | |
}, | |
"current-state-version-id" : { | |
"type" : "integer" | |
}, | |
"current-configuration-version-id" : { | |
"type" : "integer" | |
}, | |
"trace-resource-id" : { | |
"type" : "string", | |
"format" : "uuid" | |
} | |
} | |
}, | |
"NewWorkspaceComment_attributes" : { | |
"properties" : { | |
"commentable-id" : { | |
"type" : "integer" | |
}, | |
"commentable-type" : { | |
"type" : "string" | |
}, | |
"user-id" : { | |
"type" : "integer" | |
}, | |
"run-event-id" : { | |
"type" : "integer" | |
}, | |
"body" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"NewWorkspaceConfigurationVersion_attributes" : { | |
"properties" : { | |
"workspace-id" : { | |
"type" : "integer" | |
}, | |
"configuration-version-id" : { | |
"type" : "integer" | |
}, | |
"external-id" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"NewWorkspaceRunAlert_attributes" : { | |
"properties" : { | |
"run-id" : { | |
"type" : "integer" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"status" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"OAuthClient_attributes" : { | |
"properties" : { | |
"oauth-clientable-id" : { | |
"type" : "integer" | |
}, | |
"oauth-clientable-type" : { | |
"type" : "string" | |
}, | |
"service-provider" : { | |
"type" : "string" | |
}, | |
"secret-encrypted" : { | |
"type" : "string" | |
}, | |
"key" : { | |
"type" : "string" | |
}, | |
"http-url" : { | |
"type" : "string" | |
}, | |
"api-url" : { | |
"type" : "string" | |
}, | |
"webhook-secret-encrypted" : { | |
"type" : "string" | |
}, | |
"string" : { | |
"type" : "string" | |
}, | |
"uuid" : { | |
"type" : "string", | |
"format" : "uuid" | |
}, | |
"approved" : { | |
"type" : "boolean" | |
}, | |
"global" : { | |
"type" : "boolean" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
} | |
} | |
}, | |
"OAuthClient_relationships" : { | |
"properties" : { | |
"OauthClientable" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"VcsHost" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"OauthTokens" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
} | |
}, | |
"OAuthToken_attributes" : { | |
"properties" : { | |
"oauth-tokenable-id" : { | |
"type" : "integer" | |
}, | |
"oauth-tokenable-type" : { | |
"type" : "string" | |
}, | |
"oauth-provider-id" : { | |
"type" : "integer" | |
}, | |
"value-encrypted" : { | |
"type" : "string" | |
}, | |
"info-encrypted" : { | |
"type" : "string" | |
}, | |
"uid" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"oauth-client-id" : { | |
"type" : "integer" | |
}, | |
"anonymous" : { | |
"type" : "boolean" | |
}, | |
"refresh-token-encrypted" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"OAuthToken_relationships" : { | |
"properties" : { | |
"OauthClient" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"OauthTokenable" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"OauthClientable" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"VcsConnections" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
} | |
}, | |
"Organization_attributes" : { | |
"properties" : { | |
"username" : { | |
"type" : "string" | |
}, | |
"default-user-id" : { | |
"type" : "integer" | |
}, | |
"email" : { | |
"type" : "string" | |
}, | |
"profile" : { | |
"type" : "string" | |
}, | |
"trusted" : { | |
"type" : "boolean" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"stripe-customer-id" : { | |
"type" : "string" | |
}, | |
"plan" : { | |
"type" : "string" | |
}, | |
"current-period-end" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"current-card-last4" : { | |
"type" : "string" | |
}, | |
"delinquent" : { | |
"type" : "boolean" | |
}, | |
"billing-degraded" : { | |
"type" : "boolean" | |
}, | |
"collaborator-auth-policy" : { | |
"type" : "string" | |
}, | |
"access-beta-tools" : { | |
"type" : "boolean" | |
}, | |
"enterprise-billing-enabled" : { | |
"type" : "string" | |
}, | |
"terraform-trial-expiration" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"vagrant-trial-expiration" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"packer-trial-expiration" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"terraform-enterprise-whitelisted" : { | |
"type" : "boolean" | |
}, | |
"vagrant-enterprise-whitelisted" : { | |
"type" : "boolean" | |
}, | |
"packer-enterprise-whitelisted" : { | |
"type" : "boolean" | |
}, | |
"session-timeout" : { | |
"type" : "integer" | |
}, | |
"session-remember" : { | |
"type" : "integer" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"v2-opt-in" : { | |
"type" : "boolean" | |
} | |
} | |
}, | |
"Organization_relationships" : { | |
"properties" : { | |
"Collaborators" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"EnvVars" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"Vars" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"VariableSets" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"Memberships" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Domains" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"Payments" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"Teams" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"Artifacts" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"Configurations" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"RuntimeStates" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"BuildConfigurations" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"OauthClients" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"OauthTokens" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"SshKeys" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"Environments" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"DefaultEnvironment" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"User" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"NotificationMethods" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"Plan_attributes" : { | |
"properties" : { | |
"external-id" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"run-id" : { | |
"type" : "integer" | |
}, | |
"status" : { | |
"type" : "string" | |
}, | |
"status-timestamps" : { | |
"type" : "string" | |
}, | |
"archivist-upload-id" : { | |
"type" : "string" | |
}, | |
"has-changes" : { | |
"type" : "boolean" | |
} | |
} | |
}, | |
"Plan_relationships" : { | |
"properties" : { | |
"Run" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"StateVersions" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"RunEvents" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"ExecutablePlan" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"ConfigurationVersion" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"Run_attributes" : { | |
"properties" : { | |
"configuration-version-id" : { | |
"type" : "integer" | |
}, | |
"workspace-id" : { | |
"type" : "integer" | |
}, | |
"input-state-version-id" : { | |
"type" : "integer" | |
}, | |
"created-by-id" : { | |
"type" : "integer" | |
}, | |
"confirmed-by-id" : { | |
"type" : "integer" | |
}, | |
"canceled-by-id" : { | |
"type" : "integer" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"status" : { | |
"type" : "string" | |
}, | |
"status-timestamps" : { | |
"type" : "string" | |
}, | |
"auto-apply" : { | |
"type" : "boolean" | |
}, | |
"source" : { | |
"type" : "string" | |
}, | |
"terraform-version" : { | |
"type" : "string" | |
}, | |
"is-destroy" : { | |
"type" : "boolean" | |
}, | |
"error-text" : { | |
"type" : "string" | |
}, | |
"message" : { | |
"type" : "string" | |
}, | |
"metadata" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"var-snapshot-encrypted" : { | |
"type" : "string" | |
}, | |
"trace-resource-id" : { | |
"type" : "string", | |
"format" : "uuid" | |
} | |
} | |
}, | |
"Run_relationships" : { | |
"properties" : { | |
"Apply" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"CanceledBy" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"WorkspaceComments" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"ConfirmedBy" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"ConfigurationVersion" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"CreatedBy" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"InputStateVersion" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Plan" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"RunEvents" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"Workspace" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"WorkspaceRunAlerts" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
} | |
}, | |
"RunEvent_attributes" : { | |
"properties" : { | |
"action" : { | |
"type" : "string" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"actor-id" : { | |
"type" : "integer" | |
}, | |
"actor-type" : { | |
"type" : "string" | |
}, | |
"run-id" : { | |
"type" : "integer" | |
}, | |
"target-id" : { | |
"type" : "integer" | |
}, | |
"target-type" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
} | |
} | |
}, | |
"RunEvent_relationships" : { | |
"properties" : { | |
"Actor" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"WorkspaceComment" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Run" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Target" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"SshKey_attributes" : { | |
"properties" : { | |
"ssh-keyable-id" : { | |
"type" : "integer" | |
}, | |
"ssh-keyable-type" : { | |
"type" : "string" | |
}, | |
"value-encrypted" : { | |
"type" : "string" | |
}, | |
"name" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
} | |
} | |
}, | |
"SshKey_relationships" : { | |
"properties" : { | |
"SshKeyable" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Collaborations" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"CollaboratedTeams" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"TeamCollaborations" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"UserCollaborations" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"CollaboratoredUsers" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"CollaboratoredOrganizations" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"KeyedBuildConfigurations" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"KeyedRuntimeConfigurations" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
} | |
}, | |
"StateVersion_attributes" : { | |
"properties" : { | |
"external-id" : { | |
"type" : "string" | |
}, | |
"serial" : { | |
"type" : "integer" | |
}, | |
"created-by-id" : { | |
"type" : "integer" | |
}, | |
"resources" : { | |
"type" : "string" | |
}, | |
"resources-count" : { | |
"type" : "integer" | |
}, | |
"tfstate-file-encrypted" : { | |
"type" : "string" | |
}, | |
"workspace-id" : { | |
"type" : "integer" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"operation-id" : { | |
"type" : "integer" | |
}, | |
"operation-type" : { | |
"type" : "string" | |
}, | |
"run-id" : { | |
"type" : "integer" | |
} | |
} | |
}, | |
"StateVersion_relationships" : { | |
"properties" : { | |
"CreatedBy" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Workspace" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Run" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Operation" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"Team_attributes" : { | |
"properties" : { | |
"organization-id" : { | |
"type" : "integer" | |
}, | |
"name" : { | |
"type" : "string" | |
}, | |
"default-user-id" : { | |
"type" : "integer" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
} | |
} | |
}, | |
"Team_relationships" : { | |
"properties" : { | |
"CollaboratedStates" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"CollaboratedArtifacts" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"CollaboratedBuildConfigurations" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Collaborations" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"Members" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Memberships" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"NotificationPreferenceDestinations" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"Organization" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"User" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"NotificationMethods" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"ToManyRelationship_links" : { | |
"required" : [ "related", "self" ], | |
"properties" : { | |
"self" : { | |
"type" : "string" | |
}, | |
"related" : { | |
"type" : "string" | |
} | |
} | |
}, | |
"Var_attributes" : { | |
"properties" : { | |
"key" : { | |
"type" : "string" | |
}, | |
"value-encrypted" : { | |
"type" : "string" | |
}, | |
"sensitive" : { | |
"type" : "boolean" | |
}, | |
"hcl" : { | |
"type" : "boolean" | |
}, | |
"category" : { | |
"type" : "string" | |
}, | |
"configurable-id" : { | |
"type" : "integer" | |
}, | |
"configurable-type" : { | |
"type" : "string" | |
}, | |
"variable-set-id" : { | |
"type" : "integer" | |
}, | |
"owner-id" : { | |
"type" : "integer" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
} | |
} | |
}, | |
"Var_relationships" : { | |
"properties" : { | |
"Configurable" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"VariableSet" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Owner" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"VcsRepo_attributes" : { | |
"properties" : { | |
"external-id" : { | |
"type" : "string" | |
}, | |
"identifier" : { | |
"type" : "string" | |
}, | |
"oauth-token-id" : { | |
"type" : "integer" | |
}, | |
"organization-id" : { | |
"type" : "integer" | |
}, | |
"ssh-key-id" : { | |
"type" : "integer" | |
}, | |
"vcs-host-id" : { | |
"type" : "integer" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"created-by-id" : { | |
"type" : "integer" | |
} | |
} | |
}, | |
"VcsRepo_relationships" : { | |
"properties" : { | |
"CreatedBy" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"VcsHost" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"OauthToken" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Organization" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"SshKey" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"IngressTriggers" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
} | |
}, | |
"Workspace_attributes" : { | |
"properties" : { | |
"name" : { | |
"type" : "string" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"organization-id" : { | |
"type" : "integer" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"archived-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"auto-apply" : { | |
"type" : "boolean" | |
}, | |
"periodic-run" : { | |
"type" : "integer" | |
}, | |
"queue-run-on-artifact-upload" : { | |
"type" : "boolean" | |
}, | |
"mfa-setting" : { | |
"type" : "string" | |
}, | |
"terraform-version" : { | |
"type" : "string" | |
}, | |
"variable-set-id" : { | |
"type" : "integer" | |
}, | |
"current-state-version-id" : { | |
"type" : "integer" | |
}, | |
"current-configuration-version-id" : { | |
"type" : "integer" | |
}, | |
"trace-resource-id" : { | |
"type" : "string", | |
"format" : "uuid" | |
} | |
} | |
}, | |
"Workspace_relationships" : { | |
"properties" : { | |
"Collaborations" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"CollaboratedTeams" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"TeamCollaborations" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"UserCollaborations" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"CollaboratoredUsers" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"CollaboratoredOrganizations" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"ConfigurationVersions" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"CurrentConfigurationVersion" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"CurrentStateVersion" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"IngressTrigger" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Organization" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"RunEvents" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"StateVersions" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"VariableSet" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"Vars" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"WorkspaceAttributes" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
}, | |
"WorkspaceConfigurationVersions" : { | |
"type" : "array", | |
"items" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
} | |
}, | |
"WorkspaceComment_attributes" : { | |
"properties" : { | |
"commentable-id" : { | |
"type" : "integer" | |
}, | |
"commentable-type" : { | |
"type" : "string" | |
}, | |
"user-id" : { | |
"type" : "integer" | |
}, | |
"run-event-id" : { | |
"type" : "integer" | |
}, | |
"body" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
} | |
} | |
}, | |
"WorkspaceComment_relationships" : { | |
"properties" : { | |
"Commentable" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"RunEvent" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"User" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"WorkspaceConfigurationVersion_attributes" : { | |
"properties" : { | |
"workspace-id" : { | |
"type" : "integer" | |
}, | |
"configuration-version-id" : { | |
"type" : "integer" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
} | |
} | |
}, | |
"WorkspaceConfigurationVersion_relationships" : { | |
"properties" : { | |
"Workspace" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
}, | |
"ConfigurationVersion" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
}, | |
"WorkspaceRunAlert_attributes" : { | |
"properties" : { | |
"run-id" : { | |
"type" : "integer" | |
}, | |
"external-id" : { | |
"type" : "string" | |
}, | |
"status" : { | |
"type" : "string" | |
}, | |
"created-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
}, | |
"updated-at" : { | |
"type" : "string", | |
"format" : "date-time" | |
} | |
} | |
}, | |
"WorkspaceRunAlert_relationships" : { | |
"properties" : { | |
"Run" : { | |
"$ref" : "#/definitions/Apply_relationships_Run" | |
} | |
} | |
} | |
}, | |
"parameters" : { | |
"newConfigurationVersion" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_8" | |
} | |
}, | |
"newApply" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data" | |
} | |
}, | |
"newStateVersion" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_28" | |
} | |
}, | |
"newVcsRepo" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_36" | |
} | |
}, | |
"patchWorkspaceComment" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_39" | |
} | |
}, | |
"newOAuthToken" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_16" | |
} | |
}, | |
"patchConfigurationVersion" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_9" | |
} | |
}, | |
"patchOrganization" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_19" | |
} | |
}, | |
"patchVcsRepo" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_37" | |
} | |
}, | |
"newIngressTrigger" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_12" | |
} | |
}, | |
"newPlan" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_20" | |
} | |
}, | |
"patchWorkspace" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_45" | |
} | |
}, | |
"patchCollaboration" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_7" | |
} | |
}, | |
"patchIngressAttributes" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_11" | |
} | |
}, | |
"patchWorkspaceRunAlert" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_43" | |
} | |
}, | |
"NewToOneRelationship" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToOneRelationship" | |
} | |
}, | |
"newWorkspaceConfigurationVersion" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_40" | |
} | |
}, | |
"newWorkspaceComment" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_38" | |
} | |
}, | |
"patchAttribute" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_5" | |
} | |
}, | |
"newIngressAttributes" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_10" | |
} | |
}, | |
"newSshKey" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_26" | |
} | |
}, | |
"newVar" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_34" | |
} | |
}, | |
"patchTeam" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_31" | |
} | |
}, | |
"newTeam" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_30" | |
} | |
}, | |
"patchApply" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_1" | |
} | |
}, | |
"NewToManyRelationship" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/NewToManyRelationship" | |
} | |
}, | |
"newWorkspace" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_44" | |
} | |
}, | |
"patchOAuthClient" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_15" | |
} | |
}, | |
"newWorkspaceRunAlert" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_42" | |
} | |
}, | |
"patchVar" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_35" | |
} | |
}, | |
"newToolVersion" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_32" | |
} | |
}, | |
"newCollaboration" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_6" | |
} | |
}, | |
"newRunEvent" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_22" | |
} | |
}, | |
"newAttribute" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_2" | |
} | |
}, | |
"newRun" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_24" | |
} | |
}, | |
"newOrganization" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_18" | |
} | |
}, | |
"patchPlan" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_21" | |
} | |
}, | |
"patchIngressTrigger" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_13" | |
} | |
}, | |
"patchRun" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_25" | |
} | |
}, | |
"patchSshKey" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_27" | |
} | |
}, | |
"patchAttributeDefinition" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_4" | |
} | |
}, | |
"patchStateVersion" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_29" | |
} | |
}, | |
"patchWorkspaceConfigurationVersion" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_41" | |
} | |
}, | |
"newOAuthClient" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_14" | |
} | |
}, | |
"patchToolVersion" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_33" | |
} | |
}, | |
"patchOAuthToken" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_17" | |
} | |
}, | |
"patchRunEvent" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_23" | |
} | |
}, | |
"newAttributeDefinition" : { | |
"in" : "body", | |
"name" : "data", | |
"required" : true, | |
"schema" : { | |
"$ref" : "#/definitions/data_3" | |
} | |
} | |
}, | |
"responses" : { | |
"Applies200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Apply", | |
"attributes" : { | |
"run_id" : 1, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:42:36.425+0000", | |
"updated_at" : "2017-06-30T15:42:36.425+0000", | |
"archivist_upload_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "Apply", | |
"attributes" : { | |
"run_id" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:42:37.096+0000", | |
"updated_at" : "2017-06-30T15:42:37.096+0000", | |
"archivist_upload_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "Apply", | |
"attributes" : { | |
"run_id" : 3, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:42:37.503+0000", | |
"updated_at" : "2017-06-30T15:42:37.503+0000", | |
"archivist_upload_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"Apply-Run-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/run", | |
"related" : "/applies/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"Apply-RunEvents-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/run-events", | |
"related" : "/applies/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"Apply-StateVersions-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/applies/1/relationships/state-versions", | |
"related" : "/applies/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"Apply200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Apply", | |
"attributes" : { | |
"run_id" : 1, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:42:36.425+0000", | |
"updated_at" : "2017-06-30T15:42:36.425+0000", | |
"archivist_upload_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"Apply201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Apply", | |
"attributes" : { | |
"run_id" : 1, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:42:36.425+0000", | |
"updated_at" : "2017-06-30T15:42:36.425+0000", | |
"archivist_upload_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"Attribute-AttributeDefinition-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attributes/1/relationships/attribute-definition", | |
"related" : "/attributes/1/attribute-definition" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "AttributeDefinition" | |
} | |
} | |
} | |
}, | |
"Attribute-Workspace-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attributes/1/relationships/workspace", | |
"related" : "/attributes/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"Attribute200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
} | |
} | |
} | |
}, | |
"Attribute201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
} | |
} | |
} | |
}, | |
"AttributeDefinition-Attributes-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attribute-definitions/1/relationships/attributes", | |
"related" : "/attribute-definitions/1/attributes" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Attribute" | |
}, { | |
"id" : 2, | |
"type" : "Attribute" | |
} ] | |
} | |
} | |
}, | |
"AttributeDefinition-Organization-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/attribute-definitions/1/relationships/organization", | |
"related" : "/attribute-definitions/1/organization" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Organization" | |
} | |
} | |
} | |
}, | |
"AttributeDefinition200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_2" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "AttributeDefinition", | |
"attributes" : { | |
"name" : "SlothSpeed", | |
"external_id" : "attrdef-tQbn7rtU1gtTKxKU", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
} | |
} | |
} | |
}, | |
"AttributeDefinition201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_2" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "AttributeDefinition", | |
"attributes" : { | |
"name" : "SlothSpeed", | |
"external_id" : "attrdef-tQbn7rtU1gtTKxKU", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
} | |
} | |
} | |
}, | |
"AttributeDefinitions200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_5" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "AttributeDefinition", | |
"attributes" : { | |
"name" : "SlothSpeed", | |
"external_id" : "attrdef-tQbn7rtU1gtTKxKU", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "AttributeDefinition", | |
"attributes" : { | |
"name" : "SlothSpeed", | |
"external_id" : "attrdef-ubNCjxQyRd5zPAjZ", | |
"organization_id" : 2, | |
"created_at" : "2017-06-30T15:43:07.900+0000", | |
"updated_at" : "2017-06-30T15:43:07.900+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "AttributeDefinition", | |
"attributes" : { | |
"name" : "SlothSpeed", | |
"external_id" : "attrdef-xhkSkTCjW6ucWPwm", | |
"organization_id" : 3, | |
"created_at" : "2017-06-30T15:43:07.919+0000", | |
"updated_at" : "2017-06-30T15:43:07.919+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"Attributes200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_4" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.878+0000", | |
"updated_at" : "2017-06-30T15:43:07.878+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.900+0000", | |
"updated_at" : "2017-06-30T15:43:07.900+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "Attribute", | |
"attributes" : { | |
"value" : "hey", | |
"created_at" : "2017-06-30T15:43:07.919+0000", | |
"updated_at" : "2017-06-30T15:43:07.919+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"Collaboration-Item-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/collaborations/1/relationships/item", | |
"related" : "/collaborations/1/item" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Item" | |
} | |
} | |
} | |
}, | |
"Collaboration-Team-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/collaborations/1/relationships/team", | |
"related" : "/collaborations/1/team" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Team" | |
} | |
} | |
} | |
}, | |
"Collaboration200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_3" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 2, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.725+0000", | |
"updated_at" : "2017-06-30T15:43:25.725+0000" | |
} | |
} | |
} | |
} | |
}, | |
"Collaboration201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_3" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 2, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.725+0000", | |
"updated_at" : "2017-06-30T15:43:25.725+0000" | |
} | |
} | |
} | |
} | |
}, | |
"Collaborations200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_8" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 2, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.725+0000", | |
"updated_at" : "2017-06-30T15:43:25.725+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 4, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.764+0000", | |
"updated_at" : "2017-06-30T15:43:25.764+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "Collaboration", | |
"attributes" : { | |
"item_id" : null, | |
"user_id" : null, | |
"team_id" : 6, | |
"permissions" : "write", | |
"item_type" : null, | |
"created_at" : "2017-06-30T15:43:25.800+0000", | |
"updated_at" : "2017-06-30T15:43:25.800+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"ConfigurationVersion-IngressAttributes-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/ingress-attributes", | |
"related" : "/configuration-versions/1/ingress-attributes" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "IngressAttributes" | |
} | |
} | |
} | |
}, | |
"ConfigurationVersion-IngressTrigger-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/ingress-trigger", | |
"related" : "/configuration-versions/1/ingress-trigger" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "IngressTrigger" | |
} | |
} | |
} | |
}, | |
"ConfigurationVersion-Organization-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/organization", | |
"related" : "/configuration-versions/1/organization" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Organization" | |
} | |
} | |
} | |
}, | |
"ConfigurationVersion-VcsRepo-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/vcs-repo", | |
"related" : "/configuration-versions/1/vcs-repo" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "VcsRepo" | |
} | |
} | |
} | |
}, | |
"ConfigurationVersion-WorkspaceConfigurationVersions-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/workspace-configuration-versions", | |
"related" : "/configuration-versions/1/workspace-configuration-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceConfigurationVersion" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceConfigurationVersion" | |
} ] | |
} | |
} | |
}, | |
"ConfigurationVersion-Workspaces-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/configuration-versions/1/relationships/workspaces", | |
"related" : "/configuration-versions/1/workspaces" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Workspace" | |
}, { | |
"id" : 2, | |
"type" : "Workspace" | |
} ] | |
} | |
} | |
}, | |
"ConfigurationVersion200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_4" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 1, | |
"version" : 1, | |
"created_by" : 1, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.386+0000", | |
"updated_at" : "2017-06-30T15:43:42.386+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 1 | |
} | |
} | |
} | |
} | |
}, | |
"ConfigurationVersion201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_4" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 1, | |
"version" : 1, | |
"created_by" : 1, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.386+0000", | |
"updated_at" : "2017-06-30T15:43:42.386+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 1 | |
} | |
} | |
} | |
} | |
}, | |
"ConfigurationVersions200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_10" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 1, | |
"version" : 1, | |
"created_by" : 1, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.386+0000", | |
"updated_at" : "2017-06-30T15:43:42.386+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 1 | |
} | |
}, { | |
"id" : 1, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 2, | |
"version" : 1, | |
"created_by" : 2, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.675+0000", | |
"updated_at" : "2017-06-30T15:43:42.675+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 2 | |
} | |
}, { | |
"id" : 2, | |
"type" : "ConfigurationVersion", | |
"attributes" : { | |
"configuration_id" : 3, | |
"version" : 1, | |
"created_by" : 3, | |
"disabled_at" : null, | |
"status" : "uploaded", | |
"metadata" : { | |
"git_sha" : "abcd1234" | |
}, | |
"created_at" : "2017-06-30T15:43:42.939+0000", | |
"updated_at" : "2017-06-30T15:43:42.939+0000", | |
"github_compare_url" : null, | |
"github_commit_sha" : null, | |
"github_clone_url" : null, | |
"github_repository" : null, | |
"is_hidden" : false, | |
"github_path" : null, | |
"github_payload" : null, | |
"github_token_encrypted" : null, | |
"github_username" : null, | |
"github_message" : null, | |
"github_on_default_branch" : false, | |
"error" : null, | |
"github_is_pull_request" : false, | |
"github_commit_url" : null, | |
"github_pull_request_url" : null, | |
"github_pull_request_number" : null, | |
"status_timestamps" : { }, | |
"internal_error" : null, | |
"github_branch" : null, | |
"github_tag" : null, | |
"trace_resource_id" : null, | |
"o_auth_token_id" : null, | |
"github_private_key_encrypted" : null, | |
"ssh_key_id" : null, | |
"created_by_id" : 3 | |
} | |
} ] | |
} | |
} | |
}, | |
"Conflict409" : { | |
"description" : "Conflict" | |
}, | |
"Forbidden403" : { | |
"description" : "Forbidden" | |
}, | |
"IngressAttributes-IngressAttributable-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/ingress-attributes/1/relationships/ingress-attributable", | |
"related" : "/ingress-attributes/1/ingress-attributable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "IngressAttributable" | |
} | |
} | |
} | |
}, | |
"IngressAttributes200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_11" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressAttributes", | |
"attributes" : { | |
"branch" : "master", | |
"clone_url" : "https://github.com/foobar/atlas.git", | |
"commit_sha" : "aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"commit_url" : "https://github.com/hashicorp/atlas/commit/aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"compare_url" : "https://api.github.com/repos/atlas/testing/compare/{base}...{head}", | |
"is_pull_request" : true, | |
"commit_message" : "add some stuff", | |
"on_default_branch" : false, | |
"path" : "foo/bar", | |
"template_path" : "bar/baz", | |
"pull_request_number" : 12, | |
"pull_request_url" : "https://api.github.com/repos/atlas/testing/pulls/1", | |
"identifier" : "foobar/atlas", | |
"tag" : "0.4", | |
"username" : "larrydavid", | |
"created_by_id" : 2, | |
"vcs_webhook_payload_id" : 1, | |
"ingress_attributable_id" : 1, | |
"ingress_attributable_type" : "Operations::BuildConfigurationVersion", | |
"created_at" : "2017-06-30T15:47:12.745+0000", | |
"updated_at" : "2017-06-30T15:47:12.745+0000" | |
} | |
} | |
} | |
} | |
}, | |
"IngressAttributes201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_11" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressAttributes", | |
"attributes" : { | |
"branch" : "master", | |
"clone_url" : "https://github.com/foobar/atlas.git", | |
"commit_sha" : "aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"commit_url" : "https://github.com/hashicorp/atlas/commit/aa6e0e588ed4bed9f4114309a28d6fbd843cffa5", | |
"compare_url" : "https://api.github.com/repos/atlas/testing/compare/{base}...{head}", | |
"is_pull_request" : true, | |
"commit_message" : "add some stuff", | |
"on_default_branch" : false, | |
"path" : "foo/bar", | |
"template_path" : "bar/baz", | |
"pull_request_number" : 12, | |
"pull_request_url" : "https://api.github.com/repos/atlas/testing/pulls/1", | |
"identifier" : "foobar/atlas", | |
"tag" : "0.4", | |
"username" : "larrydavid", | |
"created_by_id" : 2, | |
"vcs_webhook_payload_id" : 1, | |
"ingress_attributable_id" : 1, | |
"ingress_attributable_type" : "Operations::BuildConfigurationVersion", | |
"created_at" : "2017-06-30T15:47:12.745+0000", | |
"updated_at" : "2017-06-30T15:47:12.745+0000" | |
} | |
} | |
} | |
} | |
}, | |
"IngressTrigger-VcsRepo-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/ingress-triggers/1/relationships/vcs-repo", | |
"related" : "/ingress-triggers/1/vcs-repo" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "VcsRepo" | |
} | |
} | |
} | |
}, | |
"IngressTrigger-Workspace-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/ingress-triggers/1/relationships/workspace", | |
"related" : "/ingress-triggers/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"IngressTrigger200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_12" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-PP6uSDXKXEhWQApo", | |
"vcs_repo_id" : 1, | |
"workspace_id" : 1, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.341+0000", | |
"updated_at" : "2017-06-30T15:43:59.341+0000", | |
"ingress_submodules" : false | |
} | |
} | |
} | |
} | |
}, | |
"IngressTrigger201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_12" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-PP6uSDXKXEhWQApo", | |
"vcs_repo_id" : 1, | |
"workspace_id" : 1, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.341+0000", | |
"updated_at" : "2017-06-30T15:43:59.341+0000", | |
"ingress_submodules" : false | |
} | |
} | |
} | |
} | |
}, | |
"IngressTriggers200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_16" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-PP6uSDXKXEhWQApo", | |
"vcs_repo_id" : 1, | |
"workspace_id" : 1, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.341+0000", | |
"updated_at" : "2017-06-30T15:43:59.341+0000", | |
"ingress_submodules" : false | |
} | |
}, { | |
"id" : 1, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-C7hMqwcVGHQJcjJf", | |
"vcs_repo_id" : 2, | |
"workspace_id" : 2, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.676+0000", | |
"updated_at" : "2017-06-30T15:43:59.676+0000", | |
"ingress_submodules" : false | |
} | |
}, { | |
"id" : 2, | |
"type" : "IngressTrigger", | |
"attributes" : { | |
"external_id" : "it-yeaVSijweiMGKzKY", | |
"vcs_repo_id" : 3, | |
"workspace_id" : 3, | |
"default_branch" : true, | |
"branch" : "make-sloth-faster", | |
"tags" : true, | |
"created_at" : "2017-06-30T15:43:59.877+0000", | |
"updated_at" : "2017-06-30T15:43:59.877+0000", | |
"ingress_submodules" : false | |
} | |
} ] | |
} | |
} | |
}, | |
"NoContent204" : { | |
"description" : "No Content" | |
}, | |
"NotFound404" : { | |
"description" : "Not Found" | |
}, | |
"OAuthClient-OAuthClientable-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-clients/1/relationships/o-auth-clientable", | |
"related" : "/o-auth-clients/1/o-auth-clientable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "OAuthClientable" | |
} | |
} | |
} | |
}, | |
"OAuthClient-OAuthTokens-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-clients/1/relationships/o-auth-tokens", | |
"related" : "/o-auth-clients/1/o-auth-tokens" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthToken" | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken" | |
} ] | |
} | |
} | |
}, | |
"OAuthClient200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_5" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} | |
} | |
} | |
}, | |
"OAuthClient201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_5" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} | |
} | |
} | |
}, | |
"OAuthClients200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_17" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "OAuthClient", | |
"attributes" : { | |
"oauth_clientable_id" : null, | |
"oauth_clientable_type" : null, | |
"service_provider" : null, | |
"secret_encrypted" : null, | |
"key" : null, | |
"http_url" : null, | |
"api_url" : null, | |
"webhook_secret_encrypted" : null, | |
"string" : null, | |
"uuid" : null, | |
"approved" : null, | |
"global" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"OAuthToken-OAuthClient-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-tokens/1/relationships/o-auth-client", | |
"related" : "/o-auth-tokens/1/o-auth-client" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "OAuthClient" | |
} | |
} | |
} | |
}, | |
"OAuthToken-OAuthTokenable-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/o-auth-tokens/1/relationships/o-auth-tokenable", | |
"related" : "/o-auth-tokens/1/o-auth-tokenable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "OAuthTokenable" | |
} | |
} | |
} | |
}, | |
"OAuthToken200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
} | |
} | |
} | |
}, | |
"OAuthToken201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
} | |
} | |
} | |
}, | |
"OAuthTokens200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_18" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken", | |
"attributes" : { | |
"oauth_tokenable_id" : null, | |
"oauth_tokenable_type" : null, | |
"oauth_provider_id" : null, | |
"value_encrypted" : null, | |
"info_encrypted" : null, | |
"uid" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"oauth_client_id" : null, | |
"anonymous" : null, | |
"refresh_token_encrypted" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"Organization-OAuthClients-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/o-auth-clients", | |
"related" : "/organizations/1/o-auth-clients" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthClient" | |
}, { | |
"id" : 2, | |
"type" : "OAuthClient" | |
} ] | |
} | |
} | |
}, | |
"Organization-OAuthTokens-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/o-auth-tokens", | |
"related" : "/organizations/1/o-auth-tokens" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "OAuthToken" | |
}, { | |
"id" : 2, | |
"type" : "OAuthToken" | |
} ] | |
} | |
} | |
}, | |
"Organization-SshKeys-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/ssh-keys", | |
"related" : "/organizations/1/ssh-keys" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "SshKey" | |
}, { | |
"id" : 2, | |
"type" : "SshKey" | |
} ] | |
} | |
} | |
}, | |
"Organization-Teams-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/teams", | |
"related" : "/organizations/1/teams" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Team" | |
}, { | |
"id" : 2, | |
"type" : "Team" | |
} ] | |
} | |
} | |
}, | |
"Organization-Vars-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/vars", | |
"related" : "/organizations/1/vars" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Var" | |
}, { | |
"id" : 2, | |
"type" : "Var" | |
} ] | |
} | |
} | |
}, | |
"Organization-Workspaces-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/organizations/1/relationships/workspaces", | |
"related" : "/organizations/1/workspaces" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Workspace" | |
}, { | |
"id" : 2, | |
"type" : "Workspace" | |
} ] | |
} | |
} | |
}, | |
"Organization200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_6df0476b", | |
"default_user_id" : null, | |
"email" : "organization_8ebe62b4@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.360+0000", | |
"updated_at" : "2017-06-30T15:44:45.388+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-KLmdPaFek7cGpaTx", | |
"v2_opt_in" : false | |
} | |
} | |
} | |
} | |
}, | |
"Organization201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_6" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_6df0476b", | |
"default_user_id" : null, | |
"email" : "organization_8ebe62b4@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.360+0000", | |
"updated_at" : "2017-06-30T15:44:45.388+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-KLmdPaFek7cGpaTx", | |
"v2_opt_in" : false | |
} | |
} | |
} | |
} | |
}, | |
"Organizations200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_19" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_6df0476b", | |
"default_user_id" : null, | |
"email" : "organization_8ebe62b4@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.360+0000", | |
"updated_at" : "2017-06-30T15:44:45.388+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-KLmdPaFek7cGpaTx", | |
"v2_opt_in" : false | |
} | |
}, { | |
"id" : 1, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_c2ec75fd", | |
"default_user_id" : null, | |
"email" : "organization_4d946ad5@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.428+0000", | |
"updated_at" : "2017-06-30T15:44:45.435+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-QGh7ULqLHiDh3YjE", | |
"v2_opt_in" : false | |
} | |
}, { | |
"id" : 2, | |
"type" : "Organization", | |
"attributes" : { | |
"username" : "organization_66ea7c5b", | |
"default_user_id" : null, | |
"email" : "organization_fb687c8e@hashicorp.com", | |
"profile" : "Organization profile", | |
"trusted" : null, | |
"created_at" : "2017-06-30T15:44:45.446+0000", | |
"updated_at" : "2017-06-30T15:44:45.452+0000", | |
"stripe_customer_id" : null, | |
"plan" : "organization", | |
"current_period_end" : null, | |
"current_card_last4" : null, | |
"delinquent" : null, | |
"billing_degraded" : false, | |
"collaborator_auth_policy" : "password", | |
"access_beta_tools" : false, | |
"enterprise_billing_enabled" : { | |
"nomad" : "false", | |
"vault" : "false", | |
"consul" : "false", | |
"packer" : "false", | |
"vagrant" : "false", | |
"terraform" : "false" | |
}, | |
"terraform_trial_expiration" : null, | |
"vagrant_trial_expiration" : null, | |
"packer_trial_expiration" : null, | |
"terraform_enterprise_whitelisted" : false, | |
"vagrant_enterprise_whitelisted" : false, | |
"packer_enterprise_whitelisted" : false, | |
"session_timeout" : null, | |
"session_remember" : null, | |
"external_id" : "org-ov7EiPt8aQgWVX31", | |
"v2_opt_in" : false | |
} | |
} ] | |
} | |
} | |
}, | |
"Plan-ConfigurationVersion-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/configuration-version", | |
"related" : "/plans/1/configuration-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"Plan-Run-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/run", | |
"related" : "/plans/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"Plan-RunEvents-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/run-events", | |
"related" : "/plans/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"Plan-StateVersions-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/plans/1/relationships/state-versions", | |
"related" : "/plans/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"Plan200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Plan", | |
"attributes" : { | |
"run_id" : 1, | |
"has_changes" : true, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:02.035+0000", | |
"updated_at" : "2017-06-30T15:45:02.182+0000", | |
"archivist_upload_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"Plan201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Plan", | |
"attributes" : { | |
"run_id" : 1, | |
"has_changes" : true, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:02.035+0000", | |
"updated_at" : "2017-06-30T15:45:02.182+0000", | |
"archivist_upload_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"Plans200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_23" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Plan", | |
"attributes" : { | |
"run_id" : 1, | |
"has_changes" : true, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:02.035+0000", | |
"updated_at" : "2017-06-30T15:45:02.182+0000", | |
"archivist_upload_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "Plan", | |
"attributes" : { | |
"run_id" : 2, | |
"has_changes" : true, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:02.709+0000", | |
"updated_at" : "2017-06-30T15:45:02.764+0000", | |
"archivist_upload_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "Plan", | |
"attributes" : { | |
"run_id" : 3, | |
"has_changes" : true, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:03.115+0000", | |
"updated_at" : "2017-06-30T15:45:03.169+0000", | |
"archivist_upload_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"Run-Apply-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/apply", | |
"related" : "/runs/1/apply" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Apply" | |
} | |
} | |
} | |
}, | |
"Run-ConfigurationVersion-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/configuration-version", | |
"related" : "/runs/1/configuration-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"Run-InputStateVersion-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/input-state-version", | |
"related" : "/runs/1/input-state-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "InputStateVersion" | |
} | |
} | |
} | |
}, | |
"Run-Plan-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/plan", | |
"related" : "/runs/1/plan" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Plan" | |
} | |
} | |
} | |
}, | |
"Run-RunEvents-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/run-events", | |
"related" : "/runs/1/run-events" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "RunEvent" | |
}, { | |
"id" : 2, | |
"type" : "RunEvent" | |
} ] | |
} | |
} | |
}, | |
"Run-StateVersions-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/state-versions", | |
"related" : "/runs/1/state-versions" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "StateVersion" | |
}, { | |
"id" : 2, | |
"type" : "StateVersion" | |
} ] | |
} | |
} | |
}, | |
"Run-Workspace-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace", | |
"related" : "/runs/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"Run-WorkspaceComments-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace-comments", | |
"related" : "/runs/1/workspace-comments" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceComment" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceComment" | |
} ] | |
} | |
} | |
}, | |
"Run-WorkspaceRunAlerts-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/runs/1/relationships/workspace-run-alerts", | |
"related" : "/runs/1/workspace-run-alerts" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "WorkspaceRunAlert" | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceRunAlert" | |
} ] | |
} | |
} | |
}, | |
"Run200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
} | |
} | |
} | |
}, | |
"Run201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_1" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
} | |
} | |
} | |
}, | |
"RunEvent-Actor-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/run-events/1/relationships/actor", | |
"related" : "/run-events/1/actor" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Actor" | |
} | |
} | |
} | |
}, | |
"RunEvent-Run-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/run-events/1/relationships/run", | |
"related" : "/run-events/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"RunEvent-Target-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/run-events/1/relationships/target", | |
"related" : "/run-events/1/target" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Target" | |
} | |
} | |
} | |
}, | |
"RunEvent-WorkspaceComment-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/run-events/1/relationships/workspace-comment", | |
"related" : "/run-events/1/workspace-comment" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "WorkspaceComment" | |
} | |
} | |
} | |
}, | |
"RunEvent200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_8" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-a32kyYPZssmyjzPY", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 1, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.220+0000", | |
"updated_at" : "2017-06-30T15:45:37.220+0000" | |
} | |
} | |
} | |
} | |
}, | |
"RunEvent201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_8" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-a32kyYPZssmyjzPY", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 1, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.220+0000", | |
"updated_at" : "2017-06-30T15:45:37.220+0000" | |
} | |
} | |
} | |
} | |
}, | |
"RunEvents200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_2" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-a32kyYPZssmyjzPY", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 1, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.220+0000", | |
"updated_at" : "2017-06-30T15:45:37.220+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-hxcbvhUtm72tX2Hg", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 2, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:37.709+0000", | |
"updated_at" : "2017-06-30T15:45:37.709+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "RunEvent", | |
"attributes" : { | |
"action" : "slothed", | |
"external_id" : "re-LqEa2on28ZQAGYv9", | |
"actor_id" : null, | |
"actor_type" : null, | |
"run_id" : 3, | |
"target_id" : null, | |
"target_type" : null, | |
"created_at" : "2017-06-30T15:45:38.250+0000", | |
"updated_at" : "2017-06-30T15:45:38.250+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"Runs200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_25" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 1, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 2, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:19.553+0000", | |
"updated_at" : "2017-06-30T15:45:19.661+0000", | |
"error_text" : null, | |
"state_id" : 1, | |
"environment_id" : 3, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.2-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 2 | |
} | |
}, { | |
"id" : 1, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 2, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 4, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:20.251+0000", | |
"updated_at" : "2017-06-30T15:45:20.280+0000", | |
"error_text" : null, | |
"state_id" : 2, | |
"environment_id" : 6, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.4-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 4 | |
} | |
}, { | |
"id" : 2, | |
"type" : "Run", | |
"attributes" : { | |
"configuration_version_id" : 3, | |
"version" : 1, | |
"disabled_at" : null, | |
"created_by" : 6, | |
"status" : "pending", | |
"status_timestamps" : { }, | |
"created_at" : "2017-06-30T15:45:20.646+0000", | |
"updated_at" : "2017-06-30T15:45:20.673+0000", | |
"error_text" : null, | |
"state_id" : 3, | |
"environment_id" : 9, | |
"environment_variables_encrypted" : "m0FuXO9kaFs2zmxabaQJJw==", | |
"metadata_encrypted" : "GK7ko40ZUNpmxVQqbEomQTUnOgGvWD3PK5nDgO2QUWw=", | |
"auto_apply" : false, | |
"message" : null, | |
"source" : null, | |
"confirmed_by_id" : null, | |
"terraform_version" : "0.0.6-factory", | |
"is_destroy" : false, | |
"trace_resource_id" : null, | |
"canceled_by_id" : null, | |
"created_by_id" : 6 | |
} | |
} ] | |
} | |
} | |
}, | |
"SshKey-SshKeyable-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/ssh-keys/1/relationships/ssh-keyable", | |
"related" : "/ssh-keys/1/ssh-keyable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "SshKeyable" | |
} | |
} | |
} | |
}, | |
"SshKey200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_9" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 1, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.910+0000", | |
"updated_at" : "2017-06-30T15:45:53.910+0000" | |
} | |
} | |
} | |
} | |
}, | |
"SshKey201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_9" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 1, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.910+0000", | |
"updated_at" : "2017-06-30T15:45:53.910+0000" | |
} | |
} | |
} | |
} | |
}, | |
"SshKeys200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_20" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 1, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.910+0000", | |
"updated_at" : "2017-06-30T15:45:53.910+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 2, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.937+0000", | |
"updated_at" : "2017-06-30T15:45:53.937+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "SshKey", | |
"attributes" : { | |
"ssh_keyable_id" : 3, | |
"ssh_keyable_type" : "Organization", | |
"value_encrypted" : "NuLTr41u2RANYvUNgxF/dw==", | |
"name" : "my first ssh key!", | |
"created_at" : "2017-06-30T15:45:53.963+0000", | |
"updated_at" : "2017-06-30T15:45:53.963+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"StateVersion-Operation-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/state-versions/1/relationships/operation", | |
"related" : "/state-versions/1/operation" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Operation" | |
} | |
} | |
} | |
}, | |
"StateVersion-Run-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/state-versions/1/relationships/run", | |
"related" : "/state-versions/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"StateVersion-Workspace-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/state-versions/1/relationships/workspace", | |
"related" : "/state-versions/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"StateVersion200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_10" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-G2fHqr9njUzpCtJj", | |
"serial" : 92, | |
"created_by_id" : 1, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 1, | |
"created_at" : "2017-06-30T15:46:09.815+0000", | |
"updated_at" : "2017-06-30T15:46:09.815+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"StateVersion201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_10" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-G2fHqr9njUzpCtJj", | |
"serial" : 92, | |
"created_by_id" : 1, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 1, | |
"created_at" : "2017-06-30T15:46:09.815+0000", | |
"updated_at" : "2017-06-30T15:46:09.815+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"StateVersions200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_3" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-G2fHqr9njUzpCtJj", | |
"serial" : 92, | |
"created_by_id" : 1, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 1, | |
"created_at" : "2017-06-30T15:46:09.815+0000", | |
"updated_at" : "2017-06-30T15:46:09.815+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-3NFHTDYk7aQtixha", | |
"serial" : 75, | |
"created_by_id" : 2, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 2, | |
"created_at" : "2017-06-30T15:46:09.991+0000", | |
"updated_at" : "2017-06-30T15:46:09.991+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "StateVersion", | |
"attributes" : { | |
"external_id" : "sv-Na1RijiwR8BdGvZS", | |
"serial" : 27, | |
"created_by_id" : 3, | |
"resources" : null, | |
"resources_count" : null, | |
"tfstate_file_encrypted" : null, | |
"workspace_id" : 3, | |
"created_at" : "2017-06-30T15:46:10.158+0000", | |
"updated_at" : "2017-06-30T15:46:10.158+0000", | |
"operation_id" : null, | |
"operation_type" : null, | |
"run_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"Team-Collaborations-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/collaborations", | |
"related" : "/teams/1/collaborations" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Collaboration" | |
}, { | |
"id" : 2, | |
"type" : "Collaboration" | |
} ] | |
} | |
} | |
}, | |
"Team-Members-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/members", | |
"related" : "/teams/1/members" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Member" | |
}, { | |
"id" : 2, | |
"type" : "Member" | |
} ] | |
} | |
} | |
}, | |
"Team-Memberships-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/memberships", | |
"related" : "/teams/1/memberships" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "Membership" | |
}, { | |
"id" : 2, | |
"type" : "Membership" | |
} ] | |
} | |
} | |
}, | |
"Team-Organization-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/teams/1/relationships/organization", | |
"related" : "/teams/1/organization" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Organization" | |
} | |
} | |
} | |
}, | |
"Team200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_9" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 1, | |
"name" : "team_1", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.211+0000", | |
"updated_at" : "2017-06-30T15:46:25.211+0000" | |
} | |
} | |
} | |
} | |
}, | |
"Team201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_9" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 1, | |
"name" : "team_1", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.211+0000", | |
"updated_at" : "2017-06-30T15:46:25.211+0000" | |
} | |
} | |
} | |
} | |
}, | |
"Teams200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_21" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 1, | |
"name" : "team_1", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.211+0000", | |
"updated_at" : "2017-06-30T15:46:25.211+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 2, | |
"name" : "team_2", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.235+0000", | |
"updated_at" : "2017-06-30T15:46:25.235+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "Team", | |
"attributes" : { | |
"organization_id" : 3, | |
"name" : "team_3", | |
"default_user_id" : null, | |
"created_at" : "2017-06-30T15:46:25.259+0000", | |
"updated_at" : "2017-06-30T15:46:25.259+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"ToolVersion200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_11" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ToolVersion", | |
"attributes" : { | |
"tool" : "terraform", | |
"version" : "0.0.1-factory", | |
"url" : "https://releases.hashicorp.com/terraform/0.6.16/terraform_0.6.16_linux_amd64.zip", | |
"sha" : "e10987bca7ec15301bc2fd152795d51cfc9fdbe6c70c9708e6e2ed81eaa1f082", | |
"official" : false, | |
"enabled" : true, | |
"beta" : false | |
} | |
} | |
} | |
} | |
}, | |
"ToolVersion201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_11" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "ToolVersion", | |
"attributes" : { | |
"tool" : "terraform", | |
"version" : "0.0.1-factory", | |
"url" : "https://releases.hashicorp.com/terraform/0.6.16/terraform_0.6.16_linux_amd64.zip", | |
"sha" : "e10987bca7ec15301bc2fd152795d51cfc9fdbe6c70c9708e6e2ed81eaa1f082", | |
"official" : false, | |
"enabled" : true, | |
"beta" : false | |
} | |
} | |
} | |
} | |
}, | |
"ToolVersions200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_28" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "ToolVersion", | |
"attributes" : { | |
"tool" : "terraform", | |
"version" : "0.0.1-factory", | |
"url" : "https://releases.hashicorp.com/terraform/0.6.16/terraform_0.6.16_linux_amd64.zip", | |
"sha" : "e10987bca7ec15301bc2fd152795d51cfc9fdbe6c70c9708e6e2ed81eaa1f082", | |
"official" : false, | |
"enabled" : true, | |
"beta" : false | |
} | |
}, { | |
"id" : 1, | |
"type" : "ToolVersion", | |
"attributes" : { | |
"tool" : "terraform", | |
"version" : "0.0.2-factory", | |
"url" : "https://releases.hashicorp.com/terraform/0.6.16/terraform_0.6.16_linux_amd64.zip", | |
"sha" : "e10987bca7ec15301bc2fd152795d51cfc9fdbe6c70c9708e6e2ed81eaa1f082", | |
"official" : false, | |
"enabled" : true, | |
"beta" : false | |
} | |
}, { | |
"id" : 2, | |
"type" : "ToolVersion", | |
"attributes" : { | |
"tool" : "terraform", | |
"version" : "0.0.3-factory", | |
"url" : "https://releases.hashicorp.com/terraform/0.6.16/terraform_0.6.16_linux_amd64.zip", | |
"sha" : "e10987bca7ec15301bc2fd152795d51cfc9fdbe6c70c9708e6e2ed81eaa1f082", | |
"official" : false, | |
"enabled" : true, | |
"beta" : false | |
} | |
} ] | |
} | |
} | |
}, | |
"Unauthorized401" : { | |
"description" : "Unauthorized" | |
}, | |
"Var-Configurable-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vars/1/relationships/configurable", | |
"related" : "/vars/1/configurable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Configurable" | |
} | |
} | |
} | |
}, | |
"Var-User-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vars/1/relationships/user", | |
"related" : "/vars/1/user" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "User" | |
} | |
} | |
} | |
}, | |
"Var200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_12" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "769dab7890db549bfc7c194074bc2107", | |
"value_encrypted" : "r6wQb715eC9oKqG1MLPLlI1XJ52j4HYs3qKMSbVGv/b2Dj1RkAxXPst28TOMSvin", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "packer", | |
"configurable_id" : 1, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.134+0000", | |
"updated_at" : "2017-06-30T15:46:56.134+0000" | |
} | |
} | |
} | |
} | |
}, | |
"Var201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_12" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "769dab7890db549bfc7c194074bc2107", | |
"value_encrypted" : "r6wQb715eC9oKqG1MLPLlI1XJ52j4HYs3qKMSbVGv/b2Dj1RkAxXPst28TOMSvin", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "packer", | |
"configurable_id" : 1, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.134+0000", | |
"updated_at" : "2017-06-30T15:46:56.134+0000" | |
} | |
} | |
} | |
} | |
}, | |
"Vars200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_22" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "769dab7890db549bfc7c194074bc2107", | |
"value_encrypted" : "r6wQb715eC9oKqG1MLPLlI1XJ52j4HYs3qKMSbVGv/b2Dj1RkAxXPst28TOMSvin", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "packer", | |
"configurable_id" : 1, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.134+0000", | |
"updated_at" : "2017-06-30T15:46:56.134+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "b0e644210599d1b014493eb497394d88", | |
"value_encrypted" : "29p2ifp8aonHVTnvGcBcNigi/rErHip28RVmReAbRXR+1bUcuKUSLNtdDKE55B9v", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "terraform", | |
"configurable_id" : 2, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.176+0000", | |
"updated_at" : "2017-06-30T15:46:56.176+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "Var", | |
"attributes" : { | |
"key" : "4e29784bb2a65ca013684cbbe375e4fe", | |
"value_encrypted" : "qkBSH9uKGkVG92tnS8A9TqevQ0PIGcnS8DWp8K0a3PjI5tvg0a1GwaYlGFBQmkwj", | |
"sensitive" : false, | |
"hcl" : false, | |
"category" : "packer", | |
"configurable_id" : 3, | |
"configurable_type" : "Workspace", | |
"variable_set_id" : null, | |
"owner_id" : null, | |
"created_at" : "2017-06-30T15:46:56.215+0000", | |
"updated_at" : "2017-06-30T15:46:56.215+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"Vcs::Repo-IngressTriggers-relationships200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToManyRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/ingress-triggers", | |
"related" : "/vcs/repos/1/ingress-triggers" | |
}, | |
"data" : [ { | |
"id" : 1, | |
"type" : "IngressTrigger" | |
}, { | |
"id" : 2, | |
"type" : "IngressTrigger" | |
} ] | |
} | |
} | |
}, | |
"Vcs::Repo-OAuthToken-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/o-auth-token", | |
"related" : "/vcs/repos/1/o-auth-token" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "OAuthToken" | |
} | |
} | |
} | |
}, | |
"Vcs::Repo-Organization-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/organization", | |
"related" : "/vcs/repos/1/organization" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Organization" | |
} | |
} | |
} | |
}, | |
"Vcs::Repo-SshKey-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/vcs/repos/1/relationships/ssh-key", | |
"related" : "/vcs/repos/1/ssh-key" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "SshKey" | |
} | |
} | |
} | |
}, | |
"VcsRepo200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"VcsRepo201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"VcsRepos200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_29" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "VcsRepo", | |
"attributes" : { | |
"external_id" : null, | |
"identifier" : null, | |
"oauth_token_id" : null, | |
"organization_id" : null, | |
"ssh_key_id" : null, | |
"vcs_host_id" : null, | |
"created_at" : null, | |
"updated_at" : null, | |
"created_by_id" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"Workspace-ConfigurationVersion-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/configuration-version", | |
"related" : "/workspaces/1/configuration-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"Workspace-Run-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/run", | |
"related" : "/workspaces/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"Workspace-StateVersion-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/state-version", | |
"related" : "/workspaces/1/state-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "StateVersion" | |
} | |
} | |
} | |
}, | |
"Workspace-Var-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/var", | |
"related" : "/workspaces/1/var" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Var" | |
} | |
} | |
} | |
}, | |
"Workspace-VcsRepo-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspaces/1/relationships/vcs-repo", | |
"related" : "/workspaces/1/vcs-repo" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "VcsRepo" | |
} | |
} | |
} | |
}, | |
"Workspace200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"Workspace201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_7" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} | |
} | |
} | |
}, | |
"WorkspaceComment-Commentable-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-comments/1/relationships/commentable", | |
"related" : "/workspace-comments/1/commentable" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Commentable" | |
} | |
} | |
} | |
}, | |
"WorkspaceComment-RunEvent-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-comments/1/relationships/run-event", | |
"related" : "/workspace-comments/1/run-event" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "RunEvent" | |
} | |
} | |
} | |
}, | |
"WorkspaceComment200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_24" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 1, | |
"commentable_type" : "Run", | |
"user_id" : 4, | |
"run_event_id" : 2, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:01.125+0000", | |
"updated_at" : "2017-06-30T15:48:01.125+0000" | |
} | |
} | |
} | |
} | |
}, | |
"WorkspaceComment201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_24" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 1, | |
"commentable_type" : "Run", | |
"user_id" : 4, | |
"run_event_id" : 2, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:01.125+0000", | |
"updated_at" : "2017-06-30T15:48:01.125+0000" | |
} | |
} | |
} | |
} | |
}, | |
"WorkspaceComments200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_26" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 1, | |
"commentable_type" : "Run", | |
"user_id" : 4, | |
"run_event_id" : 2, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:01.125+0000", | |
"updated_at" : "2017-06-30T15:48:01.125+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 2, | |
"commentable_type" : "Run", | |
"user_id" : 8, | |
"run_event_id" : 4, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:01.885+0000", | |
"updated_at" : "2017-06-30T15:48:01.885+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceComment", | |
"attributes" : { | |
"commentable_id" : 3, | |
"commentable_type" : "Run", | |
"user_id" : 12, | |
"run_event_id" : 6, | |
"body" : "hi!", | |
"created_at" : "2017-06-30T15:48:02.414+0000", | |
"updated_at" : "2017-06-30T15:48:02.414+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"WorkspaceConfigurationVersion-ConfigurationVersion-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-configuration-versions/1/relationships/configuration-version", | |
"related" : "/workspace-configuration-versions/1/configuration-version" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "ConfigurationVersion" | |
} | |
} | |
} | |
}, | |
"WorkspaceConfigurationVersion-Workspace-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-configuration-versions/1/relationships/workspace", | |
"related" : "/workspace-configuration-versions/1/workspace" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Workspace" | |
} | |
} | |
} | |
}, | |
"WorkspaceConfigurationVersion200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} | |
} | |
} | |
}, | |
"WorkspaceConfigurationVersion201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_13" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} | |
} | |
} | |
}, | |
"WorkspaceConfigurationVersions200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_14" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
}, { | |
"id" : 1, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceConfigurationVersion", | |
"attributes" : { | |
"workspace_id" : null, | |
"configuration_version_id" : null, | |
"external_id" : null, | |
"created_at" : null, | |
"updated_at" : null | |
} | |
} ] | |
} | |
} | |
}, | |
"WorkspaceRunAlert-Run-relationship200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/ToOneRelationship" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"links" : { | |
"self" : "/workspace-run-alerts/1/relationships/run", | |
"related" : "/workspace-run-alerts/1/run" | |
}, | |
"data" : { | |
"id" : 1, | |
"type" : "Run" | |
} | |
} | |
} | |
}, | |
"WorkspaceRunAlert200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_14" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 1, | |
"external_id" : "ra-YxPjc6YND7gf4m6x", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:34.277+0000", | |
"updated_at" : "2017-06-30T15:48:34.277+0000" | |
} | |
} | |
} | |
} | |
}, | |
"WorkspaceRunAlert201" : { | |
"description" : "Created", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_201_14" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : { | |
"id" : 0, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 1, | |
"external_id" : "ra-YxPjc6YND7gf4m6x", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:34.277+0000", | |
"updated_at" : "2017-06-30T15:48:34.277+0000" | |
} | |
} | |
} | |
} | |
}, | |
"WorkspaceRunAlerts200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_27" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 0, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 1, | |
"external_id" : "ra-YxPjc6YND7gf4m6x", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:34.277+0000", | |
"updated_at" : "2017-06-30T15:48:34.277+0000" | |
} | |
}, { | |
"id" : 1, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 2, | |
"external_id" : "ra-3G8bLcCCet96z6wn", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:34.776+0000", | |
"updated_at" : "2017-06-30T15:48:34.776+0000" | |
} | |
}, { | |
"id" : 2, | |
"type" : "WorkspaceRunAlert", | |
"attributes" : { | |
"run_id" : 3, | |
"external_id" : "ra-dVJGFp4rEqXe5BSJ", | |
"status" : "planned", | |
"created_at" : "2017-06-30T15:48:35.407+0000", | |
"updated_at" : "2017-06-30T15:48:35.407+0000" | |
} | |
} ] | |
} | |
} | |
}, | |
"Workspaces200" : { | |
"description" : "OK", | |
"schema" : { | |
"$ref" : "#/definitions/inline_response_200_15" | |
}, | |
"examples" : { | |
"application/vnd.api+json" : { | |
"data" : [ { | |
"id" : 1, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothfort", | |
"external_id" : "ws-TcHJbm7SarS8DR4r", | |
"organization_id" : 1, | |
"created_at" : "2017-06-30T15:47:44.200+0000", | |
"updated_at" : "2017-06-30T15:47:44.200+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.1-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
}, { | |
"id" : 2, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothzone", | |
"external_id" : "ws-jPfYBzKbkXf9kUFG", | |
"organization_id" : 2, | |
"created_at" : "2017-06-30T15:47:44.231+0000", | |
"updated_at" : "2017-06-30T15:47:44.231+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.2-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
}, { | |
"id" : 3, | |
"type" : "Workspace", | |
"attributes" : { | |
"name" : "slothspace", | |
"external_id" : "ws-9kF4y9q3DZ9bvJtL", | |
"organization_id" : 3, | |
"created_at" : "2017-06-30T15:47:44.262+0000", | |
"updated_at" : "2017-06-30T15:47:44.262+0000", | |
"archived_at" : null, | |
"auto_apply" : false, | |
"periodic_run" : 0, | |
"queue_run_on_artifact_upload" : false, | |
"mfa_setting" : null, | |
"terraform_version" : "0.0.3-factory", | |
"variable_set_id" : null, | |
"current_state_version_id" : null, | |
"current_configuration_version_id" : null, | |
"trace_resource_id" : null | |
} | |
} ] | |
} | |
} | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment