From 21d59414fca273aade30aa4209aca9bb35a5f78f Mon Sep 17 00:00:00 2001 From: thmsdt Date: Tue, 2 Aug 2022 13:28:17 +0200 Subject: update and rearrange documentation related content Issue-ID: DOC-798 Signed-off-by: thmsdt Change-Id: Id454ec5f09903efb81123669e6eb024f21a08797 --- .../onap-documentation/media/git_branches.png | Bin 0 -> 35166 bytes .../onap-documentation/media/git_branches.svg | 620 +++++++++++++++++++++ docs/guides/onap-documentation/media/myAPI1.json | 37 ++ docs/guides/onap-documentation/media/myAPI2.json | 37 ++ 4 files changed, 694 insertions(+) create mode 100644 docs/guides/onap-documentation/media/git_branches.png create mode 100644 docs/guides/onap-documentation/media/git_branches.svg create mode 100644 docs/guides/onap-documentation/media/myAPI1.json create mode 100644 docs/guides/onap-documentation/media/myAPI2.json (limited to 'docs/guides/onap-documentation/media') diff --git a/docs/guides/onap-documentation/media/git_branches.png b/docs/guides/onap-documentation/media/git_branches.png new file mode 100644 index 000000000..00c698451 Binary files /dev/null and b/docs/guides/onap-documentation/media/git_branches.png differ diff --git a/docs/guides/onap-documentation/media/git_branches.svg b/docs/guides/onap-documentation/media/git_branches.svg new file mode 100644 index 000000000..faddef9cf --- /dev/null +++ b/docs/guides/onap-documentation/media/git_branches.svg @@ -0,0 +1,620 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + Master + + + + + + + + + + Feature1 + Feature2 + enhanced feature2 + + + + bugfix1 + + + feature3 + + + + bugfix2 + + + + + + + feature4 + + + + + stable/A + stable/B + Stable branch creation + + cherry pick bugfix2 + + Stable branch creation + + + =1 commit + merge branch 'feature1' + + to master branch + create branch + for 'feature1' + + + diff --git a/docs/guides/onap-documentation/media/myAPI1.json b/docs/guides/onap-documentation/media/myAPI1.json new file mode 100644 index 000000000..b611ad81c --- /dev/null +++ b/docs/guides/onap-documentation/media/myAPI1.json @@ -0,0 +1,37 @@ +{ + "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" + } + } + } + } + } +} diff --git a/docs/guides/onap-documentation/media/myAPI2.json b/docs/guides/onap-documentation/media/myAPI2.json new file mode 100644 index 000000000..473d351b2 --- /dev/null +++ b/docs/guides/onap-documentation/media/myAPI2.json @@ -0,0 +1,37 @@ +{ + "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" + } + } + } + } + } +} -- cgit