open_cli_schema_version: 1.0
name: tenant-list
description: Lists the tenants under given cloud region in Onap

info:
  product: onap-amsterdam
  service: aai
  author: ONAP CLI Team onap-discuss@lists.onap.org

parameters:
  - name: cloud
    description: Onap cloud
    type: string
    short_option: x
    long_option: cloud
    is_optional: false
  - name: region
    description: Onap cloud region
    type: string
    short_option: y
    long_option: region
    is_optional: false

results:
  direction: landscape
  attributes:
    - name: tenant-id
      description: Onap tenant-id
      scope: short
      type: string
    - name: tenant-name
      description: Onap tenant name
      scope: short
      type: string
    - name: resource-version
      description: Onap tenant resource version
      scope: short
      type: string
http:
  service:
    auth: basic
    mode: direct
  request:
    uri: /aai/v11/cloud-infrastructure/cloud-regions/cloud-region/${cloud}/${region}/tenants
    method: GET
  success_codes:
    - 200
  result_map:
    tenant-id: $b{$.tenant.[*].tenant-id}
    tenant-name: $b{$.tenant.[*].tenant-name}
    resource-version: $b{$.tenant.[*].resource-version}
  sample_response:
    body: '{"tenant":[{"tenant-id":"26ab7af6-96cc-4c4e-814a-e533af4ef9f6","tenant-name":"test","resource-version":"1504091074807","relationship-list":{"relationship":[{"related-to":"service-subscription","related-link":"/aai/v11/business/customers/customer/customer-2/service-subscriptions/service-subscription/vTest","relationship-data":[{"relationship-key":"customer.global-customer-id","relationship-value":"customer-2"},{"relationship-key":"service-subscription.service-type","relationship-value":"vTest"}]}]}}]}'