{
  "openapi": "3.0.1",
  "info": {
    "title": "Transports",
    "version": "9.1.20.0",
    "description": "Create and administer the transports.",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "paths": {
    "/transports": {
      "get": {
        "tags": [
          "transports"
        ],
        "description": "Get a collection of Store transports.",
        "operationId": "getTransports",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The transport ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "code",
            "in": "query",
            "description": "The code of the transport.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "The name of the transport.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "description",
            "in": "query",
            "description": "The description.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "timeout",
            "in": "query",
            "description": "The timeout.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "implemented",
            "in": "query",
            "description": "If it is implemented.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "addressable",
            "in": "query",
            "description": "If it is addressable.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of Store transports.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransportCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "transports"
        ],
        "description": "Create an Store transport.",
        "operationId": "createTransport",
        "requestBody": {
          "description": "A store transport.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Transports"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the transports.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetTransportsById": {
                "operationRef": "#/paths/~1transports~1{id}/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /transports/{id}`.\n"
              },
              "DeleteTransportsById": {
                "operationRef": "#/paths/~1transports~1{id}/delete",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /transports/{id}`.\n"
              },
              "UpdateTransportsById": {
                "operationRef": "#/paths/~1transports~1{id}/patch",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `PATCH /transports/{id}`.\n"
              },
              "GetTransportsConnectionSpecMetaInfoById": {
                "operationRef": "#/paths/~1transports~1{id}~1connection-spec-meta-info/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /transports/{id}/connection-spec-meta-info`.\n"
              },
              "GetTransportsInteractionSpecMetaInfoById": {
                "operationRef": "#/paths/~1transports~1{id}~1interaction-spec-meta-info/get",
                "parameters": {
                  "id": "$request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /transports/{id}/interaction-spec-meta-info`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "Transport"
      }
    },
    "/transports/{id}": {
      "get": {
        "tags": [
          "transports"
        ],
        "description": "Get an Store transport.",
        "operationId": "getTransportById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The transport ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A store transport.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Transport"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "transports"
        ],
        "description": "Delete an Store transport.",
        "operationId": "deleteTransportById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The transport ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "transports"
        ],
        "description": "Update an Store transport.",
        "operationId": "updateTransportById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The transport ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "A store transport.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Transports"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "Transport"
      }
    },
    "/transports/{id}/connection-spec-meta-info": {
      "get": {
        "tags": [
          "transports"
        ],
        "summary": "Gets the connection specification meta-information for the specified transport.",
        "operationId": "getConnectionSpecMetaInfo",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the transport.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectionSpecMetaInfo"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      }
    },
    "/transports/{id}/interaction-spec-meta-info": {
      "get": {
        "tags": [
          "transports"
        ],
        "summary": "Gets the interaction specification meta-information for the specified transport.",
        "operationId": "getInteractionSpecMetaInfo",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the transport.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The operation is successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InteractionSpecMetaInfo"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "description": "The error message item model."
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          },
          "errors": {
            "type": "array",
            "description": "The errors.",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "Transport": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The transport ID.",
            "format": "int32"
          },
          "code": {
            "type": "string",
            "description": "The code of the transport."
          },
          "name": {
            "type": "string",
            "description": "The name of the transport."
          },
          "description": {
            "type": "string",
            "description": "The description."
          },
          "timeout": {
            "type": "integer",
            "description": "The timeout.",
            "format": "int32"
          },
          "implemented": {
            "type": "string",
            "description": "If it is implemented."
          },
          "addressable": {
            "type": "string",
            "description": "If it is addressable."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                }
              }
            }
          }
        },
        "description": "A store transport."
      },
      "Transports": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The transport ID.",
            "format": "int32"
          },
          "code": {
            "type": "string",
            "description": "The code of the transport."
          },
          "name": {
            "type": "string",
            "description": "The name of the transport."
          },
          "description": {
            "type": "string",
            "description": "The description."
          },
          "timeout": {
            "type": "integer",
            "description": "The timeout.",
            "format": "int32"
          },
          "implemented": {
            "type": "string",
            "description": "If it is implemented."
          },
          "addressable": {
            "type": "string",
            "description": "If it is addressable."
          }
        }
      },
      "TransportCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/Transport"
            }
          }
        },
        "description": "A collection of Store transports."
      },
      "ConnectionSpecProperty": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the connection specification property."
          },
          "encrypt": {
            "type": "boolean",
            "description": "Indicates that the property value is encrypted."
          },
          "value": {
            "type": "string",
            "description": "The default value of the connection specification property."
          }
        },
        "description": "A connection specification property."
      },
      "ConnectionSpecMetaInfo": {
        "type": "object",
        "properties": {
          "properties": {
            "type": "array",
            "description": "The connection specification properties.",
            "items": {
              "$ref": "#/components/schemas/ConnectionSpecProperty"
            }
          }
        },
        "description": "The transport connection specification meta-information."
      },
      "InteractionSpecProperty": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the interaction specification property."
          },
          "encrypt": {
            "type": "boolean",
            "description": "Indicates that the property value is encrypted."
          },
          "value": {
            "type": "string",
            "description": "The default value of the interaction specification property."
          }
        },
        "description": "An interaction specification property."
      },
      "InteractionSpecMetaInfo": {
        "type": "object",
        "properties": {
          "properties": {
            "type": "array",
            "description": "The interaction specification properties.",
            "items": {
              "$ref": "#/components/schemas/InteractionSpecProperty"
            }
          }
        },
        "description": "The transport connection specification meta-information."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}