Last active
June 24, 2024 16:22
-
-
Save alfespa17/785a36879a79ac5c3b79d7150a71c2d1 to your computer and use it in GitHub Desktop.
This file contains hidden or 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
| { | |
| "openapi": "3.0.1", | |
| "info": { | |
| "title": "Elide Service" | |
| }, | |
| "servers": [ | |
| { | |
| "url": "/api/v1" | |
| } | |
| ], | |
| "tags": [ | |
| { | |
| "name": "action" | |
| }, | |
| { | |
| "name": "agent" | |
| }, | |
| { | |
| "name": "globalvar" | |
| }, | |
| { | |
| "name": "history" | |
| }, | |
| { | |
| "name": "implementation" | |
| }, | |
| { | |
| "name": "job" | |
| }, | |
| { | |
| "name": "module" | |
| }, | |
| { | |
| "name": "organization" | |
| }, | |
| { | |
| "name": "provider" | |
| }, | |
| { | |
| "name": "schedule" | |
| }, | |
| { | |
| "name": "ssh" | |
| }, | |
| { | |
| "name": "step" | |
| }, | |
| { | |
| "name": "tag" | |
| }, | |
| { | |
| "name": "team" | |
| }, | |
| { | |
| "name": "template" | |
| }, | |
| { | |
| "name": "variable" | |
| }, | |
| { | |
| "name": "vcs" | |
| }, | |
| { | |
| "name": "version" | |
| }, | |
| { | |
| "name": "webhook" | |
| }, | |
| { | |
| "name": "workspace" | |
| }, | |
| { | |
| "name": "workspacetag" | |
| } | |
| ], | |
| "paths": { | |
| "/template/{templateId}/organization": { | |
| "get": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Returns the relationship organization", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "-description", | |
| "disabled", | |
| "-disabled", | |
| "executionMode", | |
| "-executionMode", | |
| "name", | |
| "-name", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[organization]", | |
| "in": "query", | |
| "description": "Selects the set of organization fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "disabled", | |
| "executionMode", | |
| "name", | |
| "agent", | |
| "globalvar", | |
| "job", | |
| "module", | |
| "provider", | |
| "ssh", | |
| "tag", | |
| "team", | |
| "template", | |
| "vcs", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "agent", | |
| "globalvar", | |
| "job", | |
| "module", | |
| "provider", | |
| "ssh", | |
| "tag", | |
| "team", | |
| "template", | |
| "vcs", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[organization]", | |
| "in": "query", | |
| "description": "Filters the collection of organization using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/organization" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Creates an item of type organization and adds it to organization", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "templateId", | |
| "in": "path", | |
| "description": "template Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/template/{templateId}/organization/{organizationId}": { | |
| "get": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Returns an instance of type organization", | |
| "parameters": [ | |
| { | |
| "name": "fields[organization]", | |
| "in": "query", | |
| "description": "Selects the set of organization fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "disabled", | |
| "executionMode", | |
| "name", | |
| "agent", | |
| "globalvar", | |
| "job", | |
| "module", | |
| "provider", | |
| "ssh", | |
| "tag", | |
| "team", | |
| "template", | |
| "vcs", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "agent", | |
| "globalvar", | |
| "job", | |
| "module", | |
| "provider", | |
| "ssh", | |
| "tag", | |
| "team", | |
| "template", | |
| "vcs", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Deletes an instance of type organization", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Modifies an instance of type organization", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "templateId", | |
| "in": "path", | |
| "description": "template Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/template/{templateId}/relationships/organization": { | |
| "get": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Returns the relationship identifiers for organization", | |
| "parameters": [ | |
| { | |
| "name": "filter[organization]", | |
| "in": "query", | |
| "description": "Filters the collection of organization using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Replaces the relationship organization", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "templateId", | |
| "in": "path", | |
| "description": "template Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/team": { | |
| "get": { | |
| "tags": [ | |
| "team" | |
| ], | |
| "description": "Returns the relationship team", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "manageModule", | |
| "-manageModule", | |
| "manageProvider", | |
| "-manageProvider", | |
| "manageTemplate", | |
| "-manageTemplate", | |
| "manageVcs", | |
| "-manageVcs", | |
| "manageWorkspace", | |
| "-manageWorkspace", | |
| "name", | |
| "-name", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[team]", | |
| "in": "query", | |
| "description": "Selects the set of team fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "manageModule", | |
| "manageProvider", | |
| "manageTemplate", | |
| "manageVcs", | |
| "manageWorkspace", | |
| "name", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[team]", | |
| "in": "query", | |
| "description": "Filters the collection of team using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/team" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "team" | |
| ], | |
| "description": "Creates an item of type team and adds it to team", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/team" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/team" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/team/{teamId}": { | |
| "get": { | |
| "tags": [ | |
| "team" | |
| ], | |
| "description": "Returns an instance of type team", | |
| "parameters": [ | |
| { | |
| "name": "fields[team]", | |
| "in": "query", | |
| "description": "Selects the set of team fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "manageModule", | |
| "manageProvider", | |
| "manageTemplate", | |
| "manageVcs", | |
| "manageWorkspace", | |
| "name", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/team" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "team" | |
| ], | |
| "description": "Deletes an instance of type team", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "team" | |
| ], | |
| "description": "Modifies an instance of type team", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/team" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "teamId", | |
| "in": "path", | |
| "description": "team Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/relationships/team": { | |
| "get": { | |
| "tags": [ | |
| "team" | |
| ], | |
| "description": "Returns the relationship identifiers for team", | |
| "parameters": [ | |
| { | |
| "name": "filter[team]", | |
| "in": "query", | |
| "description": "Filters the collection of team using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "team" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "team" | |
| ], | |
| "description": "Adds items to the relationship team", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "team" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "team" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "team" | |
| ], | |
| "description": "Deletes items from the relationship team", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "team" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "team" | |
| ], | |
| "description": "Replaces the relationship team", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "team" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/template": { | |
| "get": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Returns the relationship template", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "-createdBy", | |
| "description", | |
| "-description", | |
| "name", | |
| "-name", | |
| "tcl", | |
| "-tcl", | |
| "updatedBy", | |
| "-updatedBy", | |
| "version", | |
| "-version", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[template]", | |
| "in": "query", | |
| "description": "Selects the set of template fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "name", | |
| "tcl", | |
| "updatedBy", | |
| "updatedDate", | |
| "version", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[template]", | |
| "in": "query", | |
| "description": "Filters the collection of template using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/template" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Creates an item of type template and adds it to template", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/template" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/template" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/template/{templateId}": { | |
| "get": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Returns an instance of type template", | |
| "parameters": [ | |
| { | |
| "name": "fields[template]", | |
| "in": "query", | |
| "description": "Selects the set of template fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "name", | |
| "tcl", | |
| "updatedBy", | |
| "updatedDate", | |
| "version", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/template" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Deletes an instance of type template", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Modifies an instance of type template", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/template" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "templateId", | |
| "in": "path", | |
| "description": "template Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/relationships/template": { | |
| "get": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Returns the relationship identifiers for template", | |
| "parameters": [ | |
| { | |
| "name": "filter[template]", | |
| "in": "query", | |
| "description": "Filters the collection of template using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "template" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Adds items to the relationship template", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "template" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "template" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Deletes items from the relationship template", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "template" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Replaces the relationship template", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "template" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/module": { | |
| "get": { | |
| "tags": [ | |
| "module" | |
| ], | |
| "description": "Returns the relationship module", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "-createdBy", | |
| "description", | |
| "-description", | |
| "downloadQuantity", | |
| "-downloadQuantity", | |
| "folder", | |
| "-folder", | |
| "name", | |
| "-name", | |
| "provider", | |
| "-provider", | |
| "registryPath", | |
| "-registryPath", | |
| "source", | |
| "-source", | |
| "tagPrefix", | |
| "-tagPrefix", | |
| "updatedBy", | |
| "-updatedBy", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[module]", | |
| "in": "query", | |
| "description": "Selects the set of module fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "downloadQuantity", | |
| "folder", | |
| "name", | |
| "provider", | |
| "registryPath", | |
| "source", | |
| "tagPrefix", | |
| "updatedBy", | |
| "updatedDate", | |
| "versions", | |
| "organization", | |
| "ssh", | |
| "vcs" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization", | |
| "ssh", | |
| "vcs" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[module]", | |
| "in": "query", | |
| "description": "Filters the collection of module using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/module" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "module" | |
| ], | |
| "description": "Creates an item of type module and adds it to module", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/module" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/module" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/module/{moduleId}": { | |
| "get": { | |
| "tags": [ | |
| "module" | |
| ], | |
| "description": "Returns an instance of type module", | |
| "parameters": [ | |
| { | |
| "name": "fields[module]", | |
| "in": "query", | |
| "description": "Selects the set of module fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "downloadQuantity", | |
| "folder", | |
| "name", | |
| "provider", | |
| "registryPath", | |
| "source", | |
| "tagPrefix", | |
| "updatedBy", | |
| "updatedDate", | |
| "versions", | |
| "organization", | |
| "ssh", | |
| "vcs" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization", | |
| "ssh", | |
| "vcs" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/module" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "module" | |
| ], | |
| "description": "Deletes an instance of type module", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "module" | |
| ], | |
| "description": "Modifies an instance of type module", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/module" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "moduleId", | |
| "in": "path", | |
| "description": "module Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/relationships/module": { | |
| "get": { | |
| "tags": [ | |
| "module" | |
| ], | |
| "description": "Returns the relationship identifiers for module", | |
| "parameters": [ | |
| { | |
| "name": "filter[module]", | |
| "in": "query", | |
| "description": "Filters the collection of module using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "module" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "module" | |
| ], | |
| "description": "Adds items to the relationship module", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "module" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "module" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "module" | |
| ], | |
| "description": "Deletes items from the relationship module", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "module" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "module" | |
| ], | |
| "description": "Replaces the relationship module", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "module" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/action": { | |
| "get": { | |
| "tags": [ | |
| "action" | |
| ], | |
| "description": "Returns the collection of type action", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "action", | |
| "-action", | |
| "active", | |
| "-active", | |
| "category", | |
| "-category", | |
| "createdBy", | |
| "-createdBy", | |
| "description", | |
| "-description", | |
| "displayCriteria", | |
| "-displayCriteria", | |
| "label", | |
| "-label", | |
| "name", | |
| "-name", | |
| "type", | |
| "-type", | |
| "updatedBy", | |
| "-updatedBy", | |
| "version", | |
| "-version", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[action]", | |
| "in": "query", | |
| "description": "Selects the set of action fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "action", | |
| "active", | |
| "category", | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "displayCriteria", | |
| "label", | |
| "name", | |
| "type", | |
| "updatedBy", | |
| "updatedDate", | |
| "version" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[action]", | |
| "in": "query", | |
| "description": "Filters the collection of action using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "filter", | |
| "in": "query", | |
| "description": "Filters the collection of action using a 'joined' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/action" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "action" | |
| ], | |
| "description": "Creates an item of type action", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/action" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/action" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/action/{actionId}": { | |
| "get": { | |
| "tags": [ | |
| "action" | |
| ], | |
| "description": "Returns an instance of type action", | |
| "parameters": [ | |
| { | |
| "name": "fields[action]", | |
| "in": "query", | |
| "description": "Selects the set of action fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "action", | |
| "active", | |
| "category", | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "displayCriteria", | |
| "label", | |
| "name", | |
| "type", | |
| "updatedBy", | |
| "updatedDate", | |
| "version" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/action" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "action" | |
| ], | |
| "description": "Deletes an instance of type action", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "action" | |
| ], | |
| "description": "Modifies an instance of type action", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/action" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "actionId", | |
| "in": "path", | |
| "description": "action Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/agent": { | |
| "get": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Returns the relationship agent", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "-description", | |
| "name", | |
| "-name", | |
| "url", | |
| "-url", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[agent]", | |
| "in": "query", | |
| "description": "Selects the set of agent fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "name", | |
| "url", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[agent]", | |
| "in": "query", | |
| "description": "Filters the collection of agent using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/agent" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Creates an item of type agent and adds it to agent", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/agent" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/agent" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/agent/{agentId}": { | |
| "get": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Returns an instance of type agent", | |
| "parameters": [ | |
| { | |
| "name": "fields[agent]", | |
| "in": "query", | |
| "description": "Selects the set of agent fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "name", | |
| "url", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/agent" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Deletes an instance of type agent", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Modifies an instance of type agent", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/agent" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "description": "agent Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/relationships/agent": { | |
| "get": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Returns the relationship identifiers for agent", | |
| "parameters": [ | |
| { | |
| "name": "filter[agent]", | |
| "in": "query", | |
| "description": "Filters the collection of agent using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "agent" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Replaces the relationship agent", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "agent" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/provider/{providerId}/version/{versionId}/implementation": { | |
| "get": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Returns the relationship implementation", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "arch", | |
| "-arch", | |
| "asciiArmor", | |
| "-asciiArmor", | |
| "downloadUrl", | |
| "-downloadUrl", | |
| "filename", | |
| "-filename", | |
| "keyId", | |
| "-keyId", | |
| "os", | |
| "-os", | |
| "shasum", | |
| "-shasum", | |
| "shasumsSignatureUrl", | |
| "-shasumsSignatureUrl", | |
| "shasumsUrl", | |
| "-shasumsUrl", | |
| "source", | |
| "-source", | |
| "sourceUrl", | |
| "-sourceUrl", | |
| "trustSignature", | |
| "-trustSignature", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[implementation]", | |
| "in": "query", | |
| "description": "Selects the set of implementation fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "arch", | |
| "asciiArmor", | |
| "downloadUrl", | |
| "filename", | |
| "keyId", | |
| "os", | |
| "shasum", | |
| "shasumsSignatureUrl", | |
| "shasumsUrl", | |
| "source", | |
| "sourceUrl", | |
| "trustSignature", | |
| "version" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "version" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[implementation]", | |
| "in": "query", | |
| "description": "Filters the collection of implementation using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/implementation" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Creates an item of type implementation and adds it to implementation", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/implementation" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/implementation" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "providerId", | |
| "in": "path", | |
| "description": "provider Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "versionId", | |
| "in": "path", | |
| "description": "version Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/provider/{providerId}/version/{versionId}/implementation/{implementationId}": { | |
| "get": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Returns an instance of type implementation", | |
| "parameters": [ | |
| { | |
| "name": "fields[implementation]", | |
| "in": "query", | |
| "description": "Selects the set of implementation fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "arch", | |
| "asciiArmor", | |
| "downloadUrl", | |
| "filename", | |
| "keyId", | |
| "os", | |
| "shasum", | |
| "shasumsSignatureUrl", | |
| "shasumsUrl", | |
| "source", | |
| "sourceUrl", | |
| "trustSignature", | |
| "version" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "version" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/implementation" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Deletes an instance of type implementation", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Modifies an instance of type implementation", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/implementation" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "providerId", | |
| "in": "path", | |
| "description": "provider Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "versionId", | |
| "in": "path", | |
| "description": "version Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "implementationId", | |
| "in": "path", | |
| "description": "implementation Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/provider/{providerId}/version/{versionId}/relationships/implementation": { | |
| "get": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Returns the relationship identifiers for implementation", | |
| "parameters": [ | |
| { | |
| "name": "filter[implementation]", | |
| "in": "query", | |
| "description": "Filters the collection of implementation using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "implementation" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Adds items to the relationship implementation", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "implementation" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "implementation" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Deletes items from the relationship implementation", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "implementation" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Replaces the relationship implementation", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "implementation" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "providerId", | |
| "in": "path", | |
| "description": "provider Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "versionId", | |
| "in": "path", | |
| "description": "version Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization": { | |
| "get": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Returns the collection of type organization", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "-description", | |
| "disabled", | |
| "-disabled", | |
| "executionMode", | |
| "-executionMode", | |
| "name", | |
| "-name", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[organization]", | |
| "in": "query", | |
| "description": "Selects the set of organization fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "disabled", | |
| "executionMode", | |
| "name", | |
| "agent", | |
| "globalvar", | |
| "job", | |
| "module", | |
| "provider", | |
| "ssh", | |
| "tag", | |
| "team", | |
| "template", | |
| "vcs", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "agent", | |
| "globalvar", | |
| "job", | |
| "module", | |
| "provider", | |
| "ssh", | |
| "tag", | |
| "team", | |
| "template", | |
| "vcs", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[organization]", | |
| "in": "query", | |
| "description": "Filters the collection of organization using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "filter", | |
| "in": "query", | |
| "description": "Filters the collection of organization using a 'joined' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/organization" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Creates an item of type organization", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/organization/{organizationId}": { | |
| "get": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Returns an instance of type organization", | |
| "parameters": [ | |
| { | |
| "name": "fields[organization]", | |
| "in": "query", | |
| "description": "Selects the set of organization fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "disabled", | |
| "executionMode", | |
| "name", | |
| "agent", | |
| "globalvar", | |
| "job", | |
| "module", | |
| "provider", | |
| "ssh", | |
| "tag", | |
| "team", | |
| "template", | |
| "vcs", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "agent", | |
| "globalvar", | |
| "job", | |
| "module", | |
| "provider", | |
| "ssh", | |
| "tag", | |
| "team", | |
| "template", | |
| "vcs", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Deletes an instance of type organization", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Modifies an instance of type organization", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/vcs": { | |
| "get": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Returns the relationship vcs", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "accessToken", | |
| "-accessToken", | |
| "apiUrl", | |
| "-apiUrl", | |
| "callback", | |
| "-callback", | |
| "clientId", | |
| "-clientId", | |
| "clientSecret", | |
| "-clientSecret", | |
| "createdBy", | |
| "-createdBy", | |
| "description", | |
| "-description", | |
| "endpoint", | |
| "-endpoint", | |
| "name", | |
| "-name", | |
| "redirectUrl", | |
| "-redirectUrl", | |
| "updatedBy", | |
| "-updatedBy", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[vcs]", | |
| "in": "query", | |
| "description": "Selects the set of vcs fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "accessToken", | |
| "apiUrl", | |
| "callback", | |
| "clientId", | |
| "clientSecret", | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "endpoint", | |
| "name", | |
| "redirectUrl", | |
| "status", | |
| "updatedBy", | |
| "updatedDate", | |
| "vcsType", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[vcs]", | |
| "in": "query", | |
| "description": "Filters the collection of vcs using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/vcs" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Creates an item of type vcs and adds it to vcs", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/vcs" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/vcs" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/vcs/{vcsId}": { | |
| "get": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Returns an instance of type vcs", | |
| "parameters": [ | |
| { | |
| "name": "fields[vcs]", | |
| "in": "query", | |
| "description": "Selects the set of vcs fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "accessToken", | |
| "apiUrl", | |
| "callback", | |
| "clientId", | |
| "clientSecret", | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "endpoint", | |
| "name", | |
| "redirectUrl", | |
| "status", | |
| "updatedBy", | |
| "updatedDate", | |
| "vcsType", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/vcs" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Deletes an instance of type vcs", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Modifies an instance of type vcs", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/vcs" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "vcsId", | |
| "in": "path", | |
| "description": "vcs Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/relationships/vcs": { | |
| "get": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Returns the relationship identifiers for vcs", | |
| "parameters": [ | |
| { | |
| "name": "filter[vcs]", | |
| "in": "query", | |
| "description": "Filters the collection of vcs using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Replaces the relationship vcs", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/globalvar": { | |
| "get": { | |
| "tags": [ | |
| "globalvar" | |
| ], | |
| "description": "Returns the relationship globalvar", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "-description", | |
| "hcl", | |
| "-hcl", | |
| "key", | |
| "-key", | |
| "sensitive", | |
| "-sensitive", | |
| "value", | |
| "-value", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[globalvar]", | |
| "in": "query", | |
| "description": "Selects the set of globalvar fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "category", | |
| "description", | |
| "hcl", | |
| "key", | |
| "sensitive", | |
| "value", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[globalvar]", | |
| "in": "query", | |
| "description": "Filters the collection of globalvar using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/globalvar" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "globalvar" | |
| ], | |
| "description": "Creates an item of type globalvar and adds it to globalvar", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/globalvar" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/globalvar" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/globalvar/{globalvarId}": { | |
| "get": { | |
| "tags": [ | |
| "globalvar" | |
| ], | |
| "description": "Returns an instance of type globalvar", | |
| "parameters": [ | |
| { | |
| "name": "fields[globalvar]", | |
| "in": "query", | |
| "description": "Selects the set of globalvar fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "category", | |
| "description", | |
| "hcl", | |
| "key", | |
| "sensitive", | |
| "value", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/globalvar" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "globalvar" | |
| ], | |
| "description": "Deletes an instance of type globalvar", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "globalvar" | |
| ], | |
| "description": "Modifies an instance of type globalvar", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/globalvar" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "globalvarId", | |
| "in": "path", | |
| "description": "globalvar Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/relationships/globalvar": { | |
| "get": { | |
| "tags": [ | |
| "globalvar" | |
| ], | |
| "description": "Returns the relationship identifiers for globalvar", | |
| "parameters": [ | |
| { | |
| "name": "filter[globalvar]", | |
| "in": "query", | |
| "description": "Filters the collection of globalvar using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "globalvar" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "globalvar" | |
| ], | |
| "description": "Adds items to the relationship globalvar", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "globalvar" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "globalvar" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "globalvar" | |
| ], | |
| "description": "Deletes items from the relationship globalvar", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "globalvar" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "globalvar" | |
| ], | |
| "description": "Replaces the relationship globalvar", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "globalvar" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/workspace": { | |
| "get": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Returns the relationship workspace", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "branch", | |
| "-branch", | |
| "createdBy", | |
| "-createdBy", | |
| "defaultTemplate", | |
| "-defaultTemplate", | |
| "deleted", | |
| "-deleted", | |
| "description", | |
| "-description", | |
| "executionMode", | |
| "-executionMode", | |
| "folder", | |
| "-folder", | |
| "iacType", | |
| "-iacType", | |
| "locked", | |
| "-locked", | |
| "moduleSshKey", | |
| "-moduleSshKey", | |
| "name", | |
| "-name", | |
| "source", | |
| "-source", | |
| "terraformVersion", | |
| "-terraformVersion", | |
| "updatedBy", | |
| "-updatedBy", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[workspace]", | |
| "in": "query", | |
| "description": "Selects the set of workspace fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "branch", | |
| "createdBy", | |
| "createdDate", | |
| "defaultTemplate", | |
| "deleted", | |
| "description", | |
| "executionMode", | |
| "folder", | |
| "iacType", | |
| "locked", | |
| "moduleSshKey", | |
| "name", | |
| "source", | |
| "terraformVersion", | |
| "updatedBy", | |
| "updatedDate", | |
| "agent", | |
| "history", | |
| "job", | |
| "organization", | |
| "schedule", | |
| "ssh", | |
| "variable", | |
| "vcs", | |
| "workspaceTag" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "agent", | |
| "history", | |
| "job", | |
| "organization", | |
| "schedule", | |
| "ssh", | |
| "variable", | |
| "vcs", | |
| "workspaceTag" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[workspace]", | |
| "in": "query", | |
| "description": "Filters the collection of workspace using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/workspace" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Creates an item of type workspace and adds it to workspace", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/workspace" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/workspace" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/workspace/{workspaceId}": { | |
| "get": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Returns an instance of type workspace", | |
| "parameters": [ | |
| { | |
| "name": "fields[workspace]", | |
| "in": "query", | |
| "description": "Selects the set of workspace fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "branch", | |
| "createdBy", | |
| "createdDate", | |
| "defaultTemplate", | |
| "deleted", | |
| "description", | |
| "executionMode", | |
| "folder", | |
| "iacType", | |
| "locked", | |
| "moduleSshKey", | |
| "name", | |
| "source", | |
| "terraformVersion", | |
| "updatedBy", | |
| "updatedDate", | |
| "agent", | |
| "history", | |
| "job", | |
| "organization", | |
| "schedule", | |
| "ssh", | |
| "variable", | |
| "vcs", | |
| "workspaceTag" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "agent", | |
| "history", | |
| "job", | |
| "organization", | |
| "schedule", | |
| "ssh", | |
| "variable", | |
| "vcs", | |
| "workspaceTag" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/workspace" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Deletes an instance of type workspace", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Modifies an instance of type workspace", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/workspace" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/relationships/workspace": { | |
| "get": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Returns the relationship identifiers for workspace", | |
| "parameters": [ | |
| { | |
| "name": "filter[workspace]", | |
| "in": "query", | |
| "description": "Filters the collection of workspace using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Adds items to the relationship workspace", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Deletes items from the relationship workspace", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Replaces the relationship workspace", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/ssh": { | |
| "get": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Returns the relationship ssh", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "-createdBy", | |
| "description", | |
| "-description", | |
| "name", | |
| "-name", | |
| "privateKey", | |
| "-privateKey", | |
| "updatedBy", | |
| "-updatedBy", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[ssh]", | |
| "in": "query", | |
| "description": "Selects the set of ssh fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "name", | |
| "privateKey", | |
| "sshType", | |
| "updatedBy", | |
| "updatedDate", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[ssh]", | |
| "in": "query", | |
| "description": "Filters the collection of ssh using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/ssh" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Creates an item of type ssh and adds it to ssh", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/ssh" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/ssh" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/ssh/{sshId}": { | |
| "get": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Returns an instance of type ssh", | |
| "parameters": [ | |
| { | |
| "name": "fields[ssh]", | |
| "in": "query", | |
| "description": "Selects the set of ssh fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "name", | |
| "privateKey", | |
| "sshType", | |
| "updatedBy", | |
| "updatedDate", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/ssh" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Deletes an instance of type ssh", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Modifies an instance of type ssh", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/ssh" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "sshId", | |
| "in": "path", | |
| "description": "ssh Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/relationships/ssh": { | |
| "get": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Returns the relationship identifiers for ssh", | |
| "parameters": [ | |
| { | |
| "name": "filter[ssh]", | |
| "in": "query", | |
| "description": "Filters the collection of ssh using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Adds items to the relationship ssh", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Deletes items from the relationship ssh", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Replaces the relationship ssh", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/job": { | |
| "get": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Returns the relationship job", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "approvalTeam", | |
| "-approvalTeam", | |
| "comments", | |
| "-comments", | |
| "commitId", | |
| "-commitId", | |
| "createdBy", | |
| "-createdBy", | |
| "output", | |
| "-output", | |
| "planChanges", | |
| "-planChanges", | |
| "refresh", | |
| "-refresh", | |
| "refreshOnly", | |
| "-refreshOnly", | |
| "tcl", | |
| "-tcl", | |
| "templateReference", | |
| "-templateReference", | |
| "terraformPlan", | |
| "-terraformPlan", | |
| "updatedBy", | |
| "-updatedBy", | |
| "via", | |
| "-via", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[job]", | |
| "in": "query", | |
| "description": "Selects the set of job fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "approvalTeam", | |
| "comments", | |
| "commitId", | |
| "createdBy", | |
| "createdDate", | |
| "output", | |
| "planChanges", | |
| "refresh", | |
| "refreshOnly", | |
| "status", | |
| "tcl", | |
| "templateReference", | |
| "terraformPlan", | |
| "updatedBy", | |
| "updatedDate", | |
| "via", | |
| "organization", | |
| "step", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization", | |
| "step", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[job]", | |
| "in": "query", | |
| "description": "Filters the collection of job using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/job" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Creates an item of type job and adds it to job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/job" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/job" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/job/{jobId}": { | |
| "get": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Returns an instance of type job", | |
| "parameters": [ | |
| { | |
| "name": "fields[job]", | |
| "in": "query", | |
| "description": "Selects the set of job fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "approvalTeam", | |
| "comments", | |
| "commitId", | |
| "createdBy", | |
| "createdDate", | |
| "output", | |
| "planChanges", | |
| "refresh", | |
| "refreshOnly", | |
| "status", | |
| "tcl", | |
| "templateReference", | |
| "terraformPlan", | |
| "updatedBy", | |
| "updatedDate", | |
| "via", | |
| "organization", | |
| "step", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization", | |
| "step", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/job" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Deletes an instance of type job", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Modifies an instance of type job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/job" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "jobId", | |
| "in": "path", | |
| "description": "job Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/relationships/job": { | |
| "get": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Returns the relationship identifiers for job", | |
| "parameters": [ | |
| { | |
| "name": "filter[job]", | |
| "in": "query", | |
| "description": "Filters the collection of job using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Adds items to the relationship job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Deletes items from the relationship job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Replaces the relationship job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/workspaceTag": { | |
| "get": { | |
| "tags": [ | |
| "workspacetag" | |
| ], | |
| "description": "Returns the relationship workspaceTag", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "-createdBy", | |
| "tagId", | |
| "-tagId", | |
| "updatedBy", | |
| "-updatedBy", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[workspacetag]", | |
| "in": "query", | |
| "description": "Selects the set of workspacetag fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "tagId", | |
| "updatedBy", | |
| "updatedDate", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[workspacetag]", | |
| "in": "query", | |
| "description": "Filters the collection of workspacetag using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/workspacetag" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "workspacetag" | |
| ], | |
| "description": "Creates an item of type workspacetag and adds it to workspaceTag", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/workspacetag" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/workspacetag" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/workspaceTag/{workspacetagId}": { | |
| "get": { | |
| "tags": [ | |
| "workspacetag" | |
| ], | |
| "description": "Returns an instance of type workspacetag", | |
| "parameters": [ | |
| { | |
| "name": "fields[workspacetag]", | |
| "in": "query", | |
| "description": "Selects the set of workspacetag fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "tagId", | |
| "updatedBy", | |
| "updatedDate", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/workspacetag" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "workspacetag" | |
| ], | |
| "description": "Deletes an instance of type workspacetag", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "workspacetag" | |
| ], | |
| "description": "Modifies an instance of type workspacetag", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/workspacetag" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "workspacetagId", | |
| "in": "path", | |
| "description": "workspacetag Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/relationships/workspaceTag": { | |
| "get": { | |
| "tags": [ | |
| "workspacetag" | |
| ], | |
| "description": "Returns the relationship identifiers for workspaceTag", | |
| "parameters": [ | |
| { | |
| "name": "filter[workspacetag]", | |
| "in": "query", | |
| "description": "Filters the collection of workspacetag using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspacetag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "workspacetag" | |
| ], | |
| "description": "Adds items to the relationship workspaceTag", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspacetag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspacetag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "workspacetag" | |
| ], | |
| "description": "Deletes items from the relationship workspaceTag", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspacetag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "workspacetag" | |
| ], | |
| "description": "Replaces the relationship workspaceTag", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspacetag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/step": { | |
| "get": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Returns the collection of type step", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "name", | |
| "-name", | |
| "output", | |
| "-output", | |
| "stepNumber", | |
| "-stepNumber", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[step]", | |
| "in": "query", | |
| "description": "Selects the set of step fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "name", | |
| "output", | |
| "status", | |
| "stepNumber", | |
| "job" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[step]", | |
| "in": "query", | |
| "description": "Filters the collection of step using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "filter", | |
| "in": "query", | |
| "description": "Filters the collection of step using a 'joined' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/step" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Creates an item of type step", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/step" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/step" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/step/{stepId}": { | |
| "get": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Returns an instance of type step", | |
| "parameters": [ | |
| { | |
| "name": "fields[step]", | |
| "in": "query", | |
| "description": "Selects the set of step fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "name", | |
| "output", | |
| "status", | |
| "stepNumber", | |
| "job" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/step" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Deletes an instance of type step", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Modifies an instance of type step", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/step" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "stepId", | |
| "in": "path", | |
| "description": "step Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/variable": { | |
| "get": { | |
| "tags": [ | |
| "variable" | |
| ], | |
| "description": "Returns the relationship variable", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "-description", | |
| "hcl", | |
| "-hcl", | |
| "key", | |
| "-key", | |
| "sensitive", | |
| "-sensitive", | |
| "value", | |
| "-value", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[variable]", | |
| "in": "query", | |
| "description": "Selects the set of variable fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "category", | |
| "description", | |
| "hcl", | |
| "key", | |
| "sensitive", | |
| "value", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[variable]", | |
| "in": "query", | |
| "description": "Filters the collection of variable using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/variable" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "variable" | |
| ], | |
| "description": "Creates an item of type variable and adds it to variable", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/variable" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/variable" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/variable/{variableId}": { | |
| "get": { | |
| "tags": [ | |
| "variable" | |
| ], | |
| "description": "Returns an instance of type variable", | |
| "parameters": [ | |
| { | |
| "name": "fields[variable]", | |
| "in": "query", | |
| "description": "Selects the set of variable fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "category", | |
| "description", | |
| "hcl", | |
| "key", | |
| "sensitive", | |
| "value", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/variable" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "variable" | |
| ], | |
| "description": "Deletes an instance of type variable", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "variable" | |
| ], | |
| "description": "Modifies an instance of type variable", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/variable" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "variableId", | |
| "in": "path", | |
| "description": "variable Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/relationships/variable": { | |
| "get": { | |
| "tags": [ | |
| "variable" | |
| ], | |
| "description": "Returns the relationship identifiers for variable", | |
| "parameters": [ | |
| { | |
| "name": "filter[variable]", | |
| "in": "query", | |
| "description": "Filters the collection of variable using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "variable" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "variable" | |
| ], | |
| "description": "Adds items to the relationship variable", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "variable" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "variable" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "variable" | |
| ], | |
| "description": "Deletes items from the relationship variable", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "variable" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "variable" | |
| ], | |
| "description": "Replaces the relationship variable", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "variable" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/tag": { | |
| "get": { | |
| "tags": [ | |
| "tag" | |
| ], | |
| "description": "Returns the relationship tag", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "-createdBy", | |
| "name", | |
| "-name", | |
| "updatedBy", | |
| "-updatedBy", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[tag]", | |
| "in": "query", | |
| "description": "Selects the set of tag fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "name", | |
| "updatedBy", | |
| "updatedDate", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[tag]", | |
| "in": "query", | |
| "description": "Filters the collection of tag using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/tag" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "tag" | |
| ], | |
| "description": "Creates an item of type tag and adds it to tag", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/tag" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/tag" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/tag/{tagId}": { | |
| "get": { | |
| "tags": [ | |
| "tag" | |
| ], | |
| "description": "Returns an instance of type tag", | |
| "parameters": [ | |
| { | |
| "name": "fields[tag]", | |
| "in": "query", | |
| "description": "Selects the set of tag fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "name", | |
| "updatedBy", | |
| "updatedDate", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/tag" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "tag" | |
| ], | |
| "description": "Deletes an instance of type tag", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "tag" | |
| ], | |
| "description": "Modifies an instance of type tag", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/tag" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "tagId", | |
| "in": "path", | |
| "description": "tag Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/relationships/tag": { | |
| "get": { | |
| "tags": [ | |
| "tag" | |
| ], | |
| "description": "Returns the relationship identifiers for tag", | |
| "parameters": [ | |
| { | |
| "name": "filter[tag]", | |
| "in": "query", | |
| "description": "Filters the collection of tag using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "tag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "tag" | |
| ], | |
| "description": "Adds items to the relationship tag", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "tag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "tag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "tag" | |
| ], | |
| "description": "Deletes items from the relationship tag", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "tag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "tag" | |
| ], | |
| "description": "Replaces the relationship tag", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "tag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/implementation/{implementationId}/version": { | |
| "get": { | |
| "tags": [ | |
| "version" | |
| ], | |
| "description": "Returns the relationship version", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "protocols", | |
| "-protocols", | |
| "versionNumber", | |
| "-versionNumber", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[version]", | |
| "in": "query", | |
| "description": "Selects the set of version fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "protocols", | |
| "versionNumber", | |
| "implementation", | |
| "provider" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "implementation", | |
| "provider" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[version]", | |
| "in": "query", | |
| "description": "Filters the collection of version using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/version" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "version" | |
| ], | |
| "description": "Creates an item of type version and adds it to version", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/version" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/version" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "implementationId", | |
| "in": "path", | |
| "description": "implementation Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/implementation/{implementationId}/version/{versionId}": { | |
| "get": { | |
| "tags": [ | |
| "version" | |
| ], | |
| "description": "Returns an instance of type version", | |
| "parameters": [ | |
| { | |
| "name": "fields[version]", | |
| "in": "query", | |
| "description": "Selects the set of version fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "protocols", | |
| "versionNumber", | |
| "implementation", | |
| "provider" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "implementation", | |
| "provider" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/version" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "version" | |
| ], | |
| "description": "Deletes an instance of type version", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "version" | |
| ], | |
| "description": "Modifies an instance of type version", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/version" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "implementationId", | |
| "in": "path", | |
| "description": "implementation Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "versionId", | |
| "in": "path", | |
| "description": "version Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/implementation/{implementationId}/relationships/version": { | |
| "get": { | |
| "tags": [ | |
| "version" | |
| ], | |
| "description": "Returns the relationship identifiers for version", | |
| "parameters": [ | |
| { | |
| "name": "filter[version]", | |
| "in": "query", | |
| "description": "Filters the collection of version using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "version" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "version" | |
| ], | |
| "description": "Replaces the relationship version", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "version" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "implementationId", | |
| "in": "path", | |
| "description": "implementation Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/ssh": { | |
| "get": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Returns the relationship ssh", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "-createdBy", | |
| "description", | |
| "-description", | |
| "name", | |
| "-name", | |
| "privateKey", | |
| "-privateKey", | |
| "updatedBy", | |
| "-updatedBy", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[ssh]", | |
| "in": "query", | |
| "description": "Selects the set of ssh fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "name", | |
| "privateKey", | |
| "sshType", | |
| "updatedBy", | |
| "updatedDate", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[ssh]", | |
| "in": "query", | |
| "description": "Filters the collection of ssh using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/ssh" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Creates an item of type ssh and adds it to ssh", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/ssh" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/ssh" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/ssh/{sshId}": { | |
| "get": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Returns an instance of type ssh", | |
| "parameters": [ | |
| { | |
| "name": "fields[ssh]", | |
| "in": "query", | |
| "description": "Selects the set of ssh fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "name", | |
| "privateKey", | |
| "sshType", | |
| "updatedBy", | |
| "updatedDate", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/ssh" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Deletes an instance of type ssh", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Modifies an instance of type ssh", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/ssh" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "sshId", | |
| "in": "path", | |
| "description": "ssh Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/relationships/ssh": { | |
| "get": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Returns the relationship identifiers for ssh", | |
| "parameters": [ | |
| { | |
| "name": "filter[ssh]", | |
| "in": "query", | |
| "description": "Filters the collection of ssh using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "ssh" | |
| ], | |
| "description": "Replaces the relationship ssh", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/job/{jobId}/step": { | |
| "get": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Returns the relationship step", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "name", | |
| "-name", | |
| "output", | |
| "-output", | |
| "stepNumber", | |
| "-stepNumber", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[step]", | |
| "in": "query", | |
| "description": "Selects the set of step fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "name", | |
| "output", | |
| "status", | |
| "stepNumber", | |
| "job" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[step]", | |
| "in": "query", | |
| "description": "Filters the collection of step using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/step" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Creates an item of type step and adds it to step", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/step" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/step" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "jobId", | |
| "in": "path", | |
| "description": "job Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/job/{jobId}/step/{stepId}": { | |
| "get": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Returns an instance of type step", | |
| "parameters": [ | |
| { | |
| "name": "fields[step]", | |
| "in": "query", | |
| "description": "Selects the set of step fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "name", | |
| "output", | |
| "status", | |
| "stepNumber", | |
| "job" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/step" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Deletes an instance of type step", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Modifies an instance of type step", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/step" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "jobId", | |
| "in": "path", | |
| "description": "job Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "stepId", | |
| "in": "path", | |
| "description": "step Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/job/{jobId}/relationships/step": { | |
| "get": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Returns the relationship identifiers for step", | |
| "parameters": [ | |
| { | |
| "name": "filter[step]", | |
| "in": "query", | |
| "description": "Filters the collection of step using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "step" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Adds items to the relationship step", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "step" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "step" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Deletes items from the relationship step", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "step" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Replaces the relationship step", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "step" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "jobId", | |
| "in": "path", | |
| "description": "job Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/job": { | |
| "get": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Returns the relationship job", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "approvalTeam", | |
| "-approvalTeam", | |
| "comments", | |
| "-comments", | |
| "commitId", | |
| "-commitId", | |
| "createdBy", | |
| "-createdBy", | |
| "output", | |
| "-output", | |
| "planChanges", | |
| "-planChanges", | |
| "refresh", | |
| "-refresh", | |
| "refreshOnly", | |
| "-refreshOnly", | |
| "tcl", | |
| "-tcl", | |
| "templateReference", | |
| "-templateReference", | |
| "terraformPlan", | |
| "-terraformPlan", | |
| "updatedBy", | |
| "-updatedBy", | |
| "via", | |
| "-via", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[job]", | |
| "in": "query", | |
| "description": "Selects the set of job fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "approvalTeam", | |
| "comments", | |
| "commitId", | |
| "createdBy", | |
| "createdDate", | |
| "output", | |
| "planChanges", | |
| "refresh", | |
| "refreshOnly", | |
| "status", | |
| "tcl", | |
| "templateReference", | |
| "terraformPlan", | |
| "updatedBy", | |
| "updatedDate", | |
| "via", | |
| "organization", | |
| "step", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization", | |
| "step", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[job]", | |
| "in": "query", | |
| "description": "Filters the collection of job using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/job" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Creates an item of type job and adds it to job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/job" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/job" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/job/{jobId}": { | |
| "get": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Returns an instance of type job", | |
| "parameters": [ | |
| { | |
| "name": "fields[job]", | |
| "in": "query", | |
| "description": "Selects the set of job fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "approvalTeam", | |
| "comments", | |
| "commitId", | |
| "createdBy", | |
| "createdDate", | |
| "output", | |
| "planChanges", | |
| "refresh", | |
| "refreshOnly", | |
| "status", | |
| "tcl", | |
| "templateReference", | |
| "terraformPlan", | |
| "updatedBy", | |
| "updatedDate", | |
| "via", | |
| "organization", | |
| "step", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization", | |
| "step", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/job" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Deletes an instance of type job", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Modifies an instance of type job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/job" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "jobId", | |
| "in": "path", | |
| "description": "job Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/relationships/job": { | |
| "get": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Returns the relationship identifiers for job", | |
| "parameters": [ | |
| { | |
| "name": "filter[job]", | |
| "in": "query", | |
| "description": "Filters the collection of job using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Adds items to the relationship job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Deletes items from the relationship job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Replaces the relationship job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace": { | |
| "get": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Returns the collection of type workspace", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "branch", | |
| "-branch", | |
| "createdBy", | |
| "-createdBy", | |
| "defaultTemplate", | |
| "-defaultTemplate", | |
| "deleted", | |
| "-deleted", | |
| "description", | |
| "-description", | |
| "executionMode", | |
| "-executionMode", | |
| "folder", | |
| "-folder", | |
| "iacType", | |
| "-iacType", | |
| "locked", | |
| "-locked", | |
| "moduleSshKey", | |
| "-moduleSshKey", | |
| "name", | |
| "-name", | |
| "source", | |
| "-source", | |
| "terraformVersion", | |
| "-terraformVersion", | |
| "updatedBy", | |
| "-updatedBy", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[workspace]", | |
| "in": "query", | |
| "description": "Selects the set of workspace fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "branch", | |
| "createdBy", | |
| "createdDate", | |
| "defaultTemplate", | |
| "deleted", | |
| "description", | |
| "executionMode", | |
| "folder", | |
| "iacType", | |
| "locked", | |
| "moduleSshKey", | |
| "name", | |
| "source", | |
| "terraformVersion", | |
| "updatedBy", | |
| "updatedDate", | |
| "agent", | |
| "history", | |
| "job", | |
| "organization", | |
| "schedule", | |
| "ssh", | |
| "variable", | |
| "vcs", | |
| "workspaceTag" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "agent", | |
| "history", | |
| "job", | |
| "organization", | |
| "schedule", | |
| "ssh", | |
| "variable", | |
| "vcs", | |
| "workspaceTag" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[workspace]", | |
| "in": "query", | |
| "description": "Filters the collection of workspace using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "filter", | |
| "in": "query", | |
| "description": "Filters the collection of workspace using a 'joined' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/workspace" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Creates an item of type workspace", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/workspace" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/workspace" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/workspace/{workspaceId}": { | |
| "get": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Returns an instance of type workspace", | |
| "parameters": [ | |
| { | |
| "name": "fields[workspace]", | |
| "in": "query", | |
| "description": "Selects the set of workspace fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "branch", | |
| "createdBy", | |
| "createdDate", | |
| "defaultTemplate", | |
| "deleted", | |
| "description", | |
| "executionMode", | |
| "folder", | |
| "iacType", | |
| "locked", | |
| "moduleSshKey", | |
| "name", | |
| "source", | |
| "terraformVersion", | |
| "updatedBy", | |
| "updatedDate", | |
| "agent", | |
| "history", | |
| "job", | |
| "organization", | |
| "schedule", | |
| "ssh", | |
| "variable", | |
| "vcs", | |
| "workspaceTag" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "agent", | |
| "history", | |
| "job", | |
| "organization", | |
| "schedule", | |
| "ssh", | |
| "variable", | |
| "vcs", | |
| "workspaceTag" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/workspace" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Deletes an instance of type workspace", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "workspace" | |
| ], | |
| "description": "Modifies an instance of type workspace", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/workspace" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/job/{jobId}/step": { | |
| "get": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Returns the relationship step", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "name", | |
| "-name", | |
| "output", | |
| "-output", | |
| "stepNumber", | |
| "-stepNumber", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[step]", | |
| "in": "query", | |
| "description": "Selects the set of step fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "name", | |
| "output", | |
| "status", | |
| "stepNumber", | |
| "job" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[step]", | |
| "in": "query", | |
| "description": "Filters the collection of step using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/step" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Creates an item of type step and adds it to step", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/step" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/step" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "jobId", | |
| "in": "path", | |
| "description": "job Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/job/{jobId}/step/{stepId}": { | |
| "get": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Returns an instance of type step", | |
| "parameters": [ | |
| { | |
| "name": "fields[step]", | |
| "in": "query", | |
| "description": "Selects the set of step fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "name", | |
| "output", | |
| "status", | |
| "stepNumber", | |
| "job" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/step" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Deletes an instance of type step", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Modifies an instance of type step", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/step" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "jobId", | |
| "in": "path", | |
| "description": "job Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "stepId", | |
| "in": "path", | |
| "description": "step Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/job/{jobId}/relationships/step": { | |
| "get": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Returns the relationship identifiers for step", | |
| "parameters": [ | |
| { | |
| "name": "filter[step]", | |
| "in": "query", | |
| "description": "Filters the collection of step using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "step" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Adds items to the relationship step", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "step" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "step" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Deletes items from the relationship step", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "step" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "step" | |
| ], | |
| "description": "Replaces the relationship step", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "step" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "jobId", | |
| "in": "path", | |
| "description": "job Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/schedule": { | |
| "get": { | |
| "tags": [ | |
| "schedule" | |
| ], | |
| "description": "Returns the relationship schedule", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "-createdBy", | |
| "cron", | |
| "-cron", | |
| "description", | |
| "-description", | |
| "enabled", | |
| "-enabled", | |
| "tcl", | |
| "-tcl", | |
| "templateReference", | |
| "-templateReference", | |
| "updatedBy", | |
| "-updatedBy", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[schedule]", | |
| "in": "query", | |
| "description": "Selects the set of schedule fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "cron", | |
| "description", | |
| "enabled", | |
| "tcl", | |
| "templateReference", | |
| "updatedBy", | |
| "updatedDate", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[schedule]", | |
| "in": "query", | |
| "description": "Filters the collection of schedule using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/schedule" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "schedule" | |
| ], | |
| "description": "Creates an item of type schedule and adds it to schedule", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/schedule" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/schedule" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/schedule/{scheduleId}": { | |
| "get": { | |
| "tags": [ | |
| "schedule" | |
| ], | |
| "description": "Returns an instance of type schedule", | |
| "parameters": [ | |
| { | |
| "name": "fields[schedule]", | |
| "in": "query", | |
| "description": "Selects the set of schedule fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "cron", | |
| "description", | |
| "enabled", | |
| "tcl", | |
| "templateReference", | |
| "updatedBy", | |
| "updatedDate", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/schedule" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "schedule" | |
| ], | |
| "description": "Deletes an instance of type schedule", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "schedule" | |
| ], | |
| "description": "Modifies an instance of type schedule", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/schedule" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "scheduleId", | |
| "in": "path", | |
| "description": "schedule Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/relationships/schedule": { | |
| "get": { | |
| "tags": [ | |
| "schedule" | |
| ], | |
| "description": "Returns the relationship identifiers for schedule", | |
| "parameters": [ | |
| { | |
| "name": "filter[schedule]", | |
| "in": "query", | |
| "description": "Filters the collection of schedule using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "schedule" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "schedule" | |
| ], | |
| "description": "Adds items to the relationship schedule", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "schedule" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "schedule" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "schedule" | |
| ], | |
| "description": "Deletes items from the relationship schedule", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "schedule" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "schedule" | |
| ], | |
| "description": "Replaces the relationship schedule", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "schedule" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/implementation": { | |
| "get": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Returns the collection of type implementation", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "arch", | |
| "-arch", | |
| "asciiArmor", | |
| "-asciiArmor", | |
| "downloadUrl", | |
| "-downloadUrl", | |
| "filename", | |
| "-filename", | |
| "keyId", | |
| "-keyId", | |
| "os", | |
| "-os", | |
| "shasum", | |
| "-shasum", | |
| "shasumsSignatureUrl", | |
| "-shasumsSignatureUrl", | |
| "shasumsUrl", | |
| "-shasumsUrl", | |
| "source", | |
| "-source", | |
| "sourceUrl", | |
| "-sourceUrl", | |
| "trustSignature", | |
| "-trustSignature", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[implementation]", | |
| "in": "query", | |
| "description": "Selects the set of implementation fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "arch", | |
| "asciiArmor", | |
| "downloadUrl", | |
| "filename", | |
| "keyId", | |
| "os", | |
| "shasum", | |
| "shasumsSignatureUrl", | |
| "shasumsUrl", | |
| "source", | |
| "sourceUrl", | |
| "trustSignature", | |
| "version" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "version" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[implementation]", | |
| "in": "query", | |
| "description": "Filters the collection of implementation using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "filter", | |
| "in": "query", | |
| "description": "Filters the collection of implementation using a 'joined' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/implementation" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Creates an item of type implementation", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/implementation" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/implementation" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/implementation/{implementationId}": { | |
| "get": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Returns an instance of type implementation", | |
| "parameters": [ | |
| { | |
| "name": "fields[implementation]", | |
| "in": "query", | |
| "description": "Selects the set of implementation fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "arch", | |
| "asciiArmor", | |
| "downloadUrl", | |
| "filename", | |
| "keyId", | |
| "os", | |
| "shasum", | |
| "shasumsSignatureUrl", | |
| "shasumsUrl", | |
| "source", | |
| "sourceUrl", | |
| "trustSignature", | |
| "version" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "version" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/implementation" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Deletes an instance of type implementation", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "implementation" | |
| ], | |
| "description": "Modifies an instance of type implementation", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/implementation" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "implementationId", | |
| "in": "path", | |
| "description": "implementation Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/history": { | |
| "get": { | |
| "tags": [ | |
| "history" | |
| ], | |
| "description": "Returns the relationship history", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "-createdBy", | |
| "jobReference", | |
| "-jobReference", | |
| "lineage", | |
| "-lineage", | |
| "md5", | |
| "-md5", | |
| "output", | |
| "-output", | |
| "serial", | |
| "-serial", | |
| "updatedBy", | |
| "-updatedBy", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[history]", | |
| "in": "query", | |
| "description": "Selects the set of history fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "jobReference", | |
| "lineage", | |
| "md5", | |
| "output", | |
| "serial", | |
| "updatedBy", | |
| "updatedDate", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[history]", | |
| "in": "query", | |
| "description": "Filters the collection of history using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/history" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "history" | |
| ], | |
| "description": "Creates an item of type history and adds it to history", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/history" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/history" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/history/{historyId}": { | |
| "get": { | |
| "tags": [ | |
| "history" | |
| ], | |
| "description": "Returns an instance of type history", | |
| "parameters": [ | |
| { | |
| "name": "fields[history]", | |
| "in": "query", | |
| "description": "Selects the set of history fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "jobReference", | |
| "lineage", | |
| "md5", | |
| "output", | |
| "serial", | |
| "updatedBy", | |
| "updatedDate", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/history" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "history" | |
| ], | |
| "description": "Deletes an instance of type history", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "history" | |
| ], | |
| "description": "Modifies an instance of type history", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/history" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "historyId", | |
| "in": "path", | |
| "description": "history Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/relationships/history": { | |
| "get": { | |
| "tags": [ | |
| "history" | |
| ], | |
| "description": "Returns the relationship identifiers for history", | |
| "parameters": [ | |
| { | |
| "name": "filter[history]", | |
| "in": "query", | |
| "description": "Filters the collection of history using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "history" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "history" | |
| ], | |
| "description": "Adds items to the relationship history", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "history" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "history" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "history" | |
| ], | |
| "description": "Deletes items from the relationship history", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "history" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "history" | |
| ], | |
| "description": "Replaces the relationship history", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "history" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/template": { | |
| "get": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Returns the collection of type template", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "-createdBy", | |
| "description", | |
| "-description", | |
| "name", | |
| "-name", | |
| "tcl", | |
| "-tcl", | |
| "updatedBy", | |
| "-updatedBy", | |
| "version", | |
| "-version", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[template]", | |
| "in": "query", | |
| "description": "Selects the set of template fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "name", | |
| "tcl", | |
| "updatedBy", | |
| "updatedDate", | |
| "version", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[template]", | |
| "in": "query", | |
| "description": "Filters the collection of template using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "filter", | |
| "in": "query", | |
| "description": "Filters the collection of template using a 'joined' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/template" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Creates an item of type template", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/template" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/template" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/template/{templateId}": { | |
| "get": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Returns an instance of type template", | |
| "parameters": [ | |
| { | |
| "name": "fields[template]", | |
| "in": "query", | |
| "description": "Selects the set of template fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "name", | |
| "tcl", | |
| "updatedBy", | |
| "updatedDate", | |
| "version", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/template" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Deletes an instance of type template", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "template" | |
| ], | |
| "description": "Modifies an instance of type template", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/template" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "templateId", | |
| "in": "path", | |
| "description": "template Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/organization": { | |
| "get": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Returns the relationship organization", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "-description", | |
| "disabled", | |
| "-disabled", | |
| "executionMode", | |
| "-executionMode", | |
| "name", | |
| "-name", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[organization]", | |
| "in": "query", | |
| "description": "Selects the set of organization fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "disabled", | |
| "executionMode", | |
| "name", | |
| "agent", | |
| "globalvar", | |
| "job", | |
| "module", | |
| "provider", | |
| "ssh", | |
| "tag", | |
| "team", | |
| "template", | |
| "vcs", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "agent", | |
| "globalvar", | |
| "job", | |
| "module", | |
| "provider", | |
| "ssh", | |
| "tag", | |
| "team", | |
| "template", | |
| "vcs", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[organization]", | |
| "in": "query", | |
| "description": "Filters the collection of organization using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/organization" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Creates an item of type organization and adds it to organization", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/organization/{organizationId}": { | |
| "get": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Returns an instance of type organization", | |
| "parameters": [ | |
| { | |
| "name": "fields[organization]", | |
| "in": "query", | |
| "description": "Selects the set of organization fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "disabled", | |
| "executionMode", | |
| "name", | |
| "agent", | |
| "globalvar", | |
| "job", | |
| "module", | |
| "provider", | |
| "ssh", | |
| "tag", | |
| "team", | |
| "template", | |
| "vcs", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "agent", | |
| "globalvar", | |
| "job", | |
| "module", | |
| "provider", | |
| "ssh", | |
| "tag", | |
| "team", | |
| "template", | |
| "vcs", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Deletes an instance of type organization", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Modifies an instance of type organization", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/organization" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/workspace/{workspaceId}/relationships/organization": { | |
| "get": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Returns the relationship identifiers for organization", | |
| "parameters": [ | |
| { | |
| "name": "filter[organization]", | |
| "in": "query", | |
| "description": "Filters the collection of organization using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "organization" | |
| ], | |
| "description": "Replaces the relationship organization", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "workspaceId", | |
| "in": "path", | |
| "description": "workspace Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/step/{stepId}/job": { | |
| "get": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Returns the relationship job", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "approvalTeam", | |
| "-approvalTeam", | |
| "comments", | |
| "-comments", | |
| "commitId", | |
| "-commitId", | |
| "createdBy", | |
| "-createdBy", | |
| "output", | |
| "-output", | |
| "planChanges", | |
| "-planChanges", | |
| "refresh", | |
| "-refresh", | |
| "refreshOnly", | |
| "-refreshOnly", | |
| "tcl", | |
| "-tcl", | |
| "templateReference", | |
| "-templateReference", | |
| "terraformPlan", | |
| "-terraformPlan", | |
| "updatedBy", | |
| "-updatedBy", | |
| "via", | |
| "-via", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[job]", | |
| "in": "query", | |
| "description": "Selects the set of job fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "approvalTeam", | |
| "comments", | |
| "commitId", | |
| "createdBy", | |
| "createdDate", | |
| "output", | |
| "planChanges", | |
| "refresh", | |
| "refreshOnly", | |
| "status", | |
| "tcl", | |
| "templateReference", | |
| "terraformPlan", | |
| "updatedBy", | |
| "updatedDate", | |
| "via", | |
| "organization", | |
| "step", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization", | |
| "step", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[job]", | |
| "in": "query", | |
| "description": "Filters the collection of job using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/job" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Creates an item of type job and adds it to job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/job" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/job" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "stepId", | |
| "in": "path", | |
| "description": "step Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/step/{stepId}/job/{jobId}": { | |
| "get": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Returns an instance of type job", | |
| "parameters": [ | |
| { | |
| "name": "fields[job]", | |
| "in": "query", | |
| "description": "Selects the set of job fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "approvalTeam", | |
| "comments", | |
| "commitId", | |
| "createdBy", | |
| "createdDate", | |
| "output", | |
| "planChanges", | |
| "refresh", | |
| "refreshOnly", | |
| "status", | |
| "tcl", | |
| "templateReference", | |
| "terraformPlan", | |
| "updatedBy", | |
| "updatedDate", | |
| "via", | |
| "organization", | |
| "step", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization", | |
| "step", | |
| "workspace" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/job" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Deletes an instance of type job", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Modifies an instance of type job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/job" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "stepId", | |
| "in": "path", | |
| "description": "step Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "jobId", | |
| "in": "path", | |
| "description": "job Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/step/{stepId}/relationships/job": { | |
| "get": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Returns the relationship identifiers for job", | |
| "parameters": [ | |
| { | |
| "name": "filter[job]", | |
| "in": "query", | |
| "description": "Filters the collection of job using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "job" | |
| ], | |
| "description": "Replaces the relationship job", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "stepId", | |
| "in": "path", | |
| "description": "step Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/provider": { | |
| "get": { | |
| "tags": [ | |
| "provider" | |
| ], | |
| "description": "Returns the relationship provider", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "-description", | |
| "name", | |
| "-name", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[provider]", | |
| "in": "query", | |
| "description": "Selects the set of provider fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "name", | |
| "organization", | |
| "version" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization", | |
| "version" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[provider]", | |
| "in": "query", | |
| "description": "Filters the collection of provider using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/provider" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "provider" | |
| ], | |
| "description": "Creates an item of type provider and adds it to provider", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/provider" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/provider" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/provider/{providerId}": { | |
| "get": { | |
| "tags": [ | |
| "provider" | |
| ], | |
| "description": "Returns an instance of type provider", | |
| "parameters": [ | |
| { | |
| "name": "fields[provider]", | |
| "in": "query", | |
| "description": "Selects the set of provider fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "name", | |
| "organization", | |
| "version" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization", | |
| "version" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/provider" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "provider" | |
| ], | |
| "description": "Deletes an instance of type provider", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "provider" | |
| ], | |
| "description": "Modifies an instance of type provider", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/provider" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "providerId", | |
| "in": "path", | |
| "description": "provider Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/relationships/provider": { | |
| "get": { | |
| "tags": [ | |
| "provider" | |
| ], | |
| "description": "Returns the relationship identifiers for provider", | |
| "parameters": [ | |
| { | |
| "name": "filter[provider]", | |
| "in": "query", | |
| "description": "Filters the collection of provider using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "provider" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "provider" | |
| ], | |
| "description": "Adds items to the relationship provider", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "provider" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "provider" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "provider" | |
| ], | |
| "description": "Deletes items from the relationship provider", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "provider" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "provider" | |
| ], | |
| "description": "Replaces the relationship provider", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "provider" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/agent": { | |
| "get": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Returns the relationship agent", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "-description", | |
| "name", | |
| "-name", | |
| "url", | |
| "-url", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[agent]", | |
| "in": "query", | |
| "description": "Selects the set of agent fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "name", | |
| "url", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[agent]", | |
| "in": "query", | |
| "description": "Filters the collection of agent using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/agent" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Creates an item of type agent and adds it to agent", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/agent" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/agent" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/agent/{agentId}": { | |
| "get": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Returns an instance of type agent", | |
| "parameters": [ | |
| { | |
| "name": "fields[agent]", | |
| "in": "query", | |
| "description": "Selects the set of agent fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "description", | |
| "name", | |
| "url", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/agent" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Deletes an instance of type agent", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Modifies an instance of type agent", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/agent" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "description": "agent Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/relationships/agent": { | |
| "get": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Returns the relationship identifiers for agent", | |
| "parameters": [ | |
| { | |
| "name": "filter[agent]", | |
| "in": "query", | |
| "description": "Filters the collection of agent using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "agent" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Adds items to the relationship agent", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "agent" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "agent" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Deletes items from the relationship agent", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "agent" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "agent" | |
| ], | |
| "description": "Replaces the relationship agent", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "agent" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/vcs": { | |
| "get": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Returns the relationship vcs", | |
| "parameters": [ | |
| { | |
| "name": "sort", | |
| "in": "query", | |
| "description": "Sorts the collection on the selected attributes. A prefix of '-' sorts descending", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "accessToken", | |
| "-accessToken", | |
| "apiUrl", | |
| "-apiUrl", | |
| "callback", | |
| "-callback", | |
| "clientId", | |
| "-clientId", | |
| "clientSecret", | |
| "-clientSecret", | |
| "createdBy", | |
| "-createdBy", | |
| "description", | |
| "-description", | |
| "endpoint", | |
| "-endpoint", | |
| "name", | |
| "-name", | |
| "redirectUrl", | |
| "-redirectUrl", | |
| "updatedBy", | |
| "-updatedBy", | |
| "id", | |
| "-id" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "fields[vcs]", | |
| "in": "query", | |
| "description": "Selects the set of vcs fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "accessToken", | |
| "apiUrl", | |
| "callback", | |
| "clientId", | |
| "clientSecret", | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "endpoint", | |
| "name", | |
| "redirectUrl", | |
| "status", | |
| "updatedBy", | |
| "updatedDate", | |
| "vcsType", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "filter[vcs]", | |
| "in": "query", | |
| "description": "Filters the collection of vcs using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/vcs" | |
| } | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Creates an item of type vcs and adds it to vcs", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/vcs" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/vcs" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/vcs/{vcsId}": { | |
| "get": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Returns an instance of type vcs", | |
| "parameters": [ | |
| { | |
| "name": "fields[vcs]", | |
| "in": "query", | |
| "description": "Selects the set of vcs fields that should be returned in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "accessToken", | |
| "apiUrl", | |
| "callback", | |
| "clientId", | |
| "clientSecret", | |
| "createdBy", | |
| "createdDate", | |
| "description", | |
| "endpoint", | |
| "name", | |
| "redirectUrl", | |
| "status", | |
| "updatedBy", | |
| "updatedDate", | |
| "vcsType", | |
| "organization" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "include", | |
| "in": "query", | |
| "description": "Selects the set of relationships that should be expanded as a compound document in the result.", | |
| "style": "form", | |
| "explode": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/vcs" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Deletes an instance of type vcs", | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Modifies an instance of type vcs", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "$ref": "#/components/schemas/vcs" | |
| }, | |
| "included": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "description": "Included resources", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object" | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "vcsId", | |
| "in": "path", | |
| "description": "vcs Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| }, | |
| "/organization/{organizationId}/relationships/vcs": { | |
| "get": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Returns the relationship identifiers for vcs", | |
| "parameters": [ | |
| { | |
| "name": "filter[vcs]", | |
| "in": "query", | |
| "description": "Filters the collection of vcs using a 'disjoint' RSQL expression", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "page[number]", | |
| "in": "query", | |
| "description": "Number of pages to return. Can be used with page[size]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[size]", | |
| "in": "query", | |
| "description": "Number of elements per page. Can be used with page[number]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[offset]", | |
| "in": "query", | |
| "description": "Offset from 0 to start paginating. Can be used with page[limit]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[limit]", | |
| "in": "query", | |
| "description": "Maximum number of items to return. Can be used with page[offset]", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "page[totals]", | |
| "in": "query", | |
| "description": "For requesting total pages/records be included in the response page meta data", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Adds items to the relationship vcs", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Deletes items from the relationship vcs", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "vcs" | |
| ], | |
| "description": "Replaces the relationship vcs", | |
| "requestBody": { | |
| "content": { | |
| "application/vnd.api+json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Successful response" | |
| } | |
| } | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "organizationId", | |
| "in": "path", | |
| "description": "organization Identifier", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "components": { | |
| "schemas": { | |
| "vcs": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (team manage vcs)\nDelete Permissions : (team manage vcs)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "accessToken": { | |
| "type": "string", | |
| "description": "Read Permissions : (read access token)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "apiUrl": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "callback": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "clientId": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "clientSecret": { | |
| "type": "string", | |
| "description": "Read Permissions : (read vcs secret)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "endpoint": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "redirectUrl": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "PENDING", | |
| "COMPLETED", | |
| "ERROR" | |
| ], | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "vcsType": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "GITHUB", | |
| "GITLAB", | |
| "BITBUCKET", | |
| "AZURE_DEVOPS", | |
| "PUBLIC" | |
| ], | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "accessToken": { | |
| "type": "string", | |
| "description": "Read Permissions : (read access token)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "apiUrl": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "callback": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "clientId": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "clientSecret": { | |
| "type": "string", | |
| "description": "Read Permissions : (read vcs secret)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "endpoint": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "redirectUrl": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "PENDING", | |
| "COMPLETED", | |
| "ERROR" | |
| ], | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "vcsType": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "GITHUB", | |
| "GITLAB", | |
| "BITBUCKET", | |
| "AZURE_DEVOPS", | |
| "PUBLIC" | |
| ], | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view vcs)\nUpdate Permissions : (team manage vcs)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "globalvar": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (user is a superuser)\nDelete Permissions : (user is a superuser)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "TERRAFORM", | |
| "ENV" | |
| ], | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "hcl": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "key": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "sensitive": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (admin update secret)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "Read Permissions : (admin read secret)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "TERRAFORM", | |
| "ENV" | |
| ], | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "hcl": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "key": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "sensitive": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (admin update secret)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "Read Permissions : (admin read secret)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "step": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "output": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "status": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "pending", | |
| "waitingApproval", | |
| "approved", | |
| "queue", | |
| "running", | |
| "completed", | |
| "noChanges", | |
| "notExecuted", | |
| "rejected", | |
| "cancelled", | |
| "failed", | |
| "unknown" | |
| ], | |
| "example": null | |
| }, | |
| "stepNumber": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "job": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "output": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "status": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "pending", | |
| "waitingApproval", | |
| "approved", | |
| "queue", | |
| "running", | |
| "completed", | |
| "noChanges", | |
| "notExecuted", | |
| "rejected", | |
| "cancelled", | |
| "failed", | |
| "unknown" | |
| ], | |
| "example": null | |
| }, | |
| "stepNumber": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "job": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (team manage workspace)\nDelete Permissions : (team manage workspace)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "branch": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "defaultTemplate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "executionMode": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "folder": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "iacType": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "locked": { | |
| "type": "boolean", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "moduleSshKey": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "source": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "terraformVersion": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "agent": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "agent" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "history": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "history" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "job": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "schedule": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "schedule" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "ssh": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "variable": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "variable" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "vcs": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "workspaceTag": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspacetag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "branch": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "defaultTemplate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "executionMode": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "folder": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "iacType": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "locked": { | |
| "type": "boolean", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "moduleSshKey": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "source": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "terraformVersion": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "agent": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "agent" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "history": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "history" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "job": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "schedule": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "schedule" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "ssh": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "variable": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "variable" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "vcs": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "workspaceTag": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspacetag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view workspace)\nUpdate Permissions : (team manage workspace)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "action": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (user is a superuser)\nDelete Permissions : (user is a superuser)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "action": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "active": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "category": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "displayCriteria": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "version": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "action": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "active": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "category": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "displayCriteria": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "version": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| }, | |
| "variable": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "TERRAFORM", | |
| "ENV" | |
| ], | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "hcl": { | |
| "type": "boolean", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "key": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "sensitive": { | |
| "type": "boolean", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "Read Permissions : (user read secret)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "TERRAFORM", | |
| "ENV" | |
| ], | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "hcl": { | |
| "type": "boolean", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "key": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "sensitive": { | |
| "type": "boolean", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "Read Permissions : (user read secret)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "workspacetag": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "tagId": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "tagId": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tag": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "job": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (team manage job)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "approvalTeam": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "comments": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "commitId": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "output": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "planChanges": { | |
| "type": "boolean", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "refresh": { | |
| "type": "boolean", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "refreshOnly": { | |
| "type": "boolean", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team approve job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "pending", | |
| "waitingApproval", | |
| "approved", | |
| "queue", | |
| "running", | |
| "completed", | |
| "noChanges", | |
| "notExecuted", | |
| "rejected", | |
| "cancelled", | |
| "failed", | |
| "unknown" | |
| ], | |
| "example": null | |
| }, | |
| "tcl": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "templateReference": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "terraformPlan": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "via": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "step": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "step" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "approvalTeam": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "comments": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "commitId": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "output": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "planChanges": { | |
| "type": "boolean", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "refresh": { | |
| "type": "boolean", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "refreshOnly": { | |
| "type": "boolean", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team approve job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "pending", | |
| "waitingApproval", | |
| "approved", | |
| "queue", | |
| "running", | |
| "completed", | |
| "noChanges", | |
| "notExecuted", | |
| "rejected", | |
| "cancelled", | |
| "failed", | |
| "unknown" | |
| ], | |
| "example": null | |
| }, | |
| "tcl": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "templateReference": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "terraformPlan": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "via": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "step": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "step" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view job)\nUpdate Permissions : (team manage job OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "schedule": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "cron": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "tcl": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "templateReference": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "cron": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "tcl": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "templateReference": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "template": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (team manage template)\nDelete Permissions : (team manage template)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "tcl": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "version": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "tcl": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "version": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view template)\nUpdate Permissions : (team manage template)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "team": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (user is a superuser)\nDelete Permissions : (user is a superuser)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "manageModule": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "manageProvider": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "manageTemplate": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "manageVcs": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "manageWorkspace": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "manageModule": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "manageProvider": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "manageTemplate": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "manageVcs": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "manageWorkspace": { | |
| "type": "boolean", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "module": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (team manage module)\nDelete Permissions : (team manage module)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "downloadQuantity": { | |
| "type": "integer", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "format": "int32", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "folder": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "provider": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "registryPath": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "source": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "tagPrefix": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "versions": { | |
| "type": "array", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "items": { | |
| "type": "object" | |
| }, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "ssh": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "vcs": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "downloadQuantity": { | |
| "type": "integer", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "format": "int32", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "folder": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "provider": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "registryPath": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "source": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "tagPrefix": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "versions": { | |
| "type": "array", | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "items": { | |
| "type": "object" | |
| }, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "ssh": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "vcs": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view module)\nUpdate Permissions : (team manage module OR user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "history": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (user is a super service)\nDelete Permissions : (user is a super service)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "jobReference": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "lineage": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "md5": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "output": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "serial": { | |
| "type": "integer", | |
| "description": "Update Permissions : (user is a super service)", | |
| "format": "int32", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "jobReference": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "lineage": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "md5": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "output": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "serial": { | |
| "type": "integer", | |
| "description": "Update Permissions : (user is a super service)", | |
| "format": "int32", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Update Permissions : (user is a super service)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "agent": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (user is a superuser)\nDelete Permissions : (user is a superuser)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "description": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "url": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "description": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "url": { | |
| "type": "string", | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Update Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ssh": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (team manage ssh)\nDelete Permissions : (team manage ssh)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "privateKey": { | |
| "type": "string", | |
| "description": "Read Permissions : (read private key)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "sshType": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "rsa", | |
| "ed25519" | |
| ], | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "privateKey": { | |
| "type": "string", | |
| "description": "Read Permissions : (read private key)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "sshType": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "rsa", | |
| "ed25519" | |
| ], | |
| "example": null | |
| }, | |
| "updatedBy": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "updatedDate": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view ssh)\nUpdate Permissions : (team manage ssh)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "webhook": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "referenceId": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "remoteHookId": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "templateMapping": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "type": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "WORKSPACE", | |
| "MODULE" | |
| ], | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "referenceId": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "remoteHookId": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "templateMapping": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "type": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "enum": [ | |
| "WORKSPACE", | |
| "MODULE" | |
| ], | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object" | |
| } | |
| }, | |
| "version": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "protocols": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "versionNumber": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "implementation": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "implementation" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "provider": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "provider" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "protocols": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "versionNumber": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "implementation": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "implementation" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "provider": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "provider" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (user is a superuser)\nDelete Permissions : (user is a superuser)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "disabled": { | |
| "type": "boolean", | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "executionMode": { | |
| "type": "string", | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "agent": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "agent" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "globalvar": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "globalvar" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "job": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "module": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "module" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "provider": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "provider" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "ssh": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "tag": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "tag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "team": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "team" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "template": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "template" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "vcs": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "disabled": { | |
| "type": "boolean", | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "executionMode": { | |
| "type": "string", | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "agent": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "agent" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "globalvar": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "globalvar" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "job": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "job" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "module": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "module" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "provider": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "provider" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "ssh": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "ssh" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "tag": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "tag" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "team": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "team" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user is a superuser)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "template": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "template" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "vcs": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "vcs" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "workspace": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "workspace" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (user belongs organization)\nUpdate Permissions : (user belongs organization)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "provider": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "Create Permissions : (team manage provider)\nDelete Permissions : (team manage provider)" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "version": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "version" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "description": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "organization": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "organization" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| }, | |
| "version": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "version" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "implementation": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "arch": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "asciiArmor": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "downloadUrl": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "filename": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "keyId": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "os": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "shasum": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "shasumsSignatureUrl": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "shasumsUrl": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "source": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "sourceUrl": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "trustSignature": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "version": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "version" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "properties": { | |
| "arch": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "asciiArmor": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "downloadUrl": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "filename": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "keyId": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "os": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "shasum": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "shasumsSignatureUrl": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "shasumsUrl": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "source": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "sourceUrl": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| }, | |
| "trustSignature": { | |
| "type": "string", | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| }, | |
| "relationships": { | |
| "type": "object", | |
| "properties": { | |
| "version": { | |
| "type": "object", | |
| "properties": { | |
| "data": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "version" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| }, | |
| "readOnly": false, | |
| "writeOnly": false, | |
| "example": null | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } |
This file has been truncated, but you can view the full file.
This file contains hidden or 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
| openapi: 3.0.1 | |
| info: | |
| title: Elide Service | |
| servers: | |
| - url: /api/v1 | |
| tags: | |
| - name: action | |
| - name: agent | |
| - name: globalvar | |
| - name: history | |
| - name: implementation | |
| - name: job | |
| - name: module | |
| - name: organization | |
| - name: provider | |
| - name: schedule | |
| - name: ssh | |
| - name: step | |
| - name: tag | |
| - name: team | |
| - name: template | |
| - name: variable | |
| - name: vcs | |
| - name: version | |
| - name: webhook | |
| - name: workspace | |
| - name: workspacetag | |
| paths: | |
| /template/{templateId}/organization: | |
| get: | |
| tags: | |
| - organization | |
| description: Returns the relationship organization | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - description | |
| - '-description' | |
| - disabled | |
| - '-disabled' | |
| - executionMode | |
| - '-executionMode' | |
| - name | |
| - '-name' | |
| - id | |
| - '-id' | |
| - name: fields[organization] | |
| in: query | |
| description: Selects the set of organization fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - description | |
| - disabled | |
| - executionMode | |
| - name | |
| - agent | |
| - globalvar | |
| - job | |
| - module | |
| - provider | |
| - ssh | |
| - tag | |
| - team | |
| - template | |
| - vcs | |
| - workspace | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - agent | |
| - globalvar | |
| - job | |
| - module | |
| - provider | |
| - ssh | |
| - tag | |
| - team | |
| - template | |
| - vcs | |
| - workspace | |
| - name: filter[organization] | |
| in: query | |
| description: Filters the collection of organization using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/organization' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - organization | |
| description: Creates an item of type organization and adds it to organization | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/organization' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/organization' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| parameters: | |
| - name: templateId | |
| in: path | |
| description: template Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /template/{templateId}/organization/{organizationId}: | |
| get: | |
| tags: | |
| - organization | |
| description: Returns an instance of type organization | |
| parameters: | |
| - name: fields[organization] | |
| in: query | |
| description: Selects the set of organization fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - description | |
| - disabled | |
| - executionMode | |
| - name | |
| - agent | |
| - globalvar | |
| - job | |
| - module | |
| - provider | |
| - ssh | |
| - tag | |
| - team | |
| - template | |
| - vcs | |
| - workspace | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - agent | |
| - globalvar | |
| - job | |
| - module | |
| - provider | |
| - ssh | |
| - tag | |
| - team | |
| - template | |
| - vcs | |
| - workspace | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/organization' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| delete: | |
| tags: | |
| - organization | |
| description: Deletes an instance of type organization | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - organization | |
| description: Modifies an instance of type organization | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/organization' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: templateId | |
| in: path | |
| description: template Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /template/{templateId}/relationships/organization: | |
| get: | |
| tags: | |
| - organization | |
| description: Returns the relationship identifiers for organization | |
| parameters: | |
| - name: filter[organization] | |
| in: query | |
| description: Filters the collection of organization using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - organization | |
| id: | |
| type: string | |
| patch: | |
| tags: | |
| - organization | |
| description: Replaces the relationship organization | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - organization | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: templateId | |
| in: path | |
| description: template Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/team: | |
| get: | |
| tags: | |
| - team | |
| description: Returns the relationship team | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - manageModule | |
| - '-manageModule' | |
| - manageProvider | |
| - '-manageProvider' | |
| - manageTemplate | |
| - '-manageTemplate' | |
| - manageVcs | |
| - '-manageVcs' | |
| - manageWorkspace | |
| - '-manageWorkspace' | |
| - name | |
| - '-name' | |
| - id | |
| - '-id' | |
| - name: fields[team] | |
| in: query | |
| description: Selects the set of team fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - manageModule | |
| - manageProvider | |
| - manageTemplate | |
| - manageVcs | |
| - manageWorkspace | |
| - name | |
| - organization | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| - name: filter[team] | |
| in: query | |
| description: Filters the collection of team using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/team' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - team | |
| description: Creates an item of type team and adds it to team | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/team' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/team' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/team/{teamId}: | |
| get: | |
| tags: | |
| - team | |
| description: Returns an instance of type team | |
| parameters: | |
| - name: fields[team] | |
| in: query | |
| description: Selects the set of team fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - manageModule | |
| - manageProvider | |
| - manageTemplate | |
| - manageVcs | |
| - manageWorkspace | |
| - name | |
| - organization | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/team' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| delete: | |
| tags: | |
| - team | |
| description: Deletes an instance of type team | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - team | |
| description: Modifies an instance of type team | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/team' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: teamId | |
| in: path | |
| description: team Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/relationships/team: | |
| get: | |
| tags: | |
| - team | |
| description: Returns the relationship identifiers for team | |
| parameters: | |
| - name: filter[team] | |
| in: query | |
| description: Filters the collection of team using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - team | |
| id: | |
| type: string | |
| post: | |
| tags: | |
| - team | |
| description: Adds items to the relationship team | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - team | |
| id: | |
| type: string | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - team | |
| id: | |
| type: string | |
| delete: | |
| tags: | |
| - team | |
| description: Deletes items from the relationship team | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - team | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - team | |
| description: Replaces the relationship team | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - team | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/template: | |
| get: | |
| tags: | |
| - template | |
| description: Returns the relationship template | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - createdBy | |
| - '-createdBy' | |
| - description | |
| - '-description' | |
| - name | |
| - '-name' | |
| - tcl | |
| - '-tcl' | |
| - updatedBy | |
| - '-updatedBy' | |
| - version | |
| - '-version' | |
| - id | |
| - '-id' | |
| - name: fields[template] | |
| in: query | |
| description: Selects the set of template fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - createdBy | |
| - createdDate | |
| - description | |
| - name | |
| - tcl | |
| - updatedBy | |
| - updatedDate | |
| - version | |
| - organization | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| - name: filter[template] | |
| in: query | |
| description: Filters the collection of template using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/template' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - template | |
| description: Creates an item of type template and adds it to template | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/template' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/template' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/template/{templateId}: | |
| get: | |
| tags: | |
| - template | |
| description: Returns an instance of type template | |
| parameters: | |
| - name: fields[template] | |
| in: query | |
| description: Selects the set of template fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - createdBy | |
| - createdDate | |
| - description | |
| - name | |
| - tcl | |
| - updatedBy | |
| - updatedDate | |
| - version | |
| - organization | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/template' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| delete: | |
| tags: | |
| - template | |
| description: Deletes an instance of type template | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - template | |
| description: Modifies an instance of type template | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/template' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: templateId | |
| in: path | |
| description: template Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/relationships/template: | |
| get: | |
| tags: | |
| - template | |
| description: Returns the relationship identifiers for template | |
| parameters: | |
| - name: filter[template] | |
| in: query | |
| description: Filters the collection of template using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - template | |
| id: | |
| type: string | |
| post: | |
| tags: | |
| - template | |
| description: Adds items to the relationship template | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - template | |
| id: | |
| type: string | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - template | |
| id: | |
| type: string | |
| delete: | |
| tags: | |
| - template | |
| description: Deletes items from the relationship template | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - template | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - template | |
| description: Replaces the relationship template | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - template | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/module: | |
| get: | |
| tags: | |
| - module | |
| description: Returns the relationship module | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - createdBy | |
| - '-createdBy' | |
| - description | |
| - '-description' | |
| - downloadQuantity | |
| - '-downloadQuantity' | |
| - folder | |
| - '-folder' | |
| - name | |
| - '-name' | |
| - provider | |
| - '-provider' | |
| - registryPath | |
| - '-registryPath' | |
| - source | |
| - '-source' | |
| - tagPrefix | |
| - '-tagPrefix' | |
| - updatedBy | |
| - '-updatedBy' | |
| - id | |
| - '-id' | |
| - name: fields[module] | |
| in: query | |
| description: Selects the set of module fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - createdBy | |
| - createdDate | |
| - description | |
| - downloadQuantity | |
| - folder | |
| - name | |
| - provider | |
| - registryPath | |
| - source | |
| - tagPrefix | |
| - updatedBy | |
| - updatedDate | |
| - versions | |
| - organization | |
| - ssh | |
| - vcs | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| - ssh | |
| - vcs | |
| - name: filter[module] | |
| in: query | |
| description: Filters the collection of module using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/module' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - module | |
| description: Creates an item of type module and adds it to module | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/module' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/module' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/module/{moduleId}: | |
| get: | |
| tags: | |
| - module | |
| description: Returns an instance of type module | |
| parameters: | |
| - name: fields[module] | |
| in: query | |
| description: Selects the set of module fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - createdBy | |
| - createdDate | |
| - description | |
| - downloadQuantity | |
| - folder | |
| - name | |
| - provider | |
| - registryPath | |
| - source | |
| - tagPrefix | |
| - updatedBy | |
| - updatedDate | |
| - versions | |
| - organization | |
| - ssh | |
| - vcs | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| - ssh | |
| - vcs | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/module' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| delete: | |
| tags: | |
| - module | |
| description: Deletes an instance of type module | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - module | |
| description: Modifies an instance of type module | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/module' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: moduleId | |
| in: path | |
| description: module Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/relationships/module: | |
| get: | |
| tags: | |
| - module | |
| description: Returns the relationship identifiers for module | |
| parameters: | |
| - name: filter[module] | |
| in: query | |
| description: Filters the collection of module using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - module | |
| id: | |
| type: string | |
| post: | |
| tags: | |
| - module | |
| description: Adds items to the relationship module | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - module | |
| id: | |
| type: string | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - module | |
| id: | |
| type: string | |
| delete: | |
| tags: | |
| - module | |
| description: Deletes items from the relationship module | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - module | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - module | |
| description: Replaces the relationship module | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - module | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /action: | |
| get: | |
| tags: | |
| - action | |
| description: Returns the collection of type action | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - action | |
| - '-action' | |
| - active | |
| - '-active' | |
| - category | |
| - '-category' | |
| - createdBy | |
| - '-createdBy' | |
| - description | |
| - '-description' | |
| - displayCriteria | |
| - '-displayCriteria' | |
| - label | |
| - '-label' | |
| - name | |
| - '-name' | |
| - type | |
| - '-type' | |
| - updatedBy | |
| - '-updatedBy' | |
| - version | |
| - '-version' | |
| - id | |
| - '-id' | |
| - name: fields[action] | |
| in: query | |
| description: Selects the set of action fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - action | |
| - active | |
| - category | |
| - createdBy | |
| - createdDate | |
| - description | |
| - displayCriteria | |
| - label | |
| - name | |
| - type | |
| - updatedBy | |
| - updatedDate | |
| - version | |
| - name: filter[action] | |
| in: query | |
| description: Filters the collection of action using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: filter | |
| in: query | |
| description: Filters the collection of action using a 'joined' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/action' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - action | |
| description: Creates an item of type action | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/action' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/action' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| /action/{actionId}: | |
| get: | |
| tags: | |
| - action | |
| description: Returns an instance of type action | |
| parameters: | |
| - name: fields[action] | |
| in: query | |
| description: Selects the set of action fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - action | |
| - active | |
| - category | |
| - createdBy | |
| - createdDate | |
| - description | |
| - displayCriteria | |
| - label | |
| - name | |
| - type | |
| - updatedBy | |
| - updatedDate | |
| - version | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/action' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| delete: | |
| tags: | |
| - action | |
| description: Deletes an instance of type action | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - action | |
| description: Modifies an instance of type action | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/action' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: actionId | |
| in: path | |
| description: action Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /workspace/{workspaceId}/agent: | |
| get: | |
| tags: | |
| - agent | |
| description: Returns the relationship agent | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - description | |
| - '-description' | |
| - name | |
| - '-name' | |
| - url | |
| - '-url' | |
| - id | |
| - '-id' | |
| - name: fields[agent] | |
| in: query | |
| description: Selects the set of agent fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - description | |
| - name | |
| - url | |
| - organization | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| - name: filter[agent] | |
| in: query | |
| description: Filters the collection of agent using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/agent' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - agent | |
| description: Creates an item of type agent and adds it to agent | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/agent' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/agent' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| parameters: | |
| - name: workspaceId | |
| in: path | |
| description: workspace Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /workspace/{workspaceId}/agent/{agentId}: | |
| get: | |
| tags: | |
| - agent | |
| description: Returns an instance of type agent | |
| parameters: | |
| - name: fields[agent] | |
| in: query | |
| description: Selects the set of agent fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - description | |
| - name | |
| - url | |
| - organization | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/agent' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| delete: | |
| tags: | |
| - agent | |
| description: Deletes an instance of type agent | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - agent | |
| description: Modifies an instance of type agent | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/agent' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: workspaceId | |
| in: path | |
| description: workspace Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: agentId | |
| in: path | |
| description: agent Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /workspace/{workspaceId}/relationships/agent: | |
| get: | |
| tags: | |
| - agent | |
| description: Returns the relationship identifiers for agent | |
| parameters: | |
| - name: filter[agent] | |
| in: query | |
| description: Filters the collection of agent using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - agent | |
| id: | |
| type: string | |
| patch: | |
| tags: | |
| - agent | |
| description: Replaces the relationship agent | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - agent | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: workspaceId | |
| in: path | |
| description: workspace Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/provider/{providerId}/version/{versionId}/implementation: | |
| get: | |
| tags: | |
| - implementation | |
| description: Returns the relationship implementation | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - arch | |
| - '-arch' | |
| - asciiArmor | |
| - '-asciiArmor' | |
| - downloadUrl | |
| - '-downloadUrl' | |
| - filename | |
| - '-filename' | |
| - keyId | |
| - '-keyId' | |
| - os | |
| - '-os' | |
| - shasum | |
| - '-shasum' | |
| - shasumsSignatureUrl | |
| - '-shasumsSignatureUrl' | |
| - shasumsUrl | |
| - '-shasumsUrl' | |
| - source | |
| - '-source' | |
| - sourceUrl | |
| - '-sourceUrl' | |
| - trustSignature | |
| - '-trustSignature' | |
| - id | |
| - '-id' | |
| - name: fields[implementation] | |
| in: query | |
| description: Selects the set of implementation fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - arch | |
| - asciiArmor | |
| - downloadUrl | |
| - filename | |
| - keyId | |
| - os | |
| - shasum | |
| - shasumsSignatureUrl | |
| - shasumsUrl | |
| - source | |
| - sourceUrl | |
| - trustSignature | |
| - version | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - version | |
| - name: filter[implementation] | |
| in: query | |
| description: Filters the collection of implementation using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/implementation' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - implementation | |
| description: Creates an item of type implementation and adds it to implementation | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/implementation' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/implementation' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: providerId | |
| in: path | |
| description: provider Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: versionId | |
| in: path | |
| description: version Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/provider/{providerId}/version/{versionId}/implementation/{implementationId}: | |
| get: | |
| tags: | |
| - implementation | |
| description: Returns an instance of type implementation | |
| parameters: | |
| - name: fields[implementation] | |
| in: query | |
| description: Selects the set of implementation fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - arch | |
| - asciiArmor | |
| - downloadUrl | |
| - filename | |
| - keyId | |
| - os | |
| - shasum | |
| - shasumsSignatureUrl | |
| - shasumsUrl | |
| - source | |
| - sourceUrl | |
| - trustSignature | |
| - version | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - version | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/implementation' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| delete: | |
| tags: | |
| - implementation | |
| description: Deletes an instance of type implementation | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - implementation | |
| description: Modifies an instance of type implementation | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/implementation' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: providerId | |
| in: path | |
| description: provider Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: versionId | |
| in: path | |
| description: version Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: implementationId | |
| in: path | |
| description: implementation Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/provider/{providerId}/version/{versionId}/relationships/implementation: | |
| get: | |
| tags: | |
| - implementation | |
| description: Returns the relationship identifiers for implementation | |
| parameters: | |
| - name: filter[implementation] | |
| in: query | |
| description: Filters the collection of implementation using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - implementation | |
| id: | |
| type: string | |
| post: | |
| tags: | |
| - implementation | |
| description: Adds items to the relationship implementation | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - implementation | |
| id: | |
| type: string | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - implementation | |
| id: | |
| type: string | |
| delete: | |
| tags: | |
| - implementation | |
| description: Deletes items from the relationship implementation | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - implementation | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - implementation | |
| description: Replaces the relationship implementation | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - implementation | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: providerId | |
| in: path | |
| description: provider Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: versionId | |
| in: path | |
| description: version Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization: | |
| get: | |
| tags: | |
| - organization | |
| description: Returns the collection of type organization | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - description | |
| - '-description' | |
| - disabled | |
| - '-disabled' | |
| - executionMode | |
| - '-executionMode' | |
| - name | |
| - '-name' | |
| - id | |
| - '-id' | |
| - name: fields[organization] | |
| in: query | |
| description: Selects the set of organization fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - description | |
| - disabled | |
| - executionMode | |
| - name | |
| - agent | |
| - globalvar | |
| - job | |
| - module | |
| - provider | |
| - ssh | |
| - tag | |
| - team | |
| - template | |
| - vcs | |
| - workspace | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - agent | |
| - globalvar | |
| - job | |
| - module | |
| - provider | |
| - ssh | |
| - tag | |
| - team | |
| - template | |
| - vcs | |
| - workspace | |
| - name: filter[organization] | |
| in: query | |
| description: Filters the collection of organization using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: filter | |
| in: query | |
| description: Filters the collection of organization using a 'joined' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/organization' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - organization | |
| description: Creates an item of type organization | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/organization' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/organization' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| /organization/{organizationId}: | |
| get: | |
| tags: | |
| - organization | |
| description: Returns an instance of type organization | |
| parameters: | |
| - name: fields[organization] | |
| in: query | |
| description: Selects the set of organization fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - description | |
| - disabled | |
| - executionMode | |
| - name | |
| - agent | |
| - globalvar | |
| - job | |
| - module | |
| - provider | |
| - ssh | |
| - tag | |
| - team | |
| - template | |
| - vcs | |
| - workspace | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - agent | |
| - globalvar | |
| - job | |
| - module | |
| - provider | |
| - ssh | |
| - tag | |
| - team | |
| - template | |
| - vcs | |
| - workspace | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/organization' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| delete: | |
| tags: | |
| - organization | |
| description: Deletes an instance of type organization | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - organization | |
| description: Modifies an instance of type organization | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/organization' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /workspace/{workspaceId}/vcs: | |
| get: | |
| tags: | |
| - vcs | |
| description: Returns the relationship vcs | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - accessToken | |
| - '-accessToken' | |
| - apiUrl | |
| - '-apiUrl' | |
| - callback | |
| - '-callback' | |
| - clientId | |
| - '-clientId' | |
| - clientSecret | |
| - '-clientSecret' | |
| - createdBy | |
| - '-createdBy' | |
| - description | |
| - '-description' | |
| - endpoint | |
| - '-endpoint' | |
| - name | |
| - '-name' | |
| - redirectUrl | |
| - '-redirectUrl' | |
| - updatedBy | |
| - '-updatedBy' | |
| - id | |
| - '-id' | |
| - name: fields[vcs] | |
| in: query | |
| description: Selects the set of vcs fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - accessToken | |
| - apiUrl | |
| - callback | |
| - clientId | |
| - clientSecret | |
| - createdBy | |
| - createdDate | |
| - description | |
| - endpoint | |
| - name | |
| - redirectUrl | |
| - status | |
| - updatedBy | |
| - updatedDate | |
| - vcsType | |
| - organization | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| - name: filter[vcs] | |
| in: query | |
| description: Filters the collection of vcs using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/vcs' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - vcs | |
| description: Creates an item of type vcs and adds it to vcs | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/vcs' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/vcs' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| parameters: | |
| - name: workspaceId | |
| in: path | |
| description: workspace Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /workspace/{workspaceId}/vcs/{vcsId}: | |
| get: | |
| tags: | |
| - vcs | |
| description: Returns an instance of type vcs | |
| parameters: | |
| - name: fields[vcs] | |
| in: query | |
| description: Selects the set of vcs fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - accessToken | |
| - apiUrl | |
| - callback | |
| - clientId | |
| - clientSecret | |
| - createdBy | |
| - createdDate | |
| - description | |
| - endpoint | |
| - name | |
| - redirectUrl | |
| - status | |
| - updatedBy | |
| - updatedDate | |
| - vcsType | |
| - organization | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/vcs' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| delete: | |
| tags: | |
| - vcs | |
| description: Deletes an instance of type vcs | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - vcs | |
| description: Modifies an instance of type vcs | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/vcs' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: workspaceId | |
| in: path | |
| description: workspace Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: vcsId | |
| in: path | |
| description: vcs Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /workspace/{workspaceId}/relationships/vcs: | |
| get: | |
| tags: | |
| - vcs | |
| description: Returns the relationship identifiers for vcs | |
| parameters: | |
| - name: filter[vcs] | |
| in: query | |
| description: Filters the collection of vcs using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - vcs | |
| id: | |
| type: string | |
| patch: | |
| tags: | |
| - vcs | |
| description: Replaces the relationship vcs | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - vcs | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: workspaceId | |
| in: path | |
| description: workspace Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/globalvar: | |
| get: | |
| tags: | |
| - globalvar | |
| description: Returns the relationship globalvar | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - description | |
| - '-description' | |
| - hcl | |
| - '-hcl' | |
| - key | |
| - '-key' | |
| - sensitive | |
| - '-sensitive' | |
| - value | |
| - '-value' | |
| - id | |
| - '-id' | |
| - name: fields[globalvar] | |
| in: query | |
| description: Selects the set of globalvar fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - category | |
| - description | |
| - hcl | |
| - key | |
| - sensitive | |
| - value | |
| - organization | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| - name: filter[globalvar] | |
| in: query | |
| description: Filters the collection of globalvar using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/globalvar' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - globalvar | |
| description: Creates an item of type globalvar and adds it to globalvar | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/globalvar' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/globalvar' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/globalvar/{globalvarId}: | |
| get: | |
| tags: | |
| - globalvar | |
| description: Returns an instance of type globalvar | |
| parameters: | |
| - name: fields[globalvar] | |
| in: query | |
| description: Selects the set of globalvar fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - category | |
| - description | |
| - hcl | |
| - key | |
| - sensitive | |
| - value | |
| - organization | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/globalvar' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| delete: | |
| tags: | |
| - globalvar | |
| description: Deletes an instance of type globalvar | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - globalvar | |
| description: Modifies an instance of type globalvar | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/globalvar' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: globalvarId | |
| in: path | |
| description: globalvar Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/relationships/globalvar: | |
| get: | |
| tags: | |
| - globalvar | |
| description: Returns the relationship identifiers for globalvar | |
| parameters: | |
| - name: filter[globalvar] | |
| in: query | |
| description: Filters the collection of globalvar using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - globalvar | |
| id: | |
| type: string | |
| post: | |
| tags: | |
| - globalvar | |
| description: Adds items to the relationship globalvar | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - globalvar | |
| id: | |
| type: string | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - globalvar | |
| id: | |
| type: string | |
| delete: | |
| tags: | |
| - globalvar | |
| description: Deletes items from the relationship globalvar | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - globalvar | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - globalvar | |
| description: Replaces the relationship globalvar | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - globalvar | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/workspace: | |
| get: | |
| tags: | |
| - workspace | |
| description: Returns the relationship workspace | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - branch | |
| - '-branch' | |
| - createdBy | |
| - '-createdBy' | |
| - defaultTemplate | |
| - '-defaultTemplate' | |
| - deleted | |
| - '-deleted' | |
| - description | |
| - '-description' | |
| - executionMode | |
| - '-executionMode' | |
| - folder | |
| - '-folder' | |
| - iacType | |
| - '-iacType' | |
| - locked | |
| - '-locked' | |
| - moduleSshKey | |
| - '-moduleSshKey' | |
| - name | |
| - '-name' | |
| - source | |
| - '-source' | |
| - terraformVersion | |
| - '-terraformVersion' | |
| - updatedBy | |
| - '-updatedBy' | |
| - id | |
| - '-id' | |
| - name: fields[workspace] | |
| in: query | |
| description: Selects the set of workspace fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - branch | |
| - createdBy | |
| - createdDate | |
| - defaultTemplate | |
| - deleted | |
| - description | |
| - executionMode | |
| - folder | |
| - iacType | |
| - locked | |
| - moduleSshKey | |
| - name | |
| - source | |
| - terraformVersion | |
| - updatedBy | |
| - updatedDate | |
| - agent | |
| - history | |
| - job | |
| - organization | |
| - schedule | |
| - ssh | |
| - variable | |
| - vcs | |
| - workspaceTag | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - agent | |
| - history | |
| - job | |
| - organization | |
| - schedule | |
| - ssh | |
| - variable | |
| - vcs | |
| - workspaceTag | |
| - name: filter[workspace] | |
| in: query | |
| description: Filters the collection of workspace using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/workspace' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - workspace | |
| description: Creates an item of type workspace and adds it to workspace | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/workspace' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/workspace' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/workspace/{workspaceId}: | |
| get: | |
| tags: | |
| - workspace | |
| description: Returns an instance of type workspace | |
| parameters: | |
| - name: fields[workspace] | |
| in: query | |
| description: Selects the set of workspace fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - branch | |
| - createdBy | |
| - createdDate | |
| - defaultTemplate | |
| - deleted | |
| - description | |
| - executionMode | |
| - folder | |
| - iacType | |
| - locked | |
| - moduleSshKey | |
| - name | |
| - source | |
| - terraformVersion | |
| - updatedBy | |
| - updatedDate | |
| - agent | |
| - history | |
| - job | |
| - organization | |
| - schedule | |
| - ssh | |
| - variable | |
| - vcs | |
| - workspaceTag | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - agent | |
| - history | |
| - job | |
| - organization | |
| - schedule | |
| - ssh | |
| - variable | |
| - vcs | |
| - workspaceTag | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/workspace' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| delete: | |
| tags: | |
| - workspace | |
| description: Deletes an instance of type workspace | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - workspace | |
| description: Modifies an instance of type workspace | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/workspace' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: workspaceId | |
| in: path | |
| description: workspace Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/relationships/workspace: | |
| get: | |
| tags: | |
| - workspace | |
| description: Returns the relationship identifiers for workspace | |
| parameters: | |
| - name: filter[workspace] | |
| in: query | |
| description: Filters the collection of workspace using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - workspace | |
| id: | |
| type: string | |
| post: | |
| tags: | |
| - workspace | |
| description: Adds items to the relationship workspace | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - workspace | |
| id: | |
| type: string | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - workspace | |
| id: | |
| type: string | |
| delete: | |
| tags: | |
| - workspace | |
| description: Deletes items from the relationship workspace | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - workspace | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - workspace | |
| description: Replaces the relationship workspace | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - workspace | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/ssh: | |
| get: | |
| tags: | |
| - ssh | |
| description: Returns the relationship ssh | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - createdBy | |
| - '-createdBy' | |
| - description | |
| - '-description' | |
| - name | |
| - '-name' | |
| - privateKey | |
| - '-privateKey' | |
| - updatedBy | |
| - '-updatedBy' | |
| - id | |
| - '-id' | |
| - name: fields[ssh] | |
| in: query | |
| description: Selects the set of ssh fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - createdBy | |
| - createdDate | |
| - description | |
| - name | |
| - privateKey | |
| - sshType | |
| - updatedBy | |
| - updatedDate | |
| - organization | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| - name: filter[ssh] | |
| in: query | |
| description: Filters the collection of ssh using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ssh' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - ssh | |
| description: Creates an item of type ssh and adds it to ssh | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/ssh' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/ssh' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/ssh/{sshId}: | |
| get: | |
| tags: | |
| - ssh | |
| description: Returns an instance of type ssh | |
| parameters: | |
| - name: fields[ssh] | |
| in: query | |
| description: Selects the set of ssh fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - createdBy | |
| - createdDate | |
| - description | |
| - name | |
| - privateKey | |
| - sshType | |
| - updatedBy | |
| - updatedDate | |
| - organization | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/ssh' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| delete: | |
| tags: | |
| - ssh | |
| description: Deletes an instance of type ssh | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - ssh | |
| description: Modifies an instance of type ssh | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/ssh' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| - name: sshId | |
| in: path | |
| description: ssh Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /organization/{organizationId}/relationships/ssh: | |
| get: | |
| tags: | |
| - ssh | |
| description: Returns the relationship identifiers for ssh | |
| parameters: | |
| - name: filter[ssh] | |
| in: query | |
| description: Filters the collection of ssh using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - ssh | |
| id: | |
| type: string | |
| post: | |
| tags: | |
| - ssh | |
| description: Adds items to the relationship ssh | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - ssh | |
| id: | |
| type: string | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - ssh | |
| id: | |
| type: string | |
| delete: | |
| tags: | |
| - ssh | |
| description: Deletes items from the relationship ssh | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - ssh | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| patch: | |
| tags: | |
| - ssh | |
| description: Replaces the relationship ssh | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| enum: | |
| - ssh | |
| id: | |
| type: string | |
| responses: | |
| '204': | |
| description: Successful response | |
| parameters: | |
| - name: organizationId | |
| in: path | |
| description: organization Identifier | |
| required: true | |
| schema: | |
| type: string | |
| /workspace/{workspaceId}/job: | |
| get: | |
| tags: | |
| - job | |
| description: Returns the relationship job | |
| parameters: | |
| - name: sort | |
| in: query | |
| description: Sorts the collection on the selected attributes. A prefix of '-' sorts descending | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - approvalTeam | |
| - '-approvalTeam' | |
| - comments | |
| - '-comments' | |
| - commitId | |
| - '-commitId' | |
| - createdBy | |
| - '-createdBy' | |
| - output | |
| - '-output' | |
| - planChanges | |
| - '-planChanges' | |
| - refresh | |
| - '-refresh' | |
| - refreshOnly | |
| - '-refreshOnly' | |
| - tcl | |
| - '-tcl' | |
| - templateReference | |
| - '-templateReference' | |
| - terraformPlan | |
| - '-terraformPlan' | |
| - updatedBy | |
| - '-updatedBy' | |
| - via | |
| - '-via' | |
| - id | |
| - '-id' | |
| - name: fields[job] | |
| in: query | |
| description: Selects the set of job fields that should be returned in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - approvalTeam | |
| - comments | |
| - commitId | |
| - createdBy | |
| - createdDate | |
| - output | |
| - planChanges | |
| - refresh | |
| - refreshOnly | |
| - status | |
| - tcl | |
| - templateReference | |
| - terraformPlan | |
| - updatedBy | |
| - updatedDate | |
| - via | |
| - organization | |
| - step | |
| - workspace | |
| - name: include | |
| in: query | |
| description: Selects the set of relationships that should be expanded as a compound document in the result. | |
| style: form | |
| explode: false | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - organization | |
| - step | |
| - workspace | |
| - name: filter[job] | |
| in: query | |
| description: Filters the collection of job using a 'disjoint' RSQL expression | |
| schema: | |
| type: string | |
| - name: page[number] | |
| in: query | |
| description: Number of pages to return. Can be used with page[size] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[size] | |
| in: query | |
| description: Number of elements per page. Can be used with page[number] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[offset] | |
| in: query | |
| description: Offset from 0 to start paginating. Can be used with page[limit] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[limit] | |
| in: query | |
| description: Maximum number of items to return. Can be used with page[offset] | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: page[totals] | |
| in: query | |
| description: For requesting total pages/records be included in the response page meta data | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/job' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| post: | |
| tags: | |
| - job | |
| description: Creates an item of type job and adds it to job | |
| requestBody: | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/job' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: | |
| type: object | |
| responses: | |
| '201': | |
| description: Successful response | |
| content: | |
| application/vnd.api+json: | |
| schema: | |
| type: object | |
| properties: | |
| data: | |
| $ref: '#/components/schemas/job' | |
| included: | |
| uniqueItems: true | |
| type: array | |
| description: Included resources | |
| items: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| id: | |
| type: string | |
| attributes: | |
| type: object | |
| relationships: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment