sumne.yml

openapi: 3.0.0
info:
  title: Gluster Management APIs
  description: Gluster Peer and Volume Management APIs
  version: 1
servers:
  - url: http://gluster.example.com/v1
    description: Gluster node
paths:
  /volumes:
    get:
      summary: Get Volumes informaton
      responses:
        '200':    # status code
          description: A JSON array of Gluster Volumes
          content:
            application/json:
              schema: 
                type: array
                items: 
                  $ref: "#definitions/volume"
                example:
                  $ref: "#examples/volume"

definitions:
  volume:
    type: object
    properties:
      id:
        type: string
      name:
        type: string
      type:
        type: string
      transport:
        type: string
      distribute-count:
        type: int
      replica-count:
        type: int
      arbiter-count:
        type: int
      options:
        type: object
      state:
        type: string
      subvols:
        type: array
        items:
          type: object
          properties:
            name:
              type: string
            type:
              type: string
            bricks:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  path:
                    type: string
                  volume-id:
                    type: string
                  volume-name:
                    type: string
                  peer-id:
                    type: string
                  host:
                    type: string
                  type:
                    type: string
            replica-count:
              type: int
            arbiter-count:
              type: int
      metadata:
        type: object
        properties:
          
      snap-list:
        type: array
        items:
          type: string

examples:
  volume:
    id: 95dd8a65-fc4b-447e-ba5b-8a541df319f2
    name: gv1
    type: Distributed Replicate
    transport: tcp
    distribute-count: 2
    replica-count: 3
    arbiter-count: 0
    options:
      changelog.changelog: on
    state: Started
    subvols:
      - name: subvol-0
        type: Replicate
        replica-count: 3
        arbiter-count: 0
        bricks:
          - id: b5f243c1-5705-4f19-acf0-fea36570b706
            path: /exports/brick1
            volume-id: 95dd8a65-fc4b-447e-ba5b-8a541df319f2
            volume-name: gv1
            peer-id: 9bf0a19f-0680-438c-a213-ba16252c31da
            host: node1.example.com
            type: brick

          - id: e31ec08d-7855-40ad-a071-160e7aede43e
            path: /exports/brick2
            volume-id: 95dd8a65-fc4b-447e-ba5b-8a541df319f2
            volume-name: gv1
            peer-id: ea8a2787-4166-43ec-b5b3-e17fad649bae
            host: node2.example.com
            type: brick

          - id: 58cd6364-4245-414e-b0de-b27e380a73c9
            path: /exports/brick3
            volume-id: 95dd8a65-fc4b-447e-ba5b-8a541df319f2
            volume-name: gv1
            peer-id: fd3d8424-7bea-4a75-a2a8-14f4bd450568
            host: node3.example.com
            type: brick

      - name: subvol-1
        type: Replicate
        replica-count: 3
        arbiter-count: 0
        bricks:
          - id: 17404eb2-f97c-42b7-be3b-f24c5c8b2b0f
            path: /exports/brick4
            volume-id: 95dd8a65-fc4b-447e-ba5b-8a541df319f2
            volume-name: gv1
            peer-id: f1928a2c-8a39-45f9-8e9f-da4a8c425fde
            host: node4.example.com
            type: brick

          - id: 43d498da-3571-40fa-b45b-0df759ef6c58
            path: /exports/brick5
            volume-id: 95dd8a65-fc4b-447e-ba5b-8a541df319f2
            volume-name: gv1
            peer-id: cf7ee45f-db07-49e5-82a0-68e1547e1dfe
            host: node5.example.com
            type: brick

          - id: 2dc96133-085c-4fe8-8cbf-6c8c0edf6070
            path: /exports/brick6
            volume-id: 95dd8a65-fc4b-447e-ba5b-8a541df319f2
            volume-name: gv1
            peer-id: 518452c0-9a60-4a1c-9d74-cf4fea10caea
            host: node6.example.com
            type: brick

    metadata: {}
    snap-list: []