--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2019 Orange. All rights reserved.
+
+.. _api-swagger-guide:
+
+API documentation
+=================
+
+Swagger
+-------
+
+The API should be described using OpenAPI specifications and available as a
+`JSON file <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md>`_
+
+A Swagger editor is available here `<http://editor.swagger.io/>`_ to generate
+such JSON files.
+
+As a result, you should get one JSON file per API:
+
+- myAPI1.json
+- myAPI2.json
+
+Global API table
+----------------
+It is recommended to list the following API available with an access to the
+Swagger JSON files to help the developers/users to play with JSON.
+
+We propose the following table:
+
+.. csv-table::
+ :header: "API name", "Swagger JSON"
+ :widths: 10,5
+
+ "myAPI1", ":download:`link <myAPI1.json>`"
+ "myAPI12", ":download:`link <myAPI2.json>`"
+
+
+The code is available here:
+
+.. code:: rst
+
+ ..csv-table::
+ :header: "API name", "Swagger JSON"
+ :widths: 10,5
+
+ "myAPI1", ":download:`link <myAPI1.json>`"
+ "myAPI2", ":download:`link <myAPI2.json>`"
+
+API Swagger
+-----------
+For each API, the ``swaggerv2doc`` directive must be used as follows:
+
+.. code:: rst
+
+ myAPI1
+ ......
+ .. swaggerv2doc:: myAPI1.json
+
+ myAPI2
+ ......
+ .. swaggerv2doc:: myAPI2.json
+
+It will produce the following output:
+
+myAPI1
+......
+.. swaggerv2doc:: myAPI1.json
+
+myAPI2
+......
+.. swaggerv2doc:: myAPI2.json
documentation-guide
style-guide
include-documentation
+ api-swagger-guide
converting-formats
addendum
--- /dev/null
+{
+ "swagger" : "2.0",
+ "info" : {
+ "description" : "my API 1",
+ "version" : "1.0.0",
+ "title" : "API example",
+ "contact" : {
+ "email" : "onap@orange.com"
+ },
+ "license" : {
+ "name" : "Apache 2.0",
+ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
+ }
+ },
+ "host" : "serverRoot",
+ "basePath" : "/healthCheck",
+ "schemes" : [ "https" ],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
+ "paths" : {
+ "/healthCheck" : {
+ "get" : {
+ "summary" : "Displays healhcheck for my favorite component",
+ "description" : "Displays healthcheck for my favorite component",
+ "responses": {
+ "200": {
+ "description": "Service OK"
+ },
+ "503" : {
+ "description" : "Service Unavailable"
+ }
+ }
+ }
+ }
+ }
+}
--- /dev/null
+{
+ "swagger" : "2.0",
+ "info" : {
+ "description" : "my API 2",
+ "version" : "1.0.0",
+ "title" : "API example",
+ "contact" : {
+ "email" : "onap@orange.com"
+ },
+ "license" : {
+ "name" : "Apache 2.0",
+ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
+ }
+ },
+ "host" : "serverRoot",
+ "basePath" : "/status",
+ "schemes" : [ "https" ],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
+ "paths" : {
+ "/status" : {
+ "get" : {
+ "summary" : "Displays status for my favorite component",
+ "description" : "Displays status for my favorite component",
+ "responses": {
+ "200": {
+ "description": "Service OK"
+ },
+ "503" : {
+ "description" : "Service Unavailable"
+ }
+ }
+ }
+ }
+ }
+}
===================
The following releases are available for Casablanca:
+ - `Casablanca Maintenance Release 3.0.2`_
- `Casablanca Maintenance Release 3.0.1`_
- `Casablanca Major Release 3.0.0`_
+Casablanca Maintenance Release 3.0.2
+====================================
+
+* Release Name: Casablanca
+* Release Version: 3.0.2
+* Release Date: Apr 15, 2019
+
+Casablanca Maintenance Release 3.0.2 addresses issue of certificate expiry across the following projects:
+ - AAI
+ - CLAMP
+ - DMAAP
+ - Policy
+ - VID
+ - Portal
+
+Details on the specific Jira tickets addressed by each project can be found in the component specific Release Notes. Link can be found below in section `Project Specific Release Notes`_.
+
+
Casablanca Maintenance Release 3.0.1
====================================
* Release Version: 3.0.1
* Release Date: Jan 31, 2019
-The Casablanca Maintenance Release delivered a number of fixes and updates across the following projects:
+Casablanca Maintenance Release 3.0.1 delivered a number of fixes and updates across the following projects:
- AAI
- APPC
- CCSDK
ONAP Maturity Testing Notes
===========================
-For the Casablanca release, ONAP continues to improve in multiple areas of Scalability, Security, Stability and Performance (S3P) metrics.\r
+For the Casablanca release, ONAP continues to improve in multiple areas of Scalability, Security, Stability and Performance (S3P) metrics.
The Integration team ran the 72 hours stability testing (100% passing rate) and full resilience testing (96.9% passing rate) at ONAP OpenLabs. More details in :ref:`ONAP Maturity Testing Notes <integration-s3p>`
releaserepos.rst
repolist.rst
-
-Subproject commit dcd0cb51ce490f0d790713a2c1e9dc5fda36e70d
+Subproject commit 4ac37bffd664bbc2d6d419d9420393193573320d
-Subproject commit 111d6a833bb7ba527d306fa19bac9be6b488d09b
+Subproject commit c0b515db857565a259d99a14cd71b58e5d7e8ecc
-Subproject commit b2b5c9cc0fade491f85cba743ec66459bb7342f8
+Subproject commit b246959cee2989220eff5d3e92028c685a201b67
-Subproject commit 55d98d4c82ed48eb70372744e0d15750158ea226
+Subproject commit e09363bcb06b4b08157ddecd7662a9d18823b778
-Subproject commit 5ef963fcebf2e97fc097837d3993ad0f66885568
+Subproject commit 0c0e1d2e6d5e57a99ff8551a2d7b8e9cdab7d860
-Subproject commit ede33b1a140b56b2fd225c7298122329f650f537
+Subproject commit 6c64ce6d8be0d03ddc9d940cc5caeb7000b1f390
-Subproject commit a98577e6a0a6fed54afebeb08c4de7c9215e49bb
+Subproject commit e4e7c6a19dd50516247ad33dbe2a868b7825ea10
-Subproject commit d1a63a6b35566d81b7282d4c2e08cb6a1f3857db
+Subproject commit dd0365a7af08b6731d616eb223e49ab41a513bed
-Subproject commit 4444a934c6ad97d0222abc351af4c392d42f654e
+Subproject commit 0654d98f69b80b8d932dd33a5dcc56dbecc6a64e
-Subproject commit f4e1836eab2cff83bc2542383ed7f97d98a7b68c
+Subproject commit d8fb6bed0fba236ea2bfce3c44491238fe95a0ef
-Subproject commit 1db162bfcd9acafa3a19c80e3943f568c9f8874a
+Subproject commit ad380db9da867dc872310df6b1fe47230c22d12c
-Subproject commit 6aa307c93bb05223f8b0c797b6425041a298955e
+Subproject commit 61897e10d54f4979a1fc6cce863f19e6ba10445f
-Subproject commit ab387d808a47eec557e7c162c44fe1e412a2456f
+Subproject commit 76cb15908ebfab78034aff381ba5c867b5491c05
-Subproject commit 932322113184862b906f4b82fe83cfcf3403d021
+Subproject commit 3357aa8ad47c923021d53796c618c94f7c4ef37c
-Subproject commit 871909a6f7f6899d0aa2df902be7df2696fd9280
+Subproject commit 4c8d63c24acd45a9ae19af0434848c273f470ae2
-Subproject commit 0a963269106eeee84f48bcb2bb7c64449a43d3c6
+Subproject commit e5207baa3f699ae1612d987f226b5cbf70bdc029
-Subproject commit a5e82a2a703fd31cac33cef4bbe07445a274ba71
+Subproject commit c50e3fd312131ac70cf608ff4240234aab96076c
-Subproject commit 4198ff2f181030c73b4cf43979fd8a40adf80f70
+Subproject commit 75f7a15a5a14af434e0e8430fcec880106d64dbf
-Subproject commit f2f9e5e8c4ce5c3ff75cbe6f6f4e2de5e4b3f3fb
+Subproject commit 5f3e975966a0eaa247ee0eac0148da2f8755e777
-Subproject commit f2c8a75c605ac97459973ce8ad4d57c0e050e402
+Subproject commit c82614f968fb7941f7778873afa3bfad51ffd42f
-Subproject commit 418b33f0488a4e80667d7d998620b20ced1f3882
+Subproject commit 0b1973b22cd5e9d203ec6dc9e668d5ce1d87d745
-Subproject commit 2eb95cf02ab70d5791723bb8d369c36dd533368a
+Subproject commit 962b8610448d6cec8f12045e09b4adac3aefbf4c
-Subproject commit 26ef4861c1ca2e8aa15342f2b34f7a51936e71ab
+Subproject commit eb0fe6f9efb11193847d5847ed8fca0c4ad9a0f8
-Subproject commit cace90c7b774f6d80e4b9e2a4fdf0cac192f1096
+Subproject commit 2aa56678b48362d87ae1eadfb9ab20737f83c3c6
-Subproject commit bf099f65e6e5b7b43458eb58bd75e2b134c63b74
+Subproject commit 655aa8c01b5e6eac5ff4aeb4d9dfb9caf2d2b729
-Subproject commit c35e5c928dae4c6d34f6c380422a15ec1a046715
+Subproject commit 9ce9bea7019f36ba318543c49069145d1bb163d9
-Subproject commit a0fd8b6fcb1f8cfae16bef075b1b8c170b8f4d3f
+Subproject commit 61ef90b0912bdd6a7cf7169d46c4c2aa7156742f
-Subproject commit 558cab7bfe457df431aca403837204c99130f177
+Subproject commit c0ff2f4edd2c2c0af660df6cfed83b20059ce452
Code Review / doc.git / commitdiff