# xrDebug API

2.0.3

## Servers

- Description
    xrDebug
  URL

## /

Name
  /
Regex
  /

Endpoints

- #### GETSingle page application

  Response
    - 200
      Context
        SPAController
      Headers
        Content-Type: text/html
      Body

            type: mixed

## /messages

Name
  /messages
Regex
  /messages

Endpoints

- #### POSTCreate a debug message

  Request
    Headers
      Content-Type: application/json
    Body

          type: 'array#map'
          parameters:
            body:
              required: false
              type: string
              regex: '.*?'
            emote:
              required: false
              type: string
              regex: '^.*$'
            file_line:
              required: false
              type: string
              regex: '^.*$'
            file_path:
              required: false
              type: string
              regex: '^.*$'
            id:
              required: false
              type: string
              regex: '^.*$'
            topic:
              required: false
              type: string
              regex: '^.*$'

  Response
    - 204
      Context
        MessagePostController
      Body

            type: mixed

    - 400
      Context
        VerifySignatureMiddleware

## /pauses

Name
  /pauses
Regex
  /pauses

Endpoints

- #### POSTCreate a pause

  Request
    Headers
      Content-Type: application/json
    Body

          type: 'array#map'
          parameters:
            id:
              type: string
              regex: '^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$'
            body:
              required: false
              type: string
              regex: '.*?'
            emote:
              required: false
              type: string
              regex: '^.*$'
            file_line:
              required: false
              type: string
              regex: '^.*$'
            file_path:
              required: false
              type: string
              regex: '^.*$'
            topic:
              required: false
              type: string
              regex: '^.*$'

  Response
    - 201
      Context
        PausePostController
      Headers
        Content-Type: application/json
      Body

            type: mixed

    - 400
      Context
        VerifySignatureMiddleware

## /pauses/{id}

Name
  /pauses/{id}
Regex
  ^(?|/pauses/([0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}))$
Variables
  - {id}
    Type
      string
    Regex
      `^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$`

Endpoints

- #### DELETEDelete a pause

  Response
    - 204
      Context
        PauseDeleteController
      Body

            type: mixed

    - 404
      Context
        PauseDeleteController

- #### GETGet a pause

  Response
    - 200
      Context
        PauseGetController
      Headers
        Content-Type: application/json
      Body

            type: mixed

    - 400
      Context
        VerifySignatureMiddleware
    - 404
      Context
        PauseGetController

- #### PATCHUpdate a pause to stop execution

  Response
    - 200
      Context
        PausePatchController
      Headers
        Content-Type: application/json
      Body

            type: mixed

## /stream

Name
  /stream
Regex
  /stream

Endpoints

- #### GETDebug stream

  Response
    - 200
      Context
        StreamController
      Body

            type: mixed