summaryrefslogtreecommitdiffstats
path: root/plugins/msb/src/main/resources/open-cli-schema
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/msb/src/main/resources/open-cli-schema')
-rw-r--r--plugins/msb/src/main/resources/open-cli-schema/microservice-create-schema.yaml104
-rw-r--r--plugins/msb/src/main/resources/open-cli-schema/microservice-delete-schema.yaml46
-rw-r--r--plugins/msb/src/main/resources/open-cli-schema/microservice-list-schema.yaml60
-rw-r--r--plugins/msb/src/main/resources/open-cli-schema/microservice-show-schema.yaml73
4 files changed, 283 insertions, 0 deletions
diff --git a/plugins/msb/src/main/resources/open-cli-schema/microservice-create-schema.yaml b/plugins/msb/src/main/resources/open-cli-schema/microservice-create-schema.yaml
new file mode 100644
index 00000000..79afd2c7
--- /dev/null
+++ b/plugins/msb/src/main/resources/open-cli-schema/microservice-create-schema.yaml
@@ -0,0 +1,104 @@
+open_cli_schema_version: 1.0
+name: microservice-create
+description: Register microservice into Onap
+version: onap-1.1
+service:
+ name: msb
+ version: v1
+ auth: none
+
+parameters:
+ - name: service-name
+ description: Onap service name
+ type: string
+ short_option: x
+ long_option: service-name
+ is_optional: false
+ - name: service-version
+ description: Onap service version
+ type: string
+ short_option: y
+ long_option: service-version
+ is_optional: false
+ - name: service-url
+ description: Onap service base url
+ type: url
+ short_option: r
+ long_option: service-url
+ is_optional: false
+ - name: enable-ssl
+ description: Onap service is enabled with https or not
+ type: string
+ short_option: b
+ long_option: enable-ssl
+ is_optional: true
+ default: false
+ - name: path
+ description: Onap service path
+ type: string
+ short_option: c
+ long_option: path
+ is_optional: true
+ - name: node-ip
+ description: Onap service running node IP
+ type: string
+ - name: node-port
+ description: Onap service running node port
+ type: string
+ - name: create-or-update
+ description: Onap service create or update
+ type: bool
+ default_value: true
+results:
+ direction: portrait
+ attributes:
+ - name: name
+ description: Onap service name
+ scope: short
+ type: string
+ - name: version
+ description: Onap service version
+ scope: short
+ type: string
+ - name: url
+ description: Onap service base url
+ scope: short
+ type: url
+ - name: status
+ description: Onap service status
+ scope: short
+ type: digit
+ - name: nodes
+ description: Onap service running nodes
+ scope: long
+ type: string
+ - name: enable-ssl
+ description: Onap service is enabled with https or not
+ scope: long
+ type: string
+ - name: path
+ description: Onap service path
+ scope: long
+ type: string
+http:
+ request:
+ uri: /services
+ method: POST
+ body: '{"serviceName":"${service-name}","version":"${service-version}","path":"${path}","url":"${service-url}","protocol":"REST", "enable_ssl":"${enable-ssl}", "visualRange":"1","lb_policy":"ip_hash","nodes":[{"ip":"${node-ip}","port":"${node-port}","ttl":0}]}'
+ headers:
+ queries:
+ createOrUpdate: ${create-or-update}
+ success_codes:
+ - 201
+ - 200
+ result_map:
+ name: $b{$.serviceName}
+ version: $b{$.version}
+ url: $b{$.url}
+ status: $b{$.status}
+ enable-ssl: $b{$.enable_ssl}
+ path: $b{$.path}
+ nodes: $b{$.nodes[*].ip}:$b{$.nodes[*].port}
+
+ sample_response:
+ 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"}'
diff --git a/plugins/msb/src/main/resources/open-cli-schema/microservice-delete-schema.yaml b/plugins/msb/src/main/resources/open-cli-schema/microservice-delete-schema.yaml
new file mode 100644
index 00000000..82eabf95
--- /dev/null
+++ b/plugins/msb/src/main/resources/open-cli-schema/microservice-delete-schema.yaml
@@ -0,0 +1,46 @@
+open_cli_schema_version: 1.0
+name: microservice-delete
+description: Deletes the micro service from Onap
+version: onap-1.1
+service:
+ name: msb
+ version: v1
+ auth: none
+
+parameters:
+ - name: service-name
+ description: Onap service name
+ type: string
+ short_option: x
+ long_option: service-name
+ is_optional: false
+ - name: service-version
+ description: Onap service version
+ type: string
+ short_option: y
+ long_option: service-version
+ is_optional: false
+ - name: node-ip
+ description: Onap service running node IP
+ type: string
+ short_option: i
+ long_option: node-ip
+ is_optional: false
+ - name: node-port
+ description: Onap service running node port
+ type: string
+ short_option: r
+ long_option: node-port
+ is_optional: false
+http:
+ request:
+ uri: /services/${service-name}/version/${service-version}/nodes/${node-ip}/${node-port}
+ method: DELETE
+ success_codes:
+ - 201
+ - 200
+ - 204
+ - 500
+
+
+
diff --git a/plugins/msb/src/main/resources/open-cli-schema/microservice-list-schema.yaml b/plugins/msb/src/main/resources/open-cli-schema/microservice-list-schema.yaml
new file mode 100644
index 00000000..52014c9b
--- /dev/null
+++ b/plugins/msb/src/main/resources/open-cli-schema/microservice-list-schema.yaml
@@ -0,0 +1,60 @@
+open_cli_schema_version: 1.0
+name: microservice-list
+description: Lists the registetred micro services in Onap
+version: onap-1.1
+service:
+ name: msb
+ version: v1
+ auth: none
+results:
+ direction: landscape
+ attributes:
+ - name: name
+ description: Onap service name
+ scope: short
+ type: string
+ - name: version
+ description: Onap service version
+ scope: short
+ type: string
+ - name: url
+ description: Onap service base url
+ scope: short
+ type: url
+ - name: status
+ description: Onap service status
+ scope: short
+ type: digit
+ - name: nodes
+ description: Onap service running nodes
+ scope: long
+ type: json
+ - name: enable-ssl
+ description: Onap service is enabled with https or not
+ scope: long
+ type: string
+ - name: path
+ description: Onap service path
+ scope: long
+ type: string
+http:
+ request:
+ uri: /services
+ method: GET
+ success_codes:
+ - 201
+ - 200
+ result_map:
+ name: $b{$.[*].serviceName}
+ version: $b{$.[*].version}
+ url: $b{$.[*].url}
+ status: $b{$.[*].status}
+ enable-ssl: $b{$.[*].enable_ssl}
+ path: $b{$.[*].path}
+ nodes: $b{$.[*].nodes[*].ip}:$b{$.[*].nodes[*].port}
+ sample_response:
+ 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"}]'
+
+
+
+
diff --git a/plugins/msb/src/main/resources/open-cli-schema/microservice-show-schema.yaml b/plugins/msb/src/main/resources/open-cli-schema/microservice-show-schema.yaml
new file mode 100644
index 00000000..a9e1cced
--- /dev/null
+++ b/plugins/msb/src/main/resources/open-cli-schema/microservice-show-schema.yaml
@@ -0,0 +1,73 @@
+open_cli_schema_version: 1.0
+name: microservice-show
+description: Details the registered microservice in Onap
+version: onap-1.1
+service:
+ name: msb
+ version: v1
+ auth: none
+parameters:
+ - name: service-name
+ description: Onap service name
+ type: string
+ short_option: x
+ long_option: service-name
+ is_optional: false
+ - name: service-version
+ description: Onap service version
+ type: string
+ short_option: y
+ long_option: service-version
+ is_optional: false
+results:
+ direction: portrait
+ attributes:
+ - name: name
+ description: Onap service name
+ scope: short
+ type: string
+ - name: version
+ description: Onap service version
+ scope: short
+ type: string
+ - name: url
+ description: Onap service base url
+ scope: short
+ type: url
+ - name: status
+ description: Onap service status
+ scope: short
+ type: digit
+ - name: nodes
+ description: Onap service running nodes
+ scope: long
+ type: json
+ - name: enable-ssl
+ description: Onap service is enabled with https or not
+ scope: long
+ type: string
+ - name: path
+ description: Onap service path
+ scope: long
+ type: string
+http:
+ request:
+ uri: /services/${service-name}/version/${service-version}
+ method: GET
+ success_codes:
+ - 201
+ - 200
+ result_map:
+ name: $b{$.serviceName}
+ version: $b{$.version}
+ url: $b{$.url}
+ status: $b{$.status}
+ enable-ssl: $b{$.enable_ssl}
+ path: $b{$.path}
+ nodes: $b{$.nodes[*].ip}:$b{$.nodes[*].port}
+ sample_response:
+ 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"}'
+
+
+
+