search

swagger-api / swagger-editor

Swagger Editor
https://editor.swagger.io
Apache License 2.0
8.93k stars 2.26k forks source link

Swagger stack on fetching resource list: http://localhost:8080/api-docs; Please wait. #992

Closed reuvenk closed 8 years ago

reuvenk commented 8 years ago

Note on code generation issues Please open an issue in Swagger Codegen repository for any issue with generating code or issues with generated codes.

My Swagger Version 2.9.9

 # paste your swagger document here
swagger: '2.0'
info:
  title: AIC formation API
  description: AIC formation API
  version: 1.0.0
host: server
basePath: /af
paths:
  '/sites':
    get:
      parameters:
        - name: locationType
          in: query
          description: is filter by location type required
          type: string
      summary: return list of sites
      description: return list of all sites in AIC Formation
      tags:
        - Sites
      responses:
        '200':
          description: An array of sites
          schema:
            type: array
            items:
              $ref: '#/definitions/Site'
        '401':
          description: unauthorized
  '/sites/{siteId}':
    parameters:
      - name: siteId
        in: path
        description: site ID or site name (eg. 1 or AAA)
        type: string
        required: true
    get:
      summary: return site 
      description: return site matching the given site ID or site name
      tags:
        - Sites
      responses:
        '200':
          description: site
          schema:
            $ref: '#/definitions/Site'
        '401':
          description: unauthorized
        '404':
          description: Not Found
  '/zones/{zoneId}/openStackNetworkRanges/{vlanId}':
    parameters:
      - name: zoneId
        in: path
        description: zone ID or name (eg. 1 or AAA1)
        type: string
        required: true
      - name: vlanId
        in: path
        description: vlan ID - number that describes the vlan(1300 = Hypervisor, 1320 = iSCSI, 1022 = OOB Access, 1321 = OAM, 1330 = vMotion, 1319 = PXE1, 1318 = PXE2)
        type: string
        required: true
    get:
      summary: return a list of subnets per LCP type (a,b,null) for each of the subnet types.
      description: return a list of subnets per LCP type (a,b,null) for each of the subnet types.
      tags:
        - Vlans
      responses:
        '200':
          description: List of NetworkRange per LCP type (a, b, null) 
          schema:
            $ref: '#/definitions/NetworkRange'
        '401':
          description: unauthorized
        '404':
          description: Not Found
  '/sites/{siteId}/zones':
    parameters:
      - name: siteId
        in: path
        description: site ID or site Name
        type: string
        required: true
    get:
      parameters:
        - name: designType
          in: query
          description: is filter by design type required
          type: string
      summary: return list of zones
      description: return list of zones
      tags:
        - Zones
      responses:
        '200':
          description: An array of zones
          schema:
            type: array
            items:
              $ref: '#/definitions/Zone'
        '401':
          description: unauthorized
  '/zones':
    get:
      parameters:
        - name: designType
          in: query
          description: is filter by design type required
          type: string
      summary: return list of zones
      description: return list of zones
      tags:
        - Zones
      responses:
        '200':
          description: An array of zones
          schema:
            type: array
            items:
              $ref: '#/definitions/Zone'
        '401':
          description: unauthorized
  '/zones/{zoneId}':
    parameters:
      - name: zoneId
        in: path
        description: zone ID or zone Name
        type: string
        required: true
    get:
      summary: return zone matching the given param (zone ID or zone Name)
      description: return zone matching the given param (zone ID or zone Name)
      tags:
        - Zones
      responses:
        '200':
          description: zone
          schema:
            $ref: '#/definitions/Zone'
        '401':
          description: unauthorized
        '404':
          description: Not Found
  '/zones/{zoneId}/racks':
    parameters:
      - name: zoneId
        in: path
        description: zone ID
        type: string
        required: true
    get:
      summary: "return list of zone's racks"
      description: "return list of zone's racks"
      tags:
        - Racks
      responses:
        '200':
          description: An array of racks
          schema:
            type: array
            items:
              $ref: '#/definitions/Rack'
        '401':
          description: unauthorized
  '/zones/{zoneId}/clientProgressTracking':
    parameters:
      - name: zoneId
        in: path
        description: zone ID
        type: string
        required: true
      - name: zoneStatus
        in: body
        description: new zone status update
        schema:
            $ref: '#/definitions/ClientProgressTracking'
        required: true
    post:
      summary: "send a zone status update"
      description: "update the zone with erros / warnings from our clients API"
      tags:
        - Zones
      responses:
        '200':
          description: zone status updated
        '401':
          description: unauthorized
  '/zones/{zoneId}/racks/{rackId}':
    parameters:
      - name: zoneId
        in: path
        description: zone ID or zone Name
        type: string
        required: true
      - name: rackId
        in: path
        description: rack ID or rack Name
        type: string
        required: true
    get:
      summary: return rack matching the given param (rack ID or rack Name)
      description: return rack matching the given param (rack ID or rack Name)
      tags:
        - Racks
      responses:
        '200':
          description: rack
          schema:
            $ref: '#/definitions/Rack'
        '401':
          description: unauthorized
        '404':
          description: Not Found
  '/zones/{zoneId}/devices':
    parameters:
      - name: zoneId
        in: path
        description: zone ID
        type: string
        required: true
    get:
      summary: "return list of zone's devices"
      description: "return list of zone's devices"
      parameters:
        - name: rack
          in: query
          description: is filter by given rack required
          type: string
        - name: type
          in: query
          description: Device (node) that its hypervisor type is KVM. This type of node includes KVM instances only.
          required: true
          type: string
      tags:
        - Devices
      responses:
        '200':
          description: An array of devices
          schema:
            type: array
            items:
              $ref: '#/definitions/Device'
        '401':
          description: unauthorized
  '/zones/{zoneId}/devices/{param}':
    parameters:
      - name: zoneId
        in: path
        description: zone ID or zone Name
        type: string
        required: true
      - name: param
        in: path
        description: device ID or device AIC Standard Name
        type: string
        required: true
    get:
      summary: return device matching the given param (device ID or device AIC Standard Name)
      description: return device matching the given param (device ID or device AIC Standard Name)
      tags:
        - Devices
      responses:
        '200':
          description: device
          schema:
            $ref: '#/definitions/Device'
        '401':
          description: unauthorized
        '404':
          description: Not Found
  '/zones/{id}/controlNodes':
    get:
      summary: List of VMs on the control Nodes in the zone
      description: |
        The controlNodes endpoint returns information about the 4 VMs used as LCP nodes in the requested zone.
      parameters:
        - name: id
          in: path
          description: zone ID or zone Name
          required: true
          type: number
          format: int
      tags:
        - VMs
        - Bootstrap
      responses:
        200:
          description: An array of instances (LCP VMs)
          schema:
            type: array
            items:
              $ref: '#/definitions/Device'
        '401':
          description: unauthorized
        '404':
          description: Not Found
  '/zones/{id}/devices?type=kvm':
    get:
      summary: List of all VMs on the bootstrap nodes in the zone
      description: |
         The BootstrapVMs endpoint returns information about all VMs on the bootstrap node in the requested zone.
      parameters:
        - name: id
          in: path
          description: zone ID or zone Name
          required: true
          type: number
          format: int
      tags:
        - VMs
        - Devices
      responses:
        200:
          description: An array of instances (VMs on bootstrap node)
          schema:
            type: array
            items:
              $ref: '#/definitions/Device'
        '401':
          description: unauthorized
        '404':
          description: Not Found
  '/zones/{zoneId}/virtualConnections':
    parameters:
      - name: zoneId
        in: path
        description: zone ID or zone Name
        type: string
        required: true
    get:
      summary: "return list of zone's virtual connections"
      description: "return list of zone's virtual connections"
      tags:
       - VirtualConnections
      responses:
        '200':
          description: An array of virtual connections
          schema:
            type: array
            items:
              $ref: '#/definitions/VirtualConnection'
        '401':
          description: unauthorized
  '/zones/{zoneId}/virtualConnections/{connectionId}':
    parameters:
      - name: zoneId
        in: path
        description: zone ID or zone Name
        type: string
        required: true
      - name: connectionId
        in: path
        description: virtual connection ID
        type: string
        required: true
    get:
      summary: return virtual connection matching the given ID
      description: return virtual connection matching the given ID
      tags:
        - VirtualConnections
      responses:
        '200':
          description: virtual connections
          schema:
            $ref: '#/definitions/VirtualConnection'
        '401':
          description: unauthorized
        '404':
          description: Not Found
  '/zones/{zoneId}/cables':
    parameters:
      - name: zoneId
        in: path
        description: zone ID or zone Name
        type: string
        required: true
    get:
      parameters:
        - name: rack
          in: query
          description: is filter by given rack required
          type: string
      summary: "return list of zone's cables"
      description: "return list of zone's cables"
      tags:
        - Cables
      responses:
        '200':
          description: An array of cables
          schema:
            type: array
            items:
              $ref: '#/definitions/Cable'
        '401':
          description: unauthorized
  '/zones/{zoneId}/cables/{cableId}':
    parameters:
      - name: zoneId
        in: path
        description: zone ID or zone Name
        type: string
        required: true
      - name: cableId
        in: path
        description: cable ID
        type: string
        required: true
    get:
      summary: return cable matching the given ID
      description: return cable matching the given ID
      tags:
        - Cables
      responses:
        '200':
          description: cables
          schema:
            $ref: '#/definitions/Cable'
        '401':
          description: unauthorized
        '404':
          description: Not Found
  '/zones/{zoneId}/devices/{deviceId}/vlans':
    parameters:
      - name: zoneId
        in: path
        description: zone ID or zone Name
        type: string
        required: true
      - name: deviceId
        in: path
        description: device ID or device AIC Standard Name
        type: string
        required: true
    get:
      summary: "return list of device's vlans"
      description: "return list of device's vlans"
      tags:
        - Vlans
      responses:
        '200':
          description: An array of vlans
          schema:
            type: array
            items:
              $ref: '#/definitions/VLan'
        '401':
          description: unauthorized
  '/zones/{zoneId}/vms/{vmId}/vlans':
    parameters:
      - name: zoneId
        in: path
        description: zone ID or zone Name
        type: string
        required: true
      - name: vmId
        in: path
        description: device ID or device AIC Standard Name
        type: string
        required: true
    get:
      summary: "return list of vm's vlans"
      description: "return list of vm's vlans"
      tags:
        - Vlans
      responses:
        '200':
          description: An array of vlans
          schema:
            type: array
            items:
              $ref: '#/definitions/VLan'
        '401':
          description: unauthorized
  '/locationTypes':
    get:
      summary: return list of values matching the given meta data list
      description: return list of values matching the given meta data list
      tags:
        - Metadata
      responses:
        '200':
          description: Meta data
          schema:
            $ref: '#/definitions/Metadata'
        '401':
          description: unauthorized
  '/designTypes':
    get:
      summary: return list of values matching the given meta data list
      description: return list of values matching the given meta data list
      tags:
        - Metadata
      responses:
        '200':
          description: Meta data
          schema:
            $ref: '#/definitions/Metadata'
        '401':
          description: unauthorized
  '/powerTypes':
    get:
      summary: return list of values matching the given meta data list
      description: return list of values matching the given meta data list
      tags:
        - Metadata
      responses:
        '200':
          description: Meta data
          schema:
            $ref: '#/definitions/Metadata'
        '401':
          description: unauthorized
  '/mediaTypes':
    get:
      summary: return list of values matching the given meta data list
      description: return list of values matching the given meta data list
      tags:
        - Metadata
      responses:
        '200':
          description: Meta data
          schema:
            $ref: '#/definitions/Metadata'
        '401':
          description: unauthorized
  '/zones/{id}/luns':
    get:
      summary: Storage assignments report, list of LUNs.
      description: |
        The Storage endpoint returns list of storage info that are LUNs.
      parameters:
        - name: id
          in: path
          description: zone ID or zone Name
          required: true
          type: number
          format: int
      tags:
        - LUNs
      responses:
        200:
          description: An array of LUNs.
          schema:
            type: array
            items:
              $ref: '#/definitions/Lun'
        401:
          description: unauthorized
    post:
      summary: Stores storage info in database.
      description: |
        The Storage endpoint stores storage info in database.
      parameters:
        - name: id
          in: path
          description: zone ID or zone Name
          required: true
          type: number
          format: int64
        - name: Luns
          in: body
          description: List of Lun
          required: true
          schema:
            $ref: '#/definitions/Lun'
      tags:
        - LUNs
      responses:
        '201':
          description: LUN data added.
        '401':
          description: unauthorized
        '404':
          description: Could be Invalid data format %s /  Invalid Lun id  [%s] /  Invalid Lun size  [%s]
  '/zones/{id}/lunsVmMapping':
    get:
      summary: Get vm lun mapping.
      description: |
        Should be called after storage team has entered the LUN info using REST and after the designer maps LUN Data for every VM.
      parameters:
        - name: id
          in: path
          description: zone ID or zone Name
          required: true
          type: number
          format: int
      tags:
        - LUNs
        - VMs
      responses:
        '200':
          description: returns list of LunVmMapping in body.
          schema:
            type: array
            items:
              $ref: '#/definitions/LunVmMapping'
        '401':
          description: unauthorized
        '404':
          description: Could be Invalid data format %s /  Invalid Zone [%s] / Lun Mapping not ready yet
  '/zones/{id}/VLanUsages':
    post:
      summary: Updates list of vlans with the ip used per devices & per VM.
      description: |
        Used by OpSimple to assign IpV4 & IpV6 for Devices / VMs.
      parameters:
      - name: id
        in: path
        description: zone ID or zone Name
        type: number
        format: int64
        required: true
      - name: VlanUsage
        in: body
        description: List of VlanUsage
        required: true
        schema:
          type: array
          items:
          $ref: '#/definitions/VlanUsage'
      tags:
        - Vlans
      responses:
        '200':
          description: update finished OK.
        '401':
          description: unauthorized
        '404':
          description: Could be Invalid data format %s /  Invalid Zone [%s] /  Invalid vlan [%s] / Invalid deviceId [%s] / Invalid VmId [%s]   
  '/zones/{id}/LcpUsages':
    post:
      summary: Updates mapping of devices to LCP types.
      description: |
        Used by OpSimple to switch devices between LCP tyeps.
      parameters:
      - name: id
        in: path
        description: zone ID or zone Name
        type: number
        format: int
        required: true
      - name: LcpUsage
        in: body
        description: List of LcpUsage
        required: true
        schema:
          $ref: '#/definitions/LcpUsage'
      tags:
        - LCPs
      responses:
        '200':
          description: update finished OK.
        '401':
          description: unauthorized
        '404':
          description: Could be Invalid data format %s /  Invalid Zone [%s] / Invalid device [%s]
definitions:
  LcpUsage:
    type: object
    properties:
        lcpADevices:
          type: array
          items:
            type: integer
            format: int64
        lcpBDevices:
          type: array
          items:
            type: integer
            format: int64
    required: 
      [
        lcpADevices,
        lcpBDevices
      ]
    example:
      lcpADevices:
        [1,2,3]
      lcpBDevices:
        [4,5,6]
  IpUsage:
    type: object
    properties:
        hostId:
          description: "AIC Formation Device ID / VM ID as recieved from the AIC API"
          type: integer
          format: int64
        ipV4:
          type: array
          items:
            type: string
        ipV6:
          type: array
          items:
            type: string
    required: 
      [
        hostId,
        ipV4
      ]
    example:
      hostId: 1
      ipV4:
        ["1.1.1.1", "1.1.1.3"]
      ipV6:
        ["1.1.1.2", "1.1.1.4"]
  VlanUsage:
    type: object
    properties:
        vlanId:
          type: string
          description: "vlan ID could be 1319 / 1318 / 1300... "
        vmUsage:
          type: array
          items: 
            $ref: '#/definitions/IpUsage'
        deviceUsage:
          type: array
          items: 
            $ref: '#/definitions/IpUsage'
    required: 
      [
        vlanId,
        vmUsage,
        deviceUsage
      ]
    example:
      vmUsage:
        []
      deviceUsage:
        []
  Site:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: site ID
      name:
        type: string
        description: Site name
      created:
        $ref: '#/definitions/Date'
      updated:
        $ref: '#/definitions/Date'
      lastUpdateBy:
        type: string
        description: last updating user
      sitecol:
        type: string
      clli:
        type: string
      country:
        type: string
      state:
        type: string
      city:
        type: string
      region:
        type: string
      addressLine1:
        type: string
      addressLine2:
        type: string
      zipCode:
        type: integer
        format: int32
      comments:
        type: string
      locType:
        type: string
      locationId:
        type: string
      locationAliasEquipment:
        type: string
      locationAliasNetwork:
        type: string
      serviceArea:
        type: string
      siteContact:
        type: string
      siteEmail:
        type: string
      siteTel:
        type: string
    required: 
      [
        id,
        name,
        created,
        updated,
        lastUpdateBy,
        clli,
        country,
        state,
        city,
        addressLine1,
        zipCode,
        locType,
        locationId,
        locationAliasEquipment,
        locationAliasNetwork
      ]
    example:
      id: 1
      name: "AAA"
      created: "2016-06-30 06:21:41"
      updated: "2016-06-30 06:21:41"
      lastUpdateBy: "admin"
      sitecol: null
      clli: "12345678"
      country: "USA"
      state: "Alaska"
      city: "Anchorage"
      region: "North America"
      addressLine1: "12345"
      addressLine2: null
      zipCode: "12345"
      comments: null
      locType: "NTC"
      locationId: "12345"
      locationAliasEquipment: "12345"
      locationAliasNetwork: "12345"
      serviceArea: null
      siteContact: null
      siteEmail: null
      siteTel: null
  Zone:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: zone ID
      name:
        type: string
      created:
        $ref: '#/definitions/Date'
      updated:
        $ref: '#/definitions/Date'
      lastLunVmMapping:
        $ref: '#/definitions/Date'
      locked_by:
        type: string
      lastUpdateBy:
        type: string
      primaryDcp:
        type: string
      secondaryDcp:
        type: string
      avialableKwPerRack:
        type: string
      distributedControlPlane:
        type: string
      numberOfComputeRack:
        type: integer
        format: int32
      useableRackUnits:
        type: integer
        format: int32
      zoneState:
        type: string
      zoneType:
        $ref: '#/definitions/Metadata'
      designType:
        $ref: '#/definitions/Metadata'
      powerType:
        $ref: '#/definitions/Metadata'
      zonePurpose:
        $ref: '#/definitions/Metadata'
      siteIds:
        items:
          type: string
    required: 
      [
        id,
        name,
        created,
        updated,
        lastUpdateBy,
        primaryDcp,
        secondaryDcp,
        avialableKwPerRack,
        distributedControlPlane,
        useableRackUnits,
        zoneState,
        zoneType,
        designType,
        powerType,
        zonePurpose
      ]
    example:
      id: 1
      name: "AAA1"
      created: "2016-06-30 06:21:56"
      updated: "2016-06-30 04:12:13"
      lastLunVmMapping: "2016-06-30 04:12:13"
      locked_by: ""
      lastUpdateBy: "admin"
      primaryDcp: "N/A"
      secondaryDcp: "N/A"
      avialableKwPerRack: "5"
      distributedControlPlane: true
      useableRackUnits": "42"
      zoneState: "DESIGN_SUBMITED"
      zoneType:
        id: 1
        name: "new site"
      designType:
        id: 4
        name: "Medium Lite"
      powerType:
        id: 2,
        name: "AC"
      zonePurpose:
        id: 1,
        name: "Production"
      numberOfComputeRack: 1
  Rack:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: zone ID
      created:
        $ref: '#/definitions/Date'
      updated:
        $ref: '#/definitions/Date'
      lastUpdateBy:
        type: string
      location:
        type: string
      row:
        type: string
      name:
        type: string
      rackHight:
        type: integer
        format: int32
      extraCosts:
        type: string
      rackType:
        type: object
        properties:
          id:
            type: integer
            format: int32
          name:
            type: string
          alias: 
            type: string
      vendorModel:
        $ref: '#/definitions/VendorModel'
    required: 
      [
        id,
        created,
        updated,
        lastUpdateBy,
        location,
        name,
        rackHight,
        rackType,
        vendorModel
      ]
    example:
      id: 31
      created: "2016-06-30 06:21:56"
      updated: "2016-06-30 06:22:06"
      lastUpdateBy: "admin"
      location: "1"
      row: null
      name: "AAA1R01"
      rackHight: 42
      extraCosts: "0.0"
      rackType:
        id: 1
        name: "access"
        alias: "a"
      vendorModel:
        id: 42
        model": "32W X 42U X 42D - SEISMIC - NO CASTERS - SENSORS - 2 X 3PHASE 60A RARITAN PDU - 24 X C13 and 12 X C19 - IEC 60309 DELTA (3P4W) PLUGS"
        vendor": "GAW"
        configuration: null
        bootDrives: null
        bootRaid": false
        dataDrives": null
        dataRaid": false
        dataCapacity": null
        hotSpares": null
        totalDrives": null
        cpus": null
        ram": null
        pcieSlots": null
        mgtPorts": null
        dataNics": null
        dataUplinkPorts": null
  Device:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: zone ID
      created:
        $ref: '#/definitions/Date'
      lastUpdated:
        $ref: '#/definitions/Date'
      lastUpdateBy:
        type: string
      rackName:
        type: string
      vpmo:
        type: string
      function:
        type: string
      aicStandardName:
        type: string
      nvpName:
        type: string
      ptniiName:
        type: string
      numberOfUnits:
        type: integer
        format: int32
      price:
        type: integer
        format: int32
      startUnit:
        type: integer
        format: int32
      vendorModel:
        $ref: '#/definitions/VendorModel'
      serial:
        type: string
      assetTag:
        type: string
      impiMac:
        type: string
      mgtMac:
        type: string
      purchaseOrder:
        type: string
      affiliateOwner:
        type: string
      equipmentPurpose:
        type: string
      bootstrap:
        type: boolean
      hypervisorOsType:
        type: string
      initiatorName:
        type: string
      lcpType:
        type: string
      virtualSubDevices:
        type: array
        items:
            $ref: '#/definitions/virtualSubDevice'
    required:
      [
        id,
        created,
        lastUpdated,
        lastUpdateBy,
        rackName,
        function,
        startUnit,
        vendorModel,
        bootstrap,
        vpmo
      ]
    example:
      id: 765
      created: "2016-06-30 06:21:56"
      lastUpdated: "2016-06-30 06:21:56"
      lastUpdateBy: "admin"
      aicStandardName: "AAA1R01C004"
      rackName: "AAA1R01"
      function: "ld server"
      nvpName: "12345rsv103"
      ptniiName: "12345sd9103"
      numberOfUnits: 2
      price: 0
      startUnit: 8
      vendorModel:
        id: 179
        model: "AIC MED 3.0 AC -  28 CORE XDP - 256GB RAM - 2 X 120GB SSD"
        vendor: "HP"
        configuration: "HP DL380G9 - AIC MED 3.0 AC -  24 CORE XDP - 256GB RAM - 2 X 120GB SSD - 4 X 1GB NIC (LOM) - 6 X 10GB (INTEL) - 6 SFP+ TRANSCEIVERS - 4HR "
        bootDrives: null
        bootRaid: false
        dataDrives: null
        dataRaid: false
        dataCapacity: null
        hotSpares": null
        totalDrives": null
        cpus": null
        ram": null
        pcieSlots": null
        mgtPorts": null
        dataNics": null
        dataUplinkPorts": null
      serial: null
      assetTag: null
      ipmiMac: null
      mgtMac: null
      purchaseOrder: null
      affiliateOwner: null
      equipmentPurpose: null
      bootstrap: false
      hypervisorOsType: null
      initiatorName: null
      vpmo: "12345"
      lcpType: null
      role: null
      virtualSubDevices: null
  virtualSubDevice:
    type: object
    properties:
      id:
        type: integer
      nvpName:
        type: string
      ptniiName:
        type: string
      installationStatus:
        type: string
      deploymentPhase:
        type: string
      hypervisorType:
        type: string
      cpu:
        type: integer
      memory:
        type: integer
      diskOs:
        type: integer
      diskApp:
        type: integer
      storageMode:
        type: string
      os:
        type: string
      applications:
         type: array
         items:
            $ref: '#/definitions/Application'
    required: 
      [
        id
      ]
    example:
      id: 45
      nvpName: "12345rsv123-vsx0"
      ptniiName: null
      installationStatus: null
      deploymentPhase: null
      hypervisorType: null
      cpu: null
      memory: null
      diskOs: null
      diskApp: null
      storageMode: null
      os: null
      applications: null
  Application:
    type: object
    properties:
       applicationName:
        type: string
       applicationVersion:
        type: string
  VirtualConnection:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: zone ID
      created:
        $ref: '#/definitions/Date'
      updated:
        $ref: '#/definitions/Date'
      lastUpdateBy:
        type: string
      from:
        type: object
        properties:
          device:
            $ref: '#/definitions/BasicDevice'
          subDevice:
            $ref: '#/definitions/SubDevice'
          virtualDevice:
            type: object
            properties:
              id:
                type: integer
                format: int32
              nvpName:
                type: string
          virtualSubDevice:
            type: object
            properties:
              id:
                type: integer
                format: int32
              nvpName:
                type: string
              ptniiName:
                type: string
          purpose:
            type: string
          LAGGrouping:
            type: string
          virtualPort:
            type: string
      to:
        type: object
        properties:
          device:
            $ref: '#/definitions/BasicDevice'
          subDevice:
            $ref: '#/definitions/SubDevice'
          virtualDevice:
            type: object
            properties:
              id:
                type: integer
                format: int32
              nvpName:
                type: string
          virtualSubDevice:
            type: object
            properties:
              id:
                type: integer
                format: int32
              nvpName:
                type: string
              ptniiName:
                type: string
          purpose:
            type: string
          LAGGrouping:
            type: string
          virtualPort:
            type: string
      configPhase:
        type: string
      toZone:
        type: string
      circuitId:
        type: string
      lgxfic:
        type: string
      lgxPanelJack:
        type: string
      configStatus:
        type: string
      logicalCktId:
        type: string
    example:
      id: 25
      created: "2016-06-30 06:22:29"
      updated: "2016-06-30 06:22:29"
      lastUpdateBy: "admin"
      from:
        purpose": "Local Mgmt Access"
        virtualSubDevice: null
        virtualDevice: null
        subDevice: null
        device:
          id: 787
          created: "2016-07-04 06:31:27"
          lastUpdated: "2016-07-04 06:31:27"
          lastUpdateBy: null
          aicStandardName: "12345678GSN3AAA1QS03"
          rackName: null
          function: null
          nvpName: "1234500001ilx"
          ptniiName: null
          numberOfUnits: 0
          price: 0
          startUnit: 29
          vendorModel:
            id: 56
            model: "Catalyst 2960X"
            vendor: "Cisco"
            configuration: null
            bootDrives: null
            bootRaid: false
            dataDrives: null
            dataRaid: false
            dataCapacity: null
            hotSpares: null
            totalDrives: null
            cpus: null
            ram: null
            pcieSlots: null
            mgtPorts: null
            dataNics: null
            dataUplinkPorts: null
          serial: null
          assetTag: null
          ipmiMac: null
          mgtMac: null
          purchaseOrder: null
          affiliateOwner: null
          equipmentPurpose: null
          bootstrap: false
          hypervisorOsType: null
          initiatorName: null
          vpmo: null
          lcpType: null
          role: null
          virtualSubDevices: null
        virtualPort: "Vlan22"
        laggrouping: ""
      to: null
      configPhase: "base"
      toZone: null
      circuitId: ""
      lgxfic: ""
      lgxPanelJack: ""
      configStatus: "Installed"
      logicalCktId: ""
    required:
      [
        id,
        created,
        updated,
        lastUpdateBy,
        from,
        configPhase,
        configStatus
      ]
  BasicDevice:
    type: object
    properties:
      id:
        type: integer
        format: int64
        description: device ID
      nvpName:
        type: string
      ptniiName:
        type: string
      vendorModel:
        $ref: '#/definitions/VendorModel'
      startUnit:
        type: integer
        format: int32
      AICStandardName:
        type: string
    example:
      id: 766
      nvpName: "12345sta100"
      ptniiName: null
      vendorModel: 
        id: 75
        model: "HP MSA 2040 Storage Controller 24 drive"
        vendor: "HP"
        configuration: "8/16Gb Fibre Channel (FC) storage array, dual controllers, four host ports per controller, four 1GbE/10GbE iSCSI ports, 6GB (4GB Data Read/Write, 2 GB Metadata/System OS) cache memory"
        bootDrives: null
        bootRaid: false
        dataDrives: null
        dataRaid: false
        dataCapacity: null
        hotSpares: null
        totalDrives: null
        cpus: null
        ram: null
        pcieSlots: null
        mgtPorts": null
        dataNics": null
        dataUplinkPorts: null
      startUnit: 2,
      aicstandardName: "AAA1R01S007"
    required:
      [
        id,
        startUnit
      ]
  CableEdge:
    type: object
    properties:
      device:
        $ref: '#/definitions/BasicDevice'
      subDevice:
        $ref: '#/definitions/BasicDevice'
      row:
        type: string
      rackLocation:
        type: string
      rackUnit:
        type: integer
        format: int32
      LAGGrouping:
        type: string
      purpose:
        type: string
    example:
      rackLocation: "1"
      rackUnit: "AAA1R01"
      purpose: "ISCI"
      row: ""
      subDevice: null
      device: 
        id: 766
        nvpName: "12345sta100"
        ptniiName: null
        vendorModel: 
          id: 75
          model: "HP MSA 2040 Storage Controller 24 drive"
          vendor: "HP"
          configuration: "8/16Gb Fibre Channel (FC) storage array, dual controllers, four host ports per controller, four 1GbE/10GbE iSCSI ports, 6GB (4GB Data Read/Write, 2 GB Metadata/System OS) cache memory"
          bootDrives: null
          bootRaid: false
          dataDrives: null
          dataRaid: false
          dataCapacity: null
          hotSpares: null
          totalDrives: null
          cpus: null
          ram: null
          pcieSlots: null
          mgtPorts": null
          dataNics": null
          dataUplinkPorts: null
        startUnit: 2,
        aicstandardName: "AAA1R01S007"
    required:
      [
        rackLocation,
        rackUnit,
        purpose
      ]
  Cable:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: zone ID
      created:
        $ref: '#/definitions/Date'
      lastUpdated:
        $ref: '#/definitions/Date'
      lastUpdateBy:
        type: string
      from:
        $ref: '#/definitions/CableEdge'
      to:
        $ref: '#/definitions/CableEdge'
      toZone:
        type: string
      capacity:
        type: string
      configPhase:
        type: string
      circuitId:
        type: string
      lgxFic:
        type: string
      lgxPanelJack:
        type: string
      status:
        type: string
      logicalCktId:
        type: string
      mediaType:
        type: string
      vendorModel:
        $ref: '#/definitions/VendorModel'
      vpmo: 
        type: string
    required:
      [
        id,
        created,
        lastUpdated,
        lastUpdateBy,
        from,
        capacity,
        status,
        mediaType,
        vendorModel,
        vpmo
      ]
    example:
      id: 1
      created: "2016-06-30 06:22:29"
      lastUpdated: "2016-06-30 06:22:29"
      lastUpdateBy: "admin"
      from: 
        rackLocation: "1"
        rackUnit: "AAA1R01"
        purpose: "ISCI"
        row: ""
        subDevice: null
        device: 
          id: 766
          nvpName: "12345sta100"
          ptniiName: null
          vendorModel: 
            id: 75
            model: "HP MSA 2040 Storage Controller 24 drive"
            vendor: "HP"
            configuration: "8/16Gb Fibre Channel (FC) storage array, dual controllers, four host ports per controller, four 1GbE/10GbE iSCSI ports, 6GB (4GB Data Read/Write, 2 GB Metadata/System OS) cache memory"
            bootDrives: null
            bootRaid: false
            dataDrives: null
            dataRaid: false
            dataCapacity: null
            hotSpares: null
            totalDrives: null
            cpus: null
            ram: null
            pcieSlots: null
            mgtPorts": null
            dataNics": null
            dataUplinkPorts: null
          startUnit: 2,
          aicstandardName: "AAA1R01S007"
        port: "1"
        laggrouping: ""
      to:
        rackLocation": "1"
        rackUnit: "AAA1R01"
        purpose: ""
        row: ""
        subDevice: null
        device: 
          id: 773
          nvpName: "12345vlls01"
          ptniiName: null
          vendorModel:
            id: 102
            model: "Cisco Network Convergence Systems (NCS) 5501 Router"
            vendor: "Cisco"
            configuration: "40 10GbE ports plus 4 100GbE ports, Embedded USB (eUSB) storage (32 GB)"
            bootDrives: null
            bootRaid: false
            dataDrives: null
            dataRaid: false
            dataCapacity: null
            hotSpares: null
            totalDrives: null
            cpus: null
            ram: null
            pcieSlots: null
            mgtPorts: null
            dataNics: null
            dataUplinkPorts: null
          startUnit: 20
          aicstandardName: "12345678GSCAAA1QS01"
        port: "37"
        laggrouping: ""
      toZone: "AAA1"
      capacity: "10"
      configPhase: null
      circuitId: null
      lgxFic: null
      lgxPanelJack: null
      status: "Configuration"
      logicalCktId: null
      mediaType: "MM-Fiber"
      vendorModel: 
          id: 77
          model: "MM-Fiber-10G Cable (LC)"
          vendor: "Acme Cable"
          configuration: ""
          bootDrives: null
          bootRaid: false
          dataDrives: null
          dataRaid: false
          dataCapacity: null
          hotSpares: null
          totalDrives: null
          cpus: null
          ram: null
          pcieSlots: null
          mgtPorts: null
          dataNics: null
          dataUplinkPorts: null
      vpmo: "12345"
  VLan:
    type: object
    properties:
      id:
        type: integer
        format: int64
        description: vendor model ID
      vlanId:
        type: string
      created:
        $ref: '#/definitions/Date'
      lastUpdated:
        $ref: '#/definitions/Date'
      lastUpdateBy:
        type: string
      name:
        type: string
      ipv4:
        type: array
        items:
          $ref: '#/definitions/Network'
      ipv6:
        type: array
        items:
          $ref: '#/definitions/Network'
      ipv4Gateway:
        type: array
        items:
          type: string
      ipv6Gateway:
        type: array
        items:
          type: string
    required:
      [
        id,
        vlanId,
        created,
        lastUpdated,
        lastUpdateBy,
        name,
        ipv4,
        ipv4Gateway
      ]
    example:
      id: 68,
      vlanId: "1300"
      created: "2016-07-04 11:45:28"
      lastUpdated: "2016-07-04 11:45:28"
      lastUpdateBy: null
      name: "Public OAM"
      ipv4:
        name": "Public OAM1"
        ip": "1.1.1.8"
      ipv6:
      ipv4Gateway:
        "1.1.1.2"
      ipv6Gateway:
  Network:
    type: object
    properties:
      ip:
        type: string
      name:
        type: string
    example:
      name: "OOB Access1"
      ip: "1.1.1.8"
    required:
      [
        name,
        ip
      ]
  SubDevice:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: vendor model ID
      nvpName:
        type: string
      ptniiName:
        type: string
      vendorModel:
        $ref: '#/definitions/VendorModel'
  VendorModel:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: vendor model ID
      model:
        type: string
      vendor:
        type: string
      configuration:
        type: string
      bootDrives:
        type: string
      bootRaid:
        type: string
      dataDrives:
        type: string
      dataRaid:
        type: string
      dataCapacity:
        type: string
      hotSpares:
        type: string
      totalDrives:
        type: string
      cpus:
        type: string
      ram:
        type: string
      pcieSlots:
        type: string
      mgtPorts:
        type: string
      dataNics:
        type: string
      dataUplinkPorts: 
        type: string
    example:
      id: 75
      model: "HP MSA 2040 Storage Controller 24 drive"
      vendor: "HP"
      configuration: "8/16Gb Fibre Channel (FC) storage array, dual controllers, four host ports per controller, four 1GbE/10GbE iSCSI ports, 6GB (4GB Data Read/Write, 2 GB Metadata/System OS) cache memory"
      bootDrives: null
      bootRaid: false
      dataDrives: null
      dataRaid: false
      dataCapacity: null
      hotSpares: null
      totalDrives: null
      cpus: null
      ram: null
      pcieSlots: null
      mgtPorts": null
      dataNics": null
      dataUplinkPorts: null
    required:
      [
        id,
        model,
        vendor,
        configuration
      ]
  Lun:
    type: object
    properties:
      volume:
        type: string
        description: Display the Volume of a LUN for exaple.
        example: "01a"
      lcpType:
        type: string
        description: LCP can be 'lcp_a' / 'lcp_b'.
        example: "lcp_a"
      wwid:
        type: string
        description: Display the WWID value of a LUN.
        example: "360a98000"
      lunType:
        type: string
        description: lun type, can be 'Host' / 'Data'.
        example: "Host"
      id:
        type: integer
        description: lun id.
      size:
        type: string
        description: Display the Size of a LUN, devided by 8 without any remainder.
      arraySerialNumber:
        type: string
        description: LUN serial number.
  LunVmMapping:
    type: object
    properties:
      lun:
        $ref: '#/definitions/Lun'
      vmServerHostname:
        type: string
        description: AIC formation hostname for the Device containing the VM.
      vmHostname:
        type: string
        description: AIC formation hostname of the VM.
  Metadata:
    type: object
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
    example:
      id: 3,
      name: "DC"
    required:
      [
        id,
        name
      ]
  NetworkRange:
    type: object
    properties:
      subnetRange:
        type: string
      gwIpv4Address1:
        type: string
      gwIpv4Address2:
        type: string
      openstackDeviceIpv4Start:
        type: string
      openstackDeviceIpv4End:
        type: string
      openstackVmIpv4Start:
        type: string
      openstackVmIpv4End:
        type: string
  Date:
    type: object
    properties:
      date:
        type: string
        format: date
        description: Displaying central time zone
  ClientProgressTracking:
    type: object
    properties:
        client:
          type: string
          description: OpsSimple / Canopi
        severity:
          type: string
          description: Error / Warning / Info
        description:
          type: string
          description: A short description of the new Zone Status the client has
securityDefinitions:
  basicAuth:
    type: basic
    description: HTTP Basic Authentication. Works over `HTTP` and `HTTPS`
security:
  - basicAuth: []
saharj commented 8 years ago

This issue was moved to swagger-api/swagger-codegen#3315