ws.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Azure WebSocket Service REST API",
    "version": "v1"
  },
  "paths": {
    "/api/health": {
      "head": {
        "tags": [
          "general"
        ],
        "summary": "Get service health status.",
        "operationId": "HealthApi_GetHealthStatus",
        "parameters": [
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "The service is healthy"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/hubs/{hub}/messages": {
      "post": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Broadcast content inside request body to all the connected connections in the same hub.",
        "operationId": "WebSocketConnectionApi_Broadcast",
        "consumes": [
          "application/octet-stream",
          "text/plain"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "excluded",
            "description": "Excluded connection Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          },
          {
            "in": "body",
            "name": "payloadMessage",
            "required": true,
            "schema": {
              "format": "binary",
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/hubs/{hub}/users/{id}/messages": {
      "post": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Send content inside request body to the specific user.",
        "operationId": "WebSocketConnectionApi_SendToUser",
        "consumes": [
          "application/octet-stream",
          "text/plain"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "The user Id.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          },
          {
            "in": "body",
            "name": "payloadMessage",
            "required": true,
            "schema": {
              "format": "binary",
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/hubs/{hub}/connections/{connectionId}": {
      "head": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Check if the connection with the given connectionId exists",
        "operationId": "WebSocketConnectionApi_CheckConnectionExistence",
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$"
          },
          {
            "in": "path",
            "name": "connectionId",
            "description": "The connection Id.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "Not Found"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      },
      "delete": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Close the client connection",
        "operationId": "WebSocketConnectionApi_CloseClientConnection",
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$"
          },
          {
            "in": "path",
            "name": "connectionId",
            "description": "The connection Id.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "reason",
            "description": "The reason of the connection close.",
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/hubs/{hub}/connections/{connectionId}/messages": {
      "post": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Send content inside request body to the specific connection.",
        "operationId": "WebSocketConnectionApi_SendToConnection",
        "consumes": [
          "application/octet-stream",
          "text/plain"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "connectionId",
            "description": "The connection Id.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          },
          {
            "in": "body",
            "name": "payloadMessage",
            "required": true,
            "schema": {
              "format": "binary",
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/hubs/{hub}/groups/{group}": {
      "head": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Check if there are any client connections inside the given group",
        "operationId": "WebSocketConnectionApi_CheckGroupExistence",
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$"
          },
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "Not Found"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/hubs/{hub}/groups/{group}/messages": {
      "post": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Send content inside request body to a group of connections.",
        "operationId": "WebSocketConnectionApi_GroupBroadcast",
        "consumes": [
          "application/octet-stream",
          "text/plain"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "excluded",
            "description": "Excluded connection Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          },
          {
            "in": "body",
            "name": "payloadMessage",
            "required": true,
            "schema": {
              "format": "binary",
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/hubs/{hub}/users/{user}": {
      "head": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Check if there are any client connections connected for the given user",
        "operationId": "WebSocketConnectionApi_CheckUserExistence",
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$"
          },
          {
            "in": "path",
            "name": "user",
            "description": "The user Id.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "Not Found"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/hubs/{hub}/groups/{group}/connections/{connectionId}": {
      "put": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Add a connection to the target group.",
        "operationId": "WebSocketConnectionApi_AddConnectionToGroup",
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$"
          },
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "connectionId",
            "description": "Target connection Id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "Not Found"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      },
      "delete": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Remove a connection from the target group.",
        "operationId": "WebSocketConnectionApi_RemoveConnectionFromGroup",
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$"
          },
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "connectionId",
            "description": "Target connection Id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "Not Found"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/hubs/{hub}/users/{user}/groups/{group}": {
      "head": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Check whether a user exists in the target group.",
        "operationId": "WebSocketConnectionApi_CheckUserExistenceInGroup",
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$"
          },
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "user",
            "description": "Target user Id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "Not Found"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      },
      "put": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Add a user to the target group.",
        "operationId": "WebSocketConnectionApi_AddUserToGroup",
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$"
          },
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "user",
            "description": "Target user Id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ttl",
            "description": "Specifies the seconds that the user exists in the group. If not set, the user lives in the group forever.",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      },
      "delete": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Remove a user from the target group.",
        "operationId": "WebSocketConnectionApi_RemoveUserFromGroup",
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$"
          },
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "user",
            "description": "Target user Id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/hubs/{hub}/users/{user}/groups": {
      "delete": {
        "tags": [
          "websocket.customHub"
        ],
        "summary": "Remove a user from all groups.",
        "operationId": "WebSocketConnectionApi_RemoveUserFromAllGroups",
        "parameters": [
          {
            "in": "path",
            "name": "hub",
            "description": "Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.",
            "required": true,
            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$"
          },
          {
            "in": "path",
            "name": "user",
            "description": "Target user Id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "The user is deleted"
          },
          "202": {
            "description": "The delete request is accepted and service is handling the request int the background"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/messages": {
      "post": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Broadcast content inside request body to all the connected to endpoint \"/ws/client\"",
        "operationId": "WebSocketConnectionApi_DefaultHubBroadcast",
        "consumes": [
          "application/octet-stream",
          "text/plain"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "excluded",
            "description": "Excluded connection Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          },
          {
            "in": "body",
            "name": "payloadMessage",
            "required": true,
            "schema": {
              "format": "binary",
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/users/{id}/messages": {
      "post": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Send content inside request body to the specific user.",
        "operationId": "WebSocketConnectionApi_SendToDefaultHubUser",
        "consumes": [
          "application/octet-stream",
          "text/plain"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The user Id.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          },
          {
            "in": "body",
            "name": "payloadMessage",
            "required": true,
            "schema": {
              "format": "binary",
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/connections/{connectionId}": {
      "head": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Check if the connection with the given connectionId exists",
        "operationId": "WebSocketConnectionApi_CheckDefaultHubConnectionExistence",
        "parameters": [
          {
            "in": "path",
            "name": "connectionId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "Not Found"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      },
      "delete": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Close the client connection",
        "operationId": "WebSocketConnectionApi_CloseDefaultHubClientConnection",
        "parameters": [
          {
            "in": "path",
            "name": "connectionId",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "reason",
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/connections/{connectionId}/messages": {
      "post": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Send content inside request body to the specific connection.",
        "operationId": "WebSocketConnectionApi_SendToDefaultHubConnection",
        "consumes": [
          "application/octet-stream",
          "text/plain"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "connectionId",
            "description": "The connection Id.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          },
          {
            "in": "body",
            "name": "payloadMessage",
            "required": true,
            "schema": {
              "format": "binary",
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/groups/{group}": {
      "head": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Check if there are any client connections inside the given group",
        "operationId": "WebSocketConnectionApi_CheckDefaultHubGroupExistence",
        "parameters": [
          {
            "in": "path",
            "name": "group",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "Not Found"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/groups/{group}/messages": {
      "post": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Send content inside request body to a group of connections.",
        "operationId": "WebSocketConnectionApi_DefaultHubGroupBroadcast",
        "consumes": [
          "application/octet-stream",
          "text/plain"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "excluded",
            "description": "Excluded connection Ids",
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          },
          {
            "in": "body",
            "name": "payloadMessage",
            "required": true,
            "schema": {
              "format": "binary",
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/users/{user}": {
      "head": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Check if there are any client connections connected for the given user",
        "operationId": "WebSocketConnectionApi_CheckDefaultHubUserExistence",
        "parameters": [
          {
            "in": "path",
            "name": "user",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "Not Found"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/groups/{group}/connections/{connectionId}": {
      "put": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Add a connection to the target group.",
        "operationId": "WebSocketConnectionApi_AddConnectionToDefaultHubGroup",
        "parameters": [
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "connectionId",
            "description": "Target connection Id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "Not Found"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      },
      "delete": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Remove a connection from the target group.",
        "operationId": "WebSocketConnectionApi_RemoveConnectionFromDefaultHubGroup",
        "parameters": [
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "connectionId",
            "description": "Target connection Id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "Not Found"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/users/{user}/groups/{group}": {
      "head": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Check whether a user exists in the target group.",
        "operationId": "WebSocketConnectionApi_CheckUserExistenceInDefaultHubGroup",
        "parameters": [
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "user",
            "description": "Target user Id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "404": {
            "description": "Not Found"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      },
      "put": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Add a user to the target group.",
        "operationId": "WebSocketConnectionApi_AddUserToDefaultHubGroup",
        "parameters": [
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "user",
            "description": "Target user Id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "ttl",
            "description": "Specifies the seconds that the user exists in the group. If not set, the user lives in the group forever.",
            "type": "integer",
            "format": "int32"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      },
      "delete": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Remove a user from the target group.",
        "operationId": "WebSocketConnectionApi_RemoveUserFromDefaultHubGroup",
        "parameters": [
          {
            "in": "path",
            "name": "group",
            "description": "Target group name, which length should be greater than 0 and less than 1025.",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "user",
            "description": "Target user Id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "202": {
            "description": "Success"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    },
    "/ws/api/users/{user}/groups": {
      "delete": {
        "tags": [
          "websocket.defaultHub"
        ],
        "summary": "Remove a user from all groups.",
        "operationId": "WebSocketConnectionApi_RemoveUserFromAllDefaultHubGroups",
        "parameters": [
          {
            "in": "path",
            "name": "user",
            "description": "Target user Id",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "api-version",
            "type": "string",
            "default": "2020-10-01"
          }
        ],
        "responses": {
          "200": {
            "description": "The user is deleted"
          },
          "202": {
            "description": "The delete request is accepted and service is handling the request int the background"
          },
          "default": {
            "description": "Error response",
            "x-ms-error-response": true
          }
        }
      }
    }
  },
  "securityDefinitions": {
    "Bearer": {
      "type": "apiKey",
      "name": "Authorization",
      "in": "header",
      "description": "JWT Authorization header using the Bearer scheme. \r\n\r\n Enter 'Bearer' [space] and then your token in the text input below.\r\n\r\nExample: \"Bearer 12345abcdef\""
    }
  },
  "security": [
    {
      "Bearer": [ ]
    }
  ]
}