diff options
Diffstat (limited to 'docs')
51 files changed, 70 insertions, 6 deletions
diff --git a/docs/conf.py b/docs/conf.py index 8f40e8b81..460860cda 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,3 +13,66 @@ html_last_updated_fmt = '%d-%b-%y %H:%M' def setup(app): app.add_stylesheet("css/ribbon_onap.css") + + +from docutils.parsers.rst import directives + +needs_extra_options = { + "target": directives.unchanged, + "keyword": directives.unchanged, + "introduced": directives.unchanged, + "updated": directives.unchanged, + "impacts": directives.unchanged, + "validation_mode": directives.unchanged, + "validated_by": directives.unchanged, + "test": directives.unchanged, + "test_case": directives.unchanged, + "test_file": directives.unchanged, + "notes": directives.unchanged, +} + +needs_id_regex = "^[A-Z0-9]+-[A-Z0-9]+" +needs_id_required = True +needs_title_optional = True + +needs_template_collapse = """ +.. _{{id}}: + +{% if hide == false -%} +.. role:: needs_tag +.. role:: needs_status +.. role:: needs_type +.. role:: needs_id +.. role:: needs_title + +.. rst-class:: need +.. rst-class:: need_{{type_name}} + +.. container:: need + + `{{id}}` - {{content|indent(4)}} + + .. container:: toggle + + .. container:: header + + Details + +{% if status and status|upper != "NONE" and not hide_status %} | status: :needs_status:`{{status}}`{% endif %} +{% if tags and not hide_tags %} | tags: :needs_tag:`{{tags|join("` :needs_tag:`")}}`{% endif %} +{% if keyword %} | keyword: `{{keyword}}` {% endif %} +{% if target %} | target: `{{target}}` {% endif %} +{% if introduced %} | introduced: `{{introduced}}` {% endif %} +{% if updated %} | updated: `{{updated}}` {% endif %} +{% if impacts %} | impacts: `{{impacts}}` {% endif %} +{% if validation_mode %} | validation mode: `{{validation_mode}}` {% endif %} +{% if validated_by %} | validated by: `{{validated_by}}` {% endif %} +{% if test %} | test: `{{test}}` {% endif %} +{% if test_case %} | test case: {{test_case}} {% endif %} +{% if test_file %} | test file: `{{test_file}}` {% endif %} +{% if notes %} | notes: `{{notes}}` {% endif %} + | children: :need_incoming:`{{id}}` + | parents: :need_outgoing:`{{id}}` +{% endif -%} +""" + diff --git a/docs/guides/onap-user/instantiate/instantiation/vid/index.rst b/docs/guides/onap-user/instantiate/instantiation/vid/index.rst index 307ceb981..d6b082488 100644 --- a/docs/guides/onap-user/instantiate/instantiation/vid/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/vid/index.rst @@ -10,4 +10,4 @@ A La Carte mode Service Instantiation via ONAP VID Portal :maxdepth: 1 :titlesonly: - ../../../../../submodules/vid.git/docs/humaninterfaces.rst + ../../../../../submodules/vid.git/docs/instantiate.rst diff --git a/docs/guides/onap-user/instantiate/pre_instantiation/index.rst b/docs/guides/onap-user/instantiate/pre_instantiation/index.rst index 6a4870242..1ab726d6a 100644 --- a/docs/guides/onap-user/instantiate/pre_instantiation/index.rst +++ b/docs/guides/onap-user/instantiate/pre_instantiation/index.rst @@ -76,7 +76,7 @@ To declare the Owning Entity in VID: :: curl -X POST \ - http://vid.api.simpledemo.onap.org:30238/vid/maintenance/category_parameter/owningEntity \ + https://vid.api.simpledemo.onap.org:30200/vid/maintenance/category_parameter/owningEntity \ -H 'Accept-Encoding: gzip, deflate' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ @@ -90,11 +90,11 @@ Example for "platform" named "Test_Platform" :: curl -X POST \ - http://vid.api.simpledemo.onap.org:30238/vid/maintenance/category_parameter/platform \ + https://vid.api.simpledemo.onap.org:30200/vid/maintenance/category_parameter/platform \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ - "options": [""Test_Platform"] + "options": ["Test_Platform"] }' Example for "line of business" named "Test_LOB" @@ -102,7 +102,7 @@ Example for "line of business" named "Test_LOB" :: curl -X POST \ - http://vid.api.simpledemo.onap.org:30238/vid/maintenance/category_parameter/lineOfBusiness \ + https://vid.api.simpledemo.onap.org:30200/vid/maintenance/category_parameter/lineOfBusiness \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ @@ -114,7 +114,7 @@ Example for "project" named "Test_project" :: curl -X POST \ - http://vid.api.simpledemo.onap.org:30238/vid/maintenance/category_parameter/project \ + https://vid.api.simpledemo.onap.org:30200/vid/maintenance/category_parameter/project \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ diff --git a/docs/index.rst b/docs/index.rst index 64ff88783..ee6933c21 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. + .. _master_index: Open Network Automation Platform diff --git a/docs/submodules/aaf/authz.git b/docs/submodules/aaf/authz.git -Subproject ba66edfffc5d58a2a963b66967a9b93beaf881b +Subproject add60903781f8bb4cbe59555bf79181cb5f73b8 diff --git a/docs/submodules/aaf/sms.git b/docs/submodules/aaf/sms.git -Subproject 137e91e4fab1995c2df7a13c455edfe6628c33f +Subproject 8b9a5a06a5652d604026f3a2293639e30c15be0 diff --git a/docs/submodules/aai/aai-common.git b/docs/submodules/aai/aai-common.git -Subproject 0aef5509aec19c6eab75ad98ed8e071706a9a0d +Subproject 4f436e1378f7ee4533701f5b1766fe04d123cd1 diff --git a/docs/submodules/aai/esr-gui.git b/docs/submodules/aai/esr-gui.git -Subproject 889f461a65931ec52aee9d0a24f8ccf93c94cdf +Subproject ae14506d535eb3fb2e9f9095375e98e784c9241 diff --git a/docs/submodules/aai/esr-server.git b/docs/submodules/aai/esr-server.git -Subproject e371a843d9e5ba7d123d920d5e1bd5a558fd198 +Subproject 3d57ab6bc5054448e23d0a0a6e843b3617565b5 diff --git a/docs/submodules/aai/event-client.git b/docs/submodules/aai/event-client.git -Subproject e0c8997a73eac90e5519c90a78a1c919cff26af +Subproject ff115760b12d3f77ea13bacd4fadc8a72beab56 diff --git a/docs/submodules/aai/sparky-be.git b/docs/submodules/aai/sparky-be.git -Subproject 02b88b997fd0671c07f58ef00ac4f3c67b2aa55 +Subproject 34687b40708b969424b0f4489258a9476ec6a91 diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git -Subproject 7b7befa39b7b70b4b18b1f1a561398b8bede622 +Subproject 90732f0d7d131cb3a9640cde51b9afdc502a7c4 diff --git a/docs/submodules/appc/deployment.git b/docs/submodules/appc/deployment.git -Subproject 9d72f25a464d5be9fa4ecc072dbad85edfeb589 +Subproject 4ea528fa8a0456c0973982687f43473acef0dbd diff --git a/docs/submodules/ccsdk/apps.git b/docs/submodules/ccsdk/apps.git -Subproject d7500059bbf0e6d7710e22319cc01a46fceecae +Subproject 27843b5e58a276dc008225a4e218d4c8e916531 diff --git a/docs/submodules/ccsdk/cds.git b/docs/submodules/ccsdk/cds.git -Subproject 723cb0b0f4fca052561f21bb8312bf7c6e8cd52 +Subproject ec47175357058d256e625bf120d152dbd49b54b diff --git a/docs/submodules/ccsdk/dashboard.git b/docs/submodules/ccsdk/dashboard.git -Subproject 2ac46fd53461288d5d99a9c0ebb8a3a5216db2a +Subproject fa848fc27df9359f6e3a6bd0aa8d54d6241c7cd diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git -Subproject 4abf7b83f764cab2c4296128f1d172259635e69 +Subproject 5e5cc2b2ace3a5fe4b1b2394bfa5a32f4664e52 diff --git a/docs/submodules/ccsdk/features.git b/docs/submodules/ccsdk/features.git -Subproject 561aa2a8ef7bd222d274aea065929920aedd072 +Subproject d20a9b57c30bb74f1485354bba85740a3ffad70 diff --git a/docs/submodules/ccsdk/platform/plugins.git b/docs/submodules/ccsdk/platform/plugins.git -Subproject 83b1669c0ec3139557172946f98dab1fd337f02 +Subproject 87d14cfc2cdcdfecbc75396d5347eae295bfb57 diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git -Subproject 899c22fccf12f50a877988c62e30d5e2c7fb7e3 +Subproject 3b7f669088d5867056578b275bf4314af3a439c diff --git a/docs/submodules/dcaegen2.git b/docs/submodules/dcaegen2.git -Subproject 1dc0ab2d286092764a066ec648c7b6659e69153 +Subproject e86ff1ed8ef779626539a97ae2e5e12b41f9d3f diff --git a/docs/submodules/dmaap/buscontroller.git b/docs/submodules/dmaap/buscontroller.git -Subproject 9162456b7e6858e7cde3443b00cca05a2011323 +Subproject 8c6eaead6e8ffd9b575aea8d9288d85c81bd441 diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git -Subproject 157b14a23b18b26fe829dce02233696e19e5a7a +Subproject d84a71a00fac49967abfb85c8b757e78d5b9d36 diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git -Subproject bd249555205f49522ef51d8744dd31dd76e0ccd +Subproject fd70bf257e2ade9fbf28c3714f7adae29bedbd1 diff --git a/docs/submodules/modeling/etsicatalog.git b/docs/submodules/modeling/etsicatalog.git -Subproject 0c5f51257800d53f38bed548bf3d644b85793b9 +Subproject 1487db0615f16783fd01998a0f71fb2d8f97a43 diff --git a/docs/submodules/modeling/modelspec.git b/docs/submodules/modeling/modelspec.git -Subproject 1fd426157cb65e7586ef5230a3065765ede0de2 +Subproject 527261b99506f84906f1f72a9103d5d913d92a7 diff --git a/docs/submodules/multicloud/azure.git b/docs/submodules/multicloud/azure.git -Subproject 7a3a6dd01cf1180bc33b8e6b1224d9cf595dbe5 +Subproject 9cc5757e28d8ef6a6fce936c4d050722f8641a6 diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git -Subproject 0a542045a647da97f24b22ef41e422edac30ed9 +Subproject 35111a07986a76e53e8e331067a129237ceb596 diff --git a/docs/submodules/multicloud/k8s.git b/docs/submodules/multicloud/k8s.git -Subproject 90e13d101cf0d695058876ea53cdcf335dcb2ca +Subproject 38df1b0ee0f1d6cd3bf11f94adf7c952f32c191 diff --git a/docs/submodules/music.git b/docs/submodules/music.git -Subproject 712f0dddc791f9ef8283fb40b5b5f326bc4ea0d +Subproject a7512128b6eb91ac745dc6130a841910e31eb41 diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git -Subproject ac651828821791f9475d997e1f55658b3662c18 +Subproject 62cb98b8def94cd365d2f19b5daac596e546f5b diff --git a/docs/submodules/oom/offline-installer.git b/docs/submodules/oom/offline-installer.git -Subproject 711a2cc42376472c6788bf2d18bf31f39792e55 +Subproject f1d9816984b695fc4ae6a011c23c5f274385070 diff --git a/docs/submodules/optf/cmso.git b/docs/submodules/optf/cmso.git -Subproject 29482785f9e18a1100fe0ea4695dfaf348e60aa +Subproject 906b7987ef35115366a07af11e40ddad7462794 diff --git a/docs/submodules/optf/has.git b/docs/submodules/optf/has.git -Subproject 920b9ff54e4b75973b27438158030c5a4736ffc +Subproject 125fece82e5649ca47de3bbfcbd80ce754e21fd diff --git a/docs/submodules/optf/osdf.git b/docs/submodules/optf/osdf.git -Subproject 998f35e5100014b9d639e52020a70ff4db53ddd +Subproject 680cab955f1d746117c14ee21396ffc53a19664 diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git -Subproject 6948fd05228982459ead8609f4bea3097c860fb +Subproject 9a03ea31d42b8a73c3aa8f96bbad85093cb169a diff --git a/docs/submodules/policy/parent.git b/docs/submodules/policy/parent.git -Subproject 81c8b33fc9dc16cd9bb4ec885673451e773a117 +Subproject afb51f1a2acc1abc3254a72aed47cb2e86904d0 diff --git a/docs/submodules/portal.git b/docs/submodules/portal.git -Subproject c47ea589f9d89d6b57aae48149a5a67b5bf6c95 +Subproject 6e50276a42ab82cfe34ced9cf97e545283f37f2 diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git -Subproject f0178710c8a578fcdc46379d44ccdaaf193ae23 +Subproject 32f485b151dba9e40e6b1171c246bf8f3e9c8fc diff --git a/docs/submodules/sdc/sdc-distribution-client.git b/docs/submodules/sdc/sdc-distribution-client.git -Subproject 1d06b5460988b37169ca4bddead02e9d2d1f9fc +Subproject 0aae60b7882b816a6a7e32d4a91339935d61ff6 diff --git a/docs/submodules/sdc/sdc-docker-base.git b/docs/submodules/sdc/sdc-docker-base.git -Subproject 7e176728c4257acaf877c82b498434097f488ec +Subproject 2638324412de94f4dba352b7c2ba70d4b9764b9 diff --git a/docs/submodules/sdc/sdc-tosca.git b/docs/submodules/sdc/sdc-tosca.git -Subproject 05cf69fe6a8a884c2553d7b3ed5b1d2d5c8335b +Subproject f96d68dfcdd7d15b0ea04603bcf754bde887503 diff --git a/docs/submodules/sdc/sdc-workflow-designer.git b/docs/submodules/sdc/sdc-workflow-designer.git -Subproject 914b8bdf478b899539d22e27983adb26d2c134b +Subproject 9e8232ba85d25e1883e83cdd0d61eeeade45e5f diff --git a/docs/submodules/sdnc/oam.git b/docs/submodules/sdnc/oam.git -Subproject 15ca43491e1cd9adfc6c640bfab5c7dce260894 +Subproject b5cd53a8da9d5a4707875e97d6975097217e954 diff --git a/docs/submodules/so.git b/docs/submodules/so.git -Subproject 6db24e72ecbf4f5c63085085c10dc656568b563 +Subproject 4e6227a98b2fe5b3c6ae78f5fc3d4d0553b119c diff --git a/docs/submodules/so/libs.git b/docs/submodules/so/libs.git -Subproject 43e0541c889dff97f1368e0994254e26c2ccbfe +Subproject 1389746c1a81aca1b82a5e1e43d25a2d6e8c922 diff --git a/docs/submodules/usecase-ui.git b/docs/submodules/usecase-ui.git -Subproject 67e32a3411851851185bdc22320687c317ea35b +Subproject 324c150c6bc6c81bfc35af23aa865cba2a1fccf diff --git a/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git b/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git -Subproject 642e8fbc86982c89aba28b0adfa801fa54adfdd +Subproject 2da65a06f927039e6f3ee1c440b92b032abaa00 diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git -Subproject ecb8b8004aea0a4509966d801105f8ec60aa6f8 +Subproject b72afcc3d49ecaaa62a7e4634ac493ab446e15d diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git -Subproject b4b88310c73f9faa15bbe8ad0ed6213660f6f52 +Subproject ef8700898bb15a8b2231dcc730f1886a43c8225 diff --git a/docs/submodules/vnfsdk/model.git b/docs/submodules/vnfsdk/model.git -Subproject ff4b57688e0c128bec69fe74ec2cfbd3c689446 +Subproject 6b71b531c0a3cd8dda66d0e43568673dfdaff9a |