summaryrefslogtreecommitdiffstats
path: root/sliapi/model/yang/src/main
diff options
context:
space:
mode:
authorJessica Wagantall <jwagantall@linuxfoundation.org>2020-12-01 11:47:20 -0800
committerJessica Wagantall <jwagantall@linuxfoundation.org>2020-12-01 11:47:20 -0800
commit53eacd8519a535f96d8b4231e48925324f1086dd (patch)
treed9b4d0b1cb35677933adb4648e0563d64e0a5ef0 /sliapi/model/yang/src/main
parent96a9aafdff7813324bc8a8ba1e743683e251dde6 (diff)
parent72e952ae47506673f7efc893ae447fe55598a952 (diff)
Merge branch 'master' of /home/jwagantall/linuxfoundation/onap/IT-21112/sli-core
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
Diffstat (limited to 'sliapi/model/yang/src/main')
-rw-r--r--sliapi/model/yang/src/main/resources/sli-api.20161110.json554
-rw-r--r--sliapi/model/yang/src/main/resources/sli-api.20161110.yaml254
-rwxr-xr-xsliapi/model/yang/src/main/yang/sliapi.yang117
3 files changed, 925 insertions, 0 deletions
diff --git a/sliapi/model/yang/src/main/resources/sli-api.20161110.json b/sliapi/model/yang/src/main/resources/sli-api.20161110.json
new file mode 100644
index 000000000..1c6cdabfe
--- /dev/null
+++ b/sliapi/model/yang/src/main/resources/sli-api.20161110.json
@@ -0,0 +1,554 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "1.0.0"
+ },
+ "basePath": "/restconf",
+ "paths": {
+ "/config": {
+ "post": {
+ "consumes": [
+ "application/json",
+ "application/xml"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "**(config)test-results",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/SLI-API(config)test-results-TOP"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "No response was specified",
+ "schema": {
+ "$ref": "#/definitions/(config)SLI-API_modulePOST"
+ }
+ }
+ },
+ "description": "Defines API to service logic interpreter",
+ "operationId": "POST-SLI-API_module"
+ }
+ },
+ "/config/SLI-API:test-results": {
+ "delete": {
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "responses": {
+ "200": {
+ "description": "No response was specified"
+ }
+ },
+ "description": "Test results",
+ "operationId": "DELETE-test-results"
+ },
+ "get": {
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "responses": {
+ "200": {
+ "description": "No response was specified",
+ "schema": {
+ "$ref": "#/definitions/(config)test-results"
+ }
+ }
+ },
+ "description": "Test results",
+ "operationId": "GET-test-results"
+ },
+ "post": {
+ "consumes": [
+ "application/json",
+ "application/xml"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "**(config)test-result",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/SLI-API/test-results(config)test-result-TOP"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "No response was specified",
+ "schema": {
+ "$ref": "#/definitions/(config)test-resultsPOST"
+ }
+ }
+ },
+ "description": "Test results",
+ "operationId": "POST-test-results"
+ },
+ "put": {
+ "consumes": [
+ "application/json",
+ "application/xml"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "(config)test-results",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/SLI-API(config)test-results-TOP"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "No response was specified",
+ "schema": {
+ "$ref": "#/definitions/SLI-API(config)test-results-TOP"
+ }
+ }
+ },
+ "description": "Test results",
+ "operationId": "PUT-test-results"
+ }
+ },
+ "/config/SLI-API:test-results/test-result/{test-identifier}": {
+ "delete": {
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "test-identifier",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "No response was specified"
+ }
+ },
+ "operationId": "DELETE-test-result"
+ },
+ "get": {
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "test-identifier",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "No response was specified",
+ "schema": {
+ "$ref": "#/definitions/(config)test-result"
+ }
+ }
+ },
+ "operationId": "GET-test-result"
+ },
+ "put": {
+ "consumes": [
+ "application/json",
+ "application/xml"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "test-identifier",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "body",
+ "name": "(config)test-result",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/SLI-API/test-results(config)test-result-TOP"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "No response was specified",
+ "schema": {
+ "$ref": "#/definitions/SLI-API/test-results(config)test-result-TOP"
+ }
+ }
+ },
+ "operationId": "PUT-test-result"
+ }
+ },
+ "/operational/SLI-API:test-results": {
+ "get": {
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "responses": {
+ "200": {
+ "description": "No response was specified",
+ "schema": {
+ "$ref": "#/definitions/(operational)test-results"
+ }
+ }
+ },
+ "description": "Test results",
+ "operationId": "GET-test-results"
+ }
+ },
+ "/operations/SLI-API:execute-graph": {
+ "post": {
+ "consumes": [
+ "application/json",
+ "application/xml"
+ ],
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/(execute-graph)input-TOP"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "No response was specified",
+ "schema": {
+ "$ref": "#/definitions/(execute-graph)output-TOP"
+ }
+ }
+ },
+ "description": " Method to add a new parameter.",
+ "operationId": "execute-graph"
+ }
+ },
+ "/operations/SLI-API:healthcheck": {
+ "post": {
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "responses": {
+ "200": {
+ "description": "No response was specified",
+ "schema": {
+ "$ref": "#/definitions/(healthcheck)output-TOP"
+ }
+ }
+ },
+ "operationId": "healthcheck"
+ }
+ },
+ "/operations/SLI-API:vlbcheck": {
+ "post": {
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "responses": {
+ "200": {
+ "description": "No response was specified",
+ "schema": {
+ "$ref": "#/definitions/(vlbcheck)output-TOP"
+ }
+ }
+ },
+ "operationId": "vlbcheck"
+ }
+ }
+ },
+ "definitions": {
+ "(config)SLI-API_modulePOST": {
+ "properties": {
+ "test-results": {
+ "items": {
+ "$ref": "#/definitions/SLI-API(config)test-results"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "(config)sli-parameterPOST": {
+ "properties": {
+ "boolean-value": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "int-value": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "parameter-name": {
+ "$ref": "#/definitions/Optional.empty",
+ "description": "Parameter name"
+ },
+ "string-value": {
+ "$ref": "#/definitions/Optional.empty"
+ }
+ },
+ "type": "object"
+ },
+ "(config)test-resultPOST": {
+ "properties": {
+ "test-identifier": {
+ "$ref": "#/definitions/Optional.empty"
+ }
+ },
+ "type": "object"
+ },
+ "(config)test-resultsPOST": {
+ "properties": {
+ "test-result": {
+ "items": {
+ "$ref": "#/definitions/SLI-API/test-results(config)test-result"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "(execute-graph)input": {
+ "properties": {
+ "SLI-API:mode": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:module-name": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:rpc-name": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:sli-parameter": {
+ "items": {
+ "$ref": "#/definitions/SLI-API(config)sli-parameter"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "(execute-graph)input-TOP": {
+ "properties": {
+ "SLI-API:input": {
+ "items": {
+ "$ref": "#/definitions/(execute-graph)input"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "(execute-graph)output": {
+ "properties": {
+ "SLI-API:ack-final-indicator": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:context-memory-json": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:response-code": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:response-message": {
+ "$ref": "#/definitions/Optional.empty"
+ }
+ },
+ "type": "object"
+ },
+ "(execute-graph)output-TOP": {
+ "properties": {
+ "SLI-API:output": {
+ "items": {
+ "$ref": "#/definitions/(execute-graph)output"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "(healthcheck)output": {
+ "properties": {
+ "SLI-API:ack-final-indicator": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:context-memory-json": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:response-code": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:response-message": {
+ "$ref": "#/definitions/Optional.empty"
+ }
+ },
+ "type": "object"
+ },
+ "(healthcheck)output-TOP": {
+ "properties": {
+ "SLI-API:output": {
+ "items": {
+ "$ref": "#/definitions/(healthcheck)output"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "(vlbcheck)output": {
+ "properties": {
+ "SLI-API:ack-final-indicator": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:context-memory-json": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:response-code": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:response-message": {
+ "$ref": "#/definitions/Optional.empty"
+ }
+ },
+ "type": "object"
+ },
+ "(vlbcheck)output-TOP": {
+ "properties": {
+ "SLI-API:output": {
+ "items": {
+ "$ref": "#/definitions/(vlbcheck)output"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "SLI-API(config)sli-parameter": {
+ "properties": {
+ "SLI-API:boolean-value": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:int-value": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "SLI-API:parameter-name": {
+ "$ref": "#/definitions/Optional.empty",
+ "description": "Parameter name"
+ },
+ "SLI-API:string-value": {
+ "$ref": "#/definitions/Optional.empty"
+ }
+ },
+ "type": "object"
+ },
+ "SLI-API(config)sli-parameter-TOP": {
+ "properties": {
+ "SLI-API:sli-parameter": {
+ "items": {
+ "$ref": "#/definitions/SLI-API(config)sli-parameter"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SLI-API(config)test-results": {
+ "properties": {
+ "SLI-API:test-result": {
+ "items": {
+ "$ref": "#/definitions/SLI-API/test-results(config)test-result"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SLI-API(config)test-results-TOP": {
+ "properties": {
+ "SLI-API:test-results": {
+ "description": "Test results",
+ "items": {
+ "$ref": "#/definitions/SLI-API(config)test-results"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "SLI-API(operational)test-results": {
+ "type": "object"
+ },
+ "SLI-API(operational)test-results-TOP": {
+ "properties": {
+ "SLI-API:test-results": {
+ "description": "Test results",
+ "items": {
+ "$ref": "#/definitions/SLI-API(operational)test-results"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "SLI-API/test-results(config)test-result": {
+ "properties": {
+ "SLI-API:results": {
+ "items": {
+ "$ref": "#/definitions/Optional.empty"
+ },
+ "type": "array"
+ },
+ "SLI-API:test-identifier": {
+ "$ref": "#/definitions/Optional.empty"
+ }
+ },
+ "type": "object"
+ },
+ "SLI-API/test-results(config)test-result-TOP": {
+ "properties": {
+ "SLI-API:test-result": {
+ "items": {
+ "$ref": "#/definitions/SLI-API/test-results(config)test-result"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "unique_empty_identifier": {}
+ }
+}
diff --git a/sliapi/model/yang/src/main/resources/sli-api.20161110.yaml b/sliapi/model/yang/src/main/resources/sli-api.20161110.yaml
new file mode 100644
index 000000000..3420c66b5
--- /dev/null
+++ b/sliapi/model/yang/src/main/resources/sli-api.20161110.yaml
@@ -0,0 +1,254 @@
+---
+swagger: '2.0'
+info:
+ version: 1.0.0
+ title: "SLI API"
+basePath: '/restconf'
+schemes:
+ - http
+ - https
+paths:
+ '/restconf/config/SLI-API:test-results':
+ delete:
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ '200':
+ description: No response was specified
+ description: Test results
+ operationId: delete-test-results
+ get:
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ '200':
+ description: No response was specified
+ schema:
+ $ref: '#/definitions/test-results'
+ description: Test results
+ operationId: get-test-results
+ post:
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ parameters:
+ - in: body
+ name: testResults
+ required: false
+ schema:
+ $ref: '#/definitions/test-results'
+ responses:
+ '200':
+ description: No response was specified
+ schema:
+ $ref: '#/definitions/test-results'
+ description: Test results
+ operationId: post-test-results
+ put:
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ parameters:
+ - in: body
+ name: testResults
+ required: false
+ schema:
+ $ref: '#/definitions/test-results'
+ responses:
+ '200':
+ description: No response was specified
+ schema:
+ $ref: '#/definitions/test-results'
+ description: Test results
+ operationId: put-test-results
+
+ '/restconf/config/SLI-API:test-results/test-result/{test-identifier}':
+ delete:
+ produces:
+ - application/json
+ - application/xml
+ parameters:
+ - in: path
+ name: test-identifier
+ required: true
+ type: string
+ responses:
+ '200':
+ description: No response was specified
+ operationId: delete-test-result
+ get:
+ produces:
+ - application/json
+ - application/xml
+ parameters:
+ - in: path
+ name: test-identifier
+ required: true
+ type: string
+ responses:
+ '200':
+ description: No response was specified
+ schema:
+ $ref: '#/definitions/test-result'
+ operationId: get-test-result
+ put:
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ parameters:
+ - in: path
+ name: test-identifier
+ required: true
+ type: string
+ - in: body
+ name: testResult
+ required: false
+ schema:
+ $ref: '#/definitions/test-result'
+ responses:
+ '200':
+ description: No response was specified
+ schema:
+ $ref: '#/definitions/test-result'
+ operationId: PUT-test-result
+
+ '/restconf/operational/SLI-API:test-results':
+ get:
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ '200':
+ description: No response was specified
+ schema:
+ $ref: '#/definitions/test-results'
+ description: Test results
+ operationId: GET-test-results
+ '/restconf/operations/SLI-API:execute-graph':
+ post:
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ parameters:
+ - in: body
+ name: executeGraphInput
+ required: false
+ schema:
+ $ref: '#/definitions/execute-graph-input'
+ responses:
+ '200':
+ description: No response was specified
+ schema:
+ $ref: '#/definitions/response-fields'
+ description: ' Method to add a new parameter.'
+ operationId: execute-graph
+ '/restconf/operations/SLI-API:healthcheck':
+ post:
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ '200':
+ description: No response was specified
+ schema:
+ $ref: '#/definitions/response-fields'
+ operationId: healthcheck
+ '/restconf/operations/SLI-API:vlbcheck':
+ post:
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ '200':
+ description: No response was specified
+ schema:
+ $ref: '#/definitions/response-fields'
+ operationId: vlbcheck
+
+definitions:
+ parameter-setting:
+ type: object
+ properties:
+ parameter-name:
+ type: string
+ int-value:
+ type: integer
+ string-value:
+ type: string
+ boolean-value:
+ type: boolean
+
+ response-fields:
+ type: object
+ properties:
+ response-code:
+ type: string
+ ack-final-indicator:
+ type: string
+ response-message:
+ type: string
+ context-memory-json:
+ type: string
+
+ test-results:
+ type: object
+ properties:
+ test-results:
+ type: array
+ items:
+ $ref: '#/definitions/test-result'
+
+ test-result:
+ type: object
+ properties:
+ test-identifier:
+ type: string
+ results:
+ type: array
+ items:
+ type: string
+
+ execute-graph-input:
+ properties:
+ 'input':
+ type: object
+ properties:
+ 'mode':
+ type: string
+ 'module-name':
+ type: string
+ 'rpc-name':
+ type: string
+ 'sli-parameter':
+ items:
+ $ref: '#/definitions/parameter-setting'
+ type: array
+ type: object
+
+
+
+
+
+
+ unique_empty_identifier: {}
+
diff --git a/sliapi/model/yang/src/main/yang/sliapi.yang b/sliapi/model/yang/src/main/yang/sliapi.yang
new file mode 100755
index 000000000..98cbb2aa7
--- /dev/null
+++ b/sliapi/model/yang/src/main/yang/sliapi.yang
@@ -0,0 +1,117 @@
+module SLI-API {
+
+ yang-version 1;
+
+ namespace "org:onap:ccsdk:sli:core:sliapi";
+
+ prefix sample;
+
+ import ietf-inet-types { prefix "inet"; revision-date 2013-07-15; }
+
+ organization "ONAP";
+
+ contact
+ "Dan Timoney";
+
+ description
+ "Defines API to service logic interpreter";
+
+ revision "2016-11-10" {
+ description
+ "REST API to Service Logic Interpreter";
+ }
+
+ grouping parameter-setting {
+ description
+ "Parameter setting";
+
+ leaf parameter-name {
+ type string;
+ description "Parameter name";
+ }
+
+ leaf int-value {
+ type int32;
+ }
+ leaf string-value {
+ type string;
+ }
+ leaf boolean-value {
+ type boolean;
+ }
+ }
+
+ grouping response-fields {
+ leaf response-code {
+ type string;
+ }
+ leaf ack-final-indicator {
+ type string;
+ }
+ leaf response-message {
+ type string;
+ }
+ leaf context-memory-json {
+ type string;
+ }
+ }
+
+ container test-results {
+ description "Test results";
+
+ list test-result {
+ key "test-identifier";
+
+ leaf test-identifier {
+ type string;
+ }
+
+ leaf-list results {
+ type string;
+ }
+ }
+ }
+
+ rpc execute-graph {
+ description " Method to add a new parameter.";
+ input {
+
+ leaf module-name {
+ type string;
+ }
+
+ leaf rpc-name {
+ type string;
+ }
+
+ leaf mode {
+ type enumeration {
+ enum sync;
+ enum async;
+ }
+ }
+
+ list sli-parameter {
+ key "parameter-name";
+ uses parameter-setting;
+ }
+ }
+
+ output {
+ uses response-fields;
+ }
+ }
+
+ rpc healthcheck {
+ output {
+ uses response-fields;
+ }
+ }
+
+ rpc vlbcheck {
+ output {
+ uses response-fields;
+ }
+ }
+
+}