action bluemix_get_volumes_fs_name_json {
  label: "Inspect a file share"
  description: "This endpoint returns detailed information about a file share (corresponding IBM Containers command: `cf ic volume fs-inspect FSNAME`)."
  provider: bluemix
  method: GET
  path: "/volumes/fs/{name}/json"
  encoding: json
  input: {
    type: "object"
    properties: {
      "X-Auth-Project-Id": {
        type: "string"
      }
      "X-Auth-Token": {
        type: "string"
      }
      name: {
        type: "string"
      }
    }
    required: ["X-Auth-Project-Id", "X-Auth-Token", "name"]
    additionalProperties: false
  }
  output: {
    type: "array"
    items: {
      type: "object"
      properties: {
        fs: {
          type: "array"
          items: {
            type: "object"
            properties: {
              capacity: {
                type: "integer"
                description: "The size of the file share in gigabyte."
              }
              created_date: {
                type: "string"
                description: "The timestamp when the file share was created."
              }
              fsName: {
                type: "string"
                description: "The name of the file share."
              }
              hostPath: {
                type: "string"
                description: "The path to the volume on the host node."
              }
              iops: {
                type: "number"
                format: "double"
                description: "The number of Input/Output operations per second. "
              }
              iopsTotal: {
                type: "integer"
                description: "The total number of IOPS considering the size of the file share. The size of your file share in gigabyte multiplied with the number of IOPS indicates the total number of IOPS. The higher the number of IOPS the faster you can read from and write to your volumes."
              }
              orderId: {
                type: "string"
                description: "The ID received from softlayer when the file share was ordered to be set up in softlayer."
              }
              provider: {
                type: "string"
                description: "The provider of the file share."
              }
              spaceGuid: {
                type: "string"
                description: "The unique ID representing a Bluemix space in which the file share was created."
              }
              state: {
                type: "string"
                description: "The current state of the file share. When the file share is ready to be used, this attribute is set to `READY`."
              }
              updated_date: {
                type: "string"
                description: "The timestamp when the file share last was updated."
              }
            }
          }
        }
        fsUsage: {
          type: "array"
          items: {
            type: "object"
            properties: {
              available_space: {
                type: "string"
                description: "The amount of space that is available in the file share in gigabytes."
              }
              total_space: {
                type: "string"
                description: "The total size of the file share in gigabytes."
              }
              used_space: {
                type: "string"
                description: "The amount of space that is currently used from the file share. "
              }
              used_space_percentage: {
                type: "string"
                description: "The amount of space that is currently used from the file share in percentage."
              }
            }
          }
        }
        volnames: {
          type: "array"
          description: "A list of volume names that are mounted to the file share."
          items: {
            type: "string"
          }
        }
      }
    }
  }
}