@itentialopensource/adapter-terraform_enterprise/entities/Workspaces/schema.json

This adapter integrates with system described as: terraform Enterprise.

{
  "$id": "schema.json",
  "type": "object",
  "schema": "http://json-schema.org/draft-07/schema#",
  "translate": true,
  "dynamicfields": true,
  "properties": {
    "ph_request_type": {
      "type": "string",
      "description": "type of request (internal to adapter)",
      "default": "createWorkspace",
      "enum": [
        "createWorkspace",
        "listWorkspaces",
        "showWorkspace",
        "lockWorkspace",
        "unlockWorkspace",
        "forceUnlockWorkspace",
        "assignSSHKeyToWorkspace"
      ],
      "external_name": "ph_request_type"
    },
    "organizationName": {
      "type": "string",
      "description": "The name of the organization to list the workspaces of.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "organization_name"
    },
    "pageNumber": {
      "type": "string",
      "description": "Optional. If omitted, the endpoint will return the first page.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "page[number]"
    },
    "pageSize": {
      "type": "string",
      "description": "Optional. If omitted, the endpoint will return 150 workspaces per page.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "page[size]"
    },
    "workspaceId": {
      "type": "string",
      "description": "The workspace ID to assign the SSH key to. Obtain this from the workspace settings or the Show Workspace endpoint.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "workspace_id"
    }
  },
  "definitions": {}
}