diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/apis/genericresource.rst | 4 | ||||
| -rw-r--r-- | docs/apis/vnfapi.rst | 4 | ||||
| -rw-r--r-- | docs/architecture.rst | 11 | ||||
| -rw-r--r-- | docs/build.rst | 18 | ||||
| -rw-r--r-- | docs/index.rst | 21 | ||||
| -rw-r--r-- | docs/logging.rst | 14 | ||||
| -rw-r--r-- | docs/offeredapis.rst | 8 | ||||
| -rw-r--r-- | docs/release-notes.rst | 46 |
8 files changed, 112 insertions, 14 deletions
diff --git a/docs/apis/genericresource.rst b/docs/apis/genericresource.rst new file mode 100644 index 00000000..11a165f1 --- /dev/null +++ b/docs/apis/genericresource.rst @@ -0,0 +1,4 @@ +GENERIC-RESOURCE-API(2016-11-11) +================================ + +.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=blob_plain;f=generic-resource-api/model/src/main/resources/generic-resource-api.20161111.json diff --git a/docs/apis/vnfapi.rst b/docs/apis/vnfapi.rst new file mode 100644 index 00000000..2595a09c --- /dev/null +++ b/docs/apis/vnfapi.rst @@ -0,0 +1,4 @@ +VNF-API(2015-07-20) +=================== + +.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=blob_plain;f=vnfapi/model/src/main/resources/vnf-api.20150720.json
\ No newline at end of file diff --git a/docs/architecture.rst b/docs/architecture.rst new file mode 100644 index 00000000..34022e5b --- /dev/null +++ b/docs/architecture.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Architecture +============ + + +Capabilities +------------ +This repository contains the source code and Yang models for the SDNC northbound REST interfaces +(GENERIC-RESOURCE-API and VNF-API) diff --git a/docs/build.rst b/docs/build.rst new file mode 100644 index 00000000..0a4c308e --- /dev/null +++ b/docs/build.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Build +===== + + +Environment +----------- +Requires maven release 3.3 or greater + +Steps +----- +To compile this code: + +1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories. + +2. To compile, run "mvn clean install".
\ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index baabe50b..2055f178 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,20 +1,13 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -SDNC Northbound APIs ------------------------------------------------- +CCSDK Service Logic Interpreter +------------------------------- .. toctree:: :maxdepth: 1 -Offered APIs -============ -List of Northbound APIs + architecture.rst + offeredapis.rst + logging.rst + build.rst + release-notes.rst -VNF-API(2015-07-20) -================== - -.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=blob_plain;f=vnfapi/model/src/main/resources/vnf-api.20150720.json - -GENERIC-RESOURCE-API(2016-11-11) -================================ - -.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=blob_plain;f=generic-resource-api/model/src/main/resources/generic-resource-api.20161111.json diff --git a/docs/logging.rst b/docs/logging.rst new file mode 100644 index 00000000..187eb03b --- /dev/null +++ b/docs/logging.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Logging +======= +CCSDK uses slf4j to log messages to the standard OpenDaylight karaf.log +log file. + +Where to Access Information +--------------------------- +Logs are found within the SDNC docker container, in the directory +/opt/opendaylight/current/data/logs. + + diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst new file mode 100644 index 00000000..c734e731 --- /dev/null +++ b/docs/offeredapis.rst @@ -0,0 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Offered APIs +============ +.. toctree:: + :maxdepth: 1 + diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 00000000..b4516570 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,46 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Release Notes +============= + +.. note:: + * This Release Notes must be updated each time the team decides to Release new artifacts. + * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. + * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. + * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. + * This note must be removed after content has been added. + + +Version: x.y.z +-------------- + + +:Release Date: yyyy-mm-dd + + + +**New Features** + +One or two sentences explaining the purpose of this Release. + +**Bug Fixes** + - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing. +**Known Issues** + - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences. + One sentences explaining what is the issue. + + Another sentence explaining the impact of the issue. + + And an optional sentence providing a workaround. + +**Security Issues** + You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_ + + +**Upgrade Notes** + +**Deprecation Notes** + +**Other** + +===========
\ No newline at end of file |