From adef520003cc54ae60fc62154df8caacb0610243 Mon Sep 17 00:00:00 2001 From: Dan Timoney Date: Thu, 12 Oct 2017 09:04:22 -0400 Subject: Add readthedocs documentation for sli/northbound Add readthedocs documentation for sli/northbound. Change-Id: I8ca9d7e839408094ab3754500d71fe7463f0b0e4 Issue-ID: CCSDK-107 Signed-off-by: Dan Timoney --- dataChange/model/pom.xml | 165 +++++++++++---------- .../src/main/resources/dataChange.20150519.json | 136 +++++++++++++++++ 2 files changed, 224 insertions(+), 77 deletions(-) create mode 100644 dataChange/model/src/main/resources/dataChange.20150519.json (limited to 'dataChange') diff --git a/dataChange/model/pom.xml b/dataChange/model/pom.xml index 20dddeb9..5f7101cd 100755 --- a/dataChange/model/pom.xml +++ b/dataChange/model/pom.xml @@ -1,82 +1,93 @@ - - 4.0.0 - - dataChange - org.onap.ccsdk.sli.northbound - 0.1.0-SNAPSHOT - - org.onap.ccsdk.sli.northbound - dataChange-model - 0.1.0-SNAPSHOT - bundle + + 4.0.0 + + dataChange + org.onap.ccsdk.sli.northbound + 0.1.0-SNAPSHOT + + org.onap.ccsdk.sli.northbound + dataChange-model + 0.1.0-SNAPSHOT + bundle - - - - org.apache.felix - maven-bundle-plugin - true - - - * - - - - - org.opendaylight.yangtools - yang-maven-plugin - ${odl.yangtools.yang.maven.plugin.version} - - - org.opendaylight.mdsal - maven-sal-api-gen-plugin - ${odl.sal.api.gen.plugin.version} - jar - - - - - - generate-sources - - - ${yang.file.directory} - - - org.opendaylight.mdsal.binding.maven.api.gen.plugin.CodeGeneratorImpl - ${salGeneratorPath} - - - true - - - - - - + + + + org.apache.felix + maven-bundle-plugin + true + + + * + + + + + org.opendaylight.yangtools + yang-maven-plugin + ${odl.yangtools.yang.maven.plugin.version} + + + org.opendaylight.mdsal + maven-sal-api-gen-plugin + ${odl.sal.api.gen.plugin.version} + jar + + + org.opendaylight.netconf + sal-rest-docgen-maven + ${odl.restconf.version} + jar + + + + + + generate-sources + + + ${yang.file.directory} + + + org.opendaylight.mdsal.binding.maven.api.gen.plugin.CodeGeneratorImpl + ${salGeneratorPath} + + + org.opendaylight.netconf.sal.rest.doc.maven.StaticDocGenerator + target/swagger + + + true + + + + + + - - - org.opendaylight.mdsal - yang-binding - ${odl.mdsal.yang.binding.version} - - - org.opendaylight.yangtools - yang-common - ${odl.yangtools.version} - - - org.opendaylight.mdsal.model - ietf-inet-types - ${odl.ietf-inet-types.version} - - - org.opendaylight.mdsal.model - ietf-yang-types - ${odl.ietf-yang-types.version} - - + + + org.opendaylight.mdsal + yang-binding + ${odl.mdsal.yang.binding.version} + + + org.opendaylight.yangtools + yang-common + ${odl.yangtools.version} + + + org.opendaylight.mdsal.model + ietf-inet-types + ${odl.ietf-inet-types.version} + + + org.opendaylight.mdsal.model + ietf-yang-types + ${odl.ietf-yang-types.version} + + diff --git a/dataChange/model/src/main/resources/dataChange.20150519.json b/dataChange/model/src/main/resources/dataChange.20150519.json new file mode 100644 index 00000000..128195b5 --- /dev/null +++ b/dataChange/model/src/main/resources/dataChange.20150519.json @@ -0,0 +1,136 @@ +{ + "swagger": "2.0", + "info": { + "version": "1.0.0" + }, + "basePath": "/restconf", + "paths": { + "/operations/DataChange:data-change-notification": { + "post": { + "consumes": [ + "application/json", + "application/xml" + ], + "produces": [ + "application/json", + "application/xml" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/(data-change-notification)input-TOP" + } + } + ], + "responses": { + "200": { + "description": "No response was specified", + "schema": { + "$ref": "#/definitions/(data-change-notification)output-TOP" + } + } + }, + "operationId": "data-change-notification" + } + } + }, + "definitions": { + "(config)DataChange_modulePOST": { + "type": "object" + }, + "(config)key-dataPOST": { + "properties": { + "key-name": { + "$ref": "#/definitions/Some key-name" + }, + "key-value": { + "$ref": "#/definitions/Some key-value" + } + }, + "type": "object" + }, + "(data-change-notification)input": { + "properties": { + "DataChange:aai-event-id": { + "$ref": "#/definitions/Some aai-event-id" + }, + "DataChange:aai-event-trigger": { + "$ref": "#/definitions/Update", + "enum": [ + "Update", + "Delete" + ] + }, + "DataChange:aai-node-type": { + "$ref": "#/definitions/Some aai-node-type" + }, + "DataChange:key-data": { + "items": { + "$ref": "#/definitions/DataChange(config)key-data" + }, + "type": "array" + }, + "DataChange:selflink": { + "$ref": "#/definitions/Some selflink" + } + }, + "type": "object" + }, + "(data-change-notification)input-TOP": { + "properties": { + "DataChange:input": { + "items": { + "$ref": "#/definitions/(data-change-notification)input" + }, + "type": "object" + } + }, + "type": "object" + }, + "(data-change-notification)output": { + "properties": { + "DataChange:data-change-response-code": { + "$ref": "#/definitions/Some data-change-response-code" + } + }, + "type": "object" + }, + "(data-change-notification)output-TOP": { + "properties": { + "DataChange:output": { + "items": { + "$ref": "#/definitions/(data-change-notification)output" + }, + "type": "object" + } + }, + "type": "object" + }, + "DataChange(config)key-data": { + "properties": { + "DataChange:key-name": { + "$ref": "#/definitions/Some key-name" + }, + "DataChange:key-value": { + "$ref": "#/definitions/Some key-value" + } + }, + "type": "object" + }, + "DataChange(config)key-data-TOP": { + "properties": { + "DataChange:key-data": { + "items": { + "$ref": "#/definitions/DataChange(config)key-data" + }, + "type": "array" + } + }, + "type": "object" + }, + "unique_empty_identifier": {} + } +} -- cgit 1.2.3-korg