aboutsummaryrefslogtreecommitdiffstats
path: root/.readthedocs.yaml
AgeCommit message (Expand)AuthorFilesLines
2020-02-10Migrate oom docsJessica Wagantall1-0/+20
' href='#n35'>35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
open_cli_schema_version: 1.0
name: sdnc-create
description: Register SDNC into Onap
info:
  product: open-cli
  service: test
  type: cmd
  author: Kanagaraj Manickam mkr1481@gmail.com

parameters:
  - name: name
    description: Onap SDNC name
    scope: short
    type: string
    short_option: n
    long_option: name
    is_optional: false
  - name: vendor
    description: Onap SDNC vendor
    scope: short
    type: string
    short_option: e
    long_option: vendor
    is_optional: false
  - name: type
    description: Onap SDNC type
    scope: short
    type: string
    short_option: y
    long_option: type
    is_optional: false
  - name: sdnc-version
    description: Onap SDNC version
    scope: short
    type: string
    short_option: r
    long_option: sdnc-version
    is_optional: false
  - name: url
    description: Onap SDNC base url
    scope: short
    type: url
    short_option: l
    long_option: url
    is_optional: false
  - name: description
    description: Onap SDNC description
    scope: short
    type: string
    short_option: i
    long_option: description
    is_optional: false
  - name: username
    description: Onap SDNC username
    scope: short
    type: string
    short_option: g
    long_option: username
    is_optional: false
  - name: password
    description: Onap SDNC password
    scope: short
    type: string
    is_secured: true
    short_option: j
    long_option: password
    is_optional: false
  - name: product-name
    description: Onap SDNC product-name
    scope: short
    type: string
    short_option: o
    long_option: product-name
    is_optional: false
  - name: protocol
    description: Onap SDNC protocol
    scope: short
    type: string
    short_option: k
    long_option: protocol
    is_optional: false
results:
  direction: portrait
  attributes:
    - name: id
      description: Onap SDNC ID
      scope: short
      type: string
    - name: name
      description: Onap SDNC name
      scope: short
      type: string
    - name: vendor
      description: Onap SDNC vendor
      scope: short
      type: string
    - name: type
      description: Onap SDNC type
      scope: short
      type: string
    - name: version
      description: Onap SDNC version
      scope: short
      type: string
    - name: url
      description: Onap SDNC base url
      scope: short
      type: url
    - name: description
      description: Onap SDNC description
      scope: short
      type: string
    - name: username
      description: Onap SDNC username
      scope: short
      type: string
    - name: password
      description: Onap SDNC password
      scope: short
      type: string
      is_secured: true
    - name: product-name
      description: Onap SDNC product name
      scope: short
      type: string
    - name: protocol
      description: Onap SDNC protocol
      scope: short
      type: string
    - name: create-time
      description: Onap SDNC create-time
      scope: long
      type: string
http:
  request:
    headers:
      createOrUpdate: ${create-or-update1}
    body: {"name":"${name}","vendor":"${vendor}","version":"${sdnc-version}","description":"${description}","type":"${type}","url":"${url}","userName":"${username}","password":"${password}","productName":"${product-name}","protocol":"${protocol}"}
  success_codes:
    - 201
    - 200
  result_map:
    id: $b{$.sdnControllerId}
    name: $b{$.name}
    vendor: $b{$.vendor}
    type: $b{$.type}
    version: $b{$.version}
    url: $b{$.url}
    description: $b{$.description}
    username: $b{$.userName}
    password: $b{$.password}
    protocol: $b{$.protocol}
    product-name: $b{$.productName}
    create-time: $b{$.createTime}
  sample_response:
    body: '{"id":"string","name":"string","vendor":"string","version":"string","description":"string","type":"string","createTime":"string","url":"string","userName":"string","password":"string","productName":"string","protocol":"string"}'