Cloudsmith status API

The status API from Cloudsmith — 1 operation(s) for status.

OpenAPI Specification

cloudsmith-status-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  title: Cloudsmith API (v1) audit-log status API
  description: The API to the Cloudsmith Service
  termsOfService: https://help.cloudsmith.io
  contact:
    name: Cloudsmith Support
    url: https://help.cloudsmith.io
    email: support@cloudsmith.io
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: v1
host: api.cloudsmith.io
basePath: /
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- apikey: []
- basic: []
tags:
- name: status
paths:
  /status/check/basic/:
    parameters: []
    get:
      operationId: status_check_basic
      summary: Endpoint to check basic API connectivity.
      description: Endpoint to check basic API connectivity.
      parameters: []
      responses:
        '200':
          description: Status check was successful
          schema:
            $ref: '#/definitions/StatusBasic'
        '400':
          description: Request could not be processed (see detail).
          schema:
            $ref: '#/definitions/ErrorDetail'
        '422':
          description: Missing or invalid parameters (see detail).
          schema:
            $ref: '#/definitions/ErrorDetail'
      tags:
      - status
      security: []
definitions:
  ErrorDetail:
    required:
    - detail
    type: object
    properties:
      detail:
        title: Detail
        description: An extended message for the response.
        type: string
        minLength: 1
      fields:
        title: Fields
        description: 'A Dictionary of related errors where key: Field and value: Array of Errors related to that field'
        type: object
        additionalProperties:
          type: array
          items:
            type: string
            minLength: 1
  StatusBasic:
    type: object
    properties:
      detail:
        title: Detail
        description: The message describing the state of the API.
        type: string
        readOnly: true
        default: Cloudsmith API is operational.
        minLength: 1
      version:
        title: Version
        description: The current version for the Cloudsmith service.
        type: string
        readOnly: true
        default: '1.0'
        minLength: 1
securityDefinitions:
  apikey:
    type: apiKey
    name: X-Api-Key
    in: header
  basic:
    type: basic