openapi.yaml

openapi: 3.0.3
info:
  title: ClusterViz API 3.0
  version: 1.0.0
  description: This is the description of ClusterViz API.
servers:
  - url: http://localhost:8080/api/v1
paths:
  /clusters:
    get:
      summary: Get all clusters
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Cluster'
        "403":
          description: "unauthorized operation"
          content:
            "application/json":
              schema:
                allOf:
                  - "$ref": "#/components/schemas/ErrorModel"
        "401":
          description: "unauthenticated operation"
          content:
            "application/json":
              schema:
                allOf:
                  - "$ref": "#/components/schemas/ErrorModel"
          headers:
            X-Rate-Limit-Limit:
              "$ref": "#/components/headers/X-Rate-Limit-Limit"
            X-Rate-Limit-Remaining:
              "$ref": "#/components/headers/X-Rate-Limit-Remaining"
            X-Rate-Limit-Reset:
              "$ref": "#/components/headers/X-Rate-Limit-Reset"
            X-Requset-ID:
              "$ref": "#/components/headers/X-Requset-ID"
        "400":
          description: "bad request"
          content:
            "application/json":
              schema:
                allOf:
                  - "$ref": "#/components/schemas/ErrorModel"
          headers:
            X-Rate-Limit-Limit:
              "$ref": "#/components/headers/X-Rate-Limit-Limit"
            X-Rate-Limit-Remaining:
              "$ref": "#/components/headers/X-Rate-Limit-Remaining"
            X-Rate-Limit-Reset:
              "$ref": "#/components/headers/X-Rate-Limit-Reset"
            X-Requset-ID:
              "$ref": "#/components/headers/X-Requset-ID"
  /clusters/{id}:
    get:
      summary: Get a cluster by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        "403":
          description: "unauthorized operation"
          content:
            "application/json":
              schema:
                allOf:
                  - "$ref": "#/components/schemas/ErrorModel"
        "401":
          description: "unauthenticated operation"
          content:
            "application/json":
              schema:
                allOf:
                  - "$ref": "#/components/schemas/ErrorModel"
          headers:
            X-Rate-Limit-Limit:
              "$ref": "#/components/headers/X-Rate-Limit-Limit"
            X-Rate-Limit-Remaining:
              "$ref": "#/components/headers/X-Rate-Limit-Remaining"
            X-Rate-Limit-Reset:
              "$ref": "#/components/headers/X-Rate-Limit-Reset"
            X-Requset-ID:
              "$ref": "#/components/headers/X-Requset-ID"
        "400":
          description: "bad request"
          content:
            "application/json":
              schema:
                allOf:
                  - "$ref": "#/components/schemas/ErrorModel"
          headers:
            X-Rate-Limit-Limit:
              "$ref": "#/components/headers/X-Rate-Limit-Limit"
            X-Rate-Limit-Remaining:
              "$ref": "#/components/headers/X-Rate-Limit-Remaining"
            X-Rate-Limit-Reset:
              "$ref": "#/components/headers/X-Rate-Limit-Reset"
            X-Requset-ID:
              "$ref": "#/components/headers/X-Requset-ID"
components:
  schemas:
    Cluster:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
    ErrorModel:
      title: ErrorModel
      required:
        - errorDetails
        - errorCode
        - message
        - debugId
        - httpStatusCode
      type: object
      properties:
        errorDetails:
          title: Error Details
          type: object
        errorCode:
          title: Error Code
          type: string
        message:
          title: Message
          type: string
        debugId:
          title: Debug ID
          type: string
        httpStatusCode:
          title: HttpStatus Code
          type: integer
  headers:
    X-Rate-Limit-Limit:
      description: "The number of allowed requests in the current period"
      schema:
        type: "integer"
    X-Rate-Limit-Remaining:
      description: "The number of remaining requests in the current period"
      schema:
        type: "integer"
    X-Rate-Limit-Reset:
      description: "The number of seconds left in the current period"
      schema:
        type: "integer"
    Retry-After:
      description: "The number of seconds to wait before retrying"
      schema:
        type: "integer"
    X-Requset-ID:
      description: "The request id used to track the operation"
      schema:
        type: "string"