uniqueg/ga4gh_cloud_error_handling.md

## ga4gh_cloud_error_handling.md

      
    Raw
  

              ga4gh_cloud_error_handling.md
            
          
    Error handling across GA4GH Cloud specs

Date: 24-MAY-2020
WES

'400':
  description: The request is malformed.
  schema:
    $ref: '#/definitions/ErrorResponse'
'401':
  description: The request is unauthorized.
  schema:
    $ref: '#/definitions/ErrorResponse'
'403':
  description: The requester is not authorized to perform this action.
  schema:
    $ref: '#/definitions/ErrorResponse'
'404':
  description: The requested workflow run not found.
  schema:
    $ref: '#/definitions/ErrorResponse'
'404':
  description: The requested workflow run wasn't found.
  schema:
    $ref: '#/definitions/ErrorResponse'
'500':
  description: An unexpected error occurred.
  schema:
    $ref: '#/definitions/ErrorResponse'

ErrorResponse:
  description: >-
    An object that can optionally include information about the error.
  type: object
  properties:
    msg:
      type: string
      description: A detailed error message.
    status_code:
      type: integer
      description: The integer representing the HTTP status code (e.g. 200, 404).
TES

No error model and responses defined.
DRS

'400':
  description: The request is malformed.
  schema:
    $ref: '#/definitions/Error'
'401':
  description: The request is unauthorized.
  schema:
    $ref: '#/definitions/Error'
'403':
  description: The requester is not authorized to perform this action.
  schema:
    $ref: '#/definitions/Error'
'404':
  description: The requested `DrsObject` wasn't found
  schema:
    $ref: '#/definitions/Error'
'404':
  description: The requested access URL wasn't found
  schema:
    $ref: '#/definitions/Error'
'500':
  description: An unexpected error occurred.
  schema:
    $ref: '#/definitions/Error'

Error:
  description:
    An object that can optionally include information about the error.
  type: object
  properties:
    msg:
      type: string
      description: A detailed error message.
    status_code:
      type: integer
      description: The integer representing the HTTP status code (e.g. 200, 404).
TRS

"404":
  description: The tool can not be found.
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/Error"
    text/plain:
      schema:
        $ref: "#/components/schemas/Error"
"404":
  description: The tool descriptor can not be found.
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/Error"
    text/plain:
      schema:
        $ref: "#/components/schemas/Error"
"404":
  description: The tool can not be output in the specified type.
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/Error"
    text/plain:
      schema:
        $ref: "#/components/schemas/Error"
"404":
  description: There are no container specifications for this tool.
  content:
    application/json:
      schema:
        $ref: "#/components/schemas/Error"
    text/plain:
      schema:
        $ref: "#/components/schemas/Error"

Error:
  type: object
  required:
    - code
  properties:
    code:
      type: integer
      format: int32
      default: 500
    message:
      type: string
      default: Internal Server Error