plugins/msb/src/main/resources/onap-cli-schema/microservice-create-schema.yaml

   1 open_cli_schema_version: 1.0
   2 name: microservice-create
   3 description: Register microservice into Onap
   4 version: onap-1.1
   5 service:
   6   name: msb
   7   version: v1
   8
   9 parameters:
  10   - name: service-name
  11     description: Onap service name
  12     type: string
  13     short_option: x
  14     long_option: service-name
  15     is_optional: false
  16   - name: service-version
  17     description: Onap service version
  18     type: string
  19     short_option: y
  20     long_option: service-version
  21     is_optional: false
  22   - name: service-url
  23     description: Onap service base url
  24     type: url
  25     short_option: r
  26     long_option: service-url
  27     is_optional: false
  28   - name: node-ip
  29     description: Onap service running node IP
  30     type: string
  31   - name: node-port
  32     description: Onap service running node port
  33     type: string
  34   - name: create-or-update
  35     description: Onap service create or update
  36     type: bool
  37     default_value: true
  38 results:
  39   direction: portrait
  40   attributes:
  41     - name: name
  42       description: Onap service name
  43       scope: short
  44       type: string
  45     - name: version
  46       description: Onap service version
  47       scope: short
  48       type: string
  49     - name: url
  50       description: Onap service base url
  51       scope: short
  52       type: url
  53     - name: status
  54       description: Onap service status
  55       scope: short
  56       type: digit
  57     - name: nodes
  58       description: Onap service running nodes
  59       scope: long
  60       type: string
  61     - name: location
  62       description: Onap service location
  63       scope: long
  64       type: url
  65 http:
  66   request:
  67     uri: /services
  68     method: POST
  69     body: '{"serviceName":"${service-name}","version":"${service-version}","url":"${service-url}","protocol":"REST","visualRange":"1","lb_policy":"hash","nodes":[{"ip":"${node-ip}","port":"${node-port}","ttl":0}]}'
  70     headers:
  71     queries:
  72       createOrUpdate: ${create-or-update}
  73   success_codes:
  74     - 201
  75     - 200
  76   result_map:
  77     name: $b{$.serviceName}
  78     version: $b{$.version}
  79     url: $b{$.url}
  80     status: $b{$.status}
  81     nodes: $b{$.nodes[*].ip}:$b{$.nodes[*].port}
  82     location: $h{Location}
  83
  84   sample_response:
  85     body: '{"serviceName":"test","version":"v1","url":"/api/test/v1","protocol":"REST","visualRange":"1","lb_policy":"hash","nodes":[{"ip":"127.0.0.1","port":"8012","ttl":0,"nodeId":"test_127.0.0.1_8012","expiration":"2017-02-10T05:33:25Z","created_at":"2017-02-10T05:33:25Z","updated_at":"2017-02-10T05:33:25Z"}],"status":"1"}'