diff options
| author |   MichaelMorris <michael.morris@est.tech> | 2021-03-18 11:40:48 +0000 |
|---|---|---|
| committer | MichaelMorris <michael.morris@est.tech> | 2021-03-19 23:44:05 +0000 |
| commit | e020ca3c855ec9555213abfdd89e14d72310177d (patch) | |
| tree | fc8628575130e8428a23b2b9b1db7a251e1c73f8 /catalog-be/src/main/resources | |
| parent | b1fc8c337d3b9750eff6e62b626c0bc3a1467a88 (diff) | |
Publish swagger files for SDC APIs
I have created a swagger file for each of the APIs as they are currently listed on the architecture page. Some of the files can be easily be combined if some of the APIs are combined. I have created a single file for SDCE-2 and SDCE-5 as it is not possible to seperate as they are both paritially implemented in the same class with overlapping paths
I have copied the generated swagger files to the docs directory as I suspect they need to be under source control for the generation of the readthedocs page
Signed-off-by: MichaelMorris <michael.morris@est.tech>
Issue-ID: SDC-3525
Change-Id: Id42412704311a573e3ebf911ad34d909c1c3f1b2
Diffstat (limited to 'catalog-be/src/main/resources')
4 files changed, 84 insertions, 0 deletions
diff --git a/catalog-be/src/main/resources/swagger-config/sdce-2-sdce-5.yaml b/catalog-be/src/main/resources/swagger-config/sdce-2-sdce-5.yaml new file mode 100644 index 0000000000..d4bc0a640d --- /dev/null +++ b/catalog-be/src/main/resources/swagger-config/sdce-2-sdce-5.yaml @@ -0,0 +1,21 @@ +resourcePackages: +- org.openecomp.sdc.be.servlets +ignoredRoutes: +- /v1/catalog/{componentCollection}/{componentId}/lifecycleState/{lifecycleOperation} +prettyPrint: true +sortOutput: true +openAPI: + info: + title: "SPC API: SDCE-2 and SDCE-5" + description: "SDC API for designing services and resources (SDCE-2) and distributing services (SDCE-5)" + contact: + name: ONAP + url: https://onap.readthedocs.io + email: onap-discuss@lists.onap.org + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + version: "1.0" + servers: + - url: /sdc + description: "SDCE-2 and SDCE-5 APIs"
\ No newline at end of file diff --git a/catalog-be/src/main/resources/swagger-config/sdce-4.yaml b/catalog-be/src/main/resources/swagger-config/sdce-4.yaml new file mode 100644 index 0000000000..706d047e69 --- /dev/null +++ b/catalog-be/src/main/resources/swagger-config/sdce-4.yaml @@ -0,0 +1,19 @@ +resourceClasses: +- org.openecomp.sdc.be.servlets.LifecycleServlet +prettyPrint: true +sortOutput: true +openAPI: + info: + title: "SPC API: SDCE-4" + description: "SDC API for certifying services (SDCE-4)" + contact: + name: ONAP + url: https://onap.readthedocs.io + email: onap-discuss@lists.onap.org + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + version: "1.0" + servers: + - url: /sdc + description: "SDCE-4 APIs"
\ No newline at end of file diff --git a/catalog-be/src/main/resources/swagger-config/sdce-6.yaml b/catalog-be/src/main/resources/swagger-config/sdce-6.yaml new file mode 100644 index 0000000000..442ba1766b --- /dev/null +++ b/catalog-be/src/main/resources/swagger-config/sdce-6.yaml @@ -0,0 +1,19 @@ +resourceClasses: +- org.openecomp.sdc.be.distribution.servlet.DistributionServlet +prettyPrint: true +sortOutput: true +openAPI: + info: + title: "SPC API: SDCE-6" + description: "SDC API for distribution subscription (SDCE-6)" + contact: + name: ONAP + url: https://onap.readthedocs.io + email: onap-discuss@lists.onap.org + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + version: "1.0" + servers: + - url: /sdc + description: "SDCE-6 APIs"
\ No newline at end of file diff --git a/catalog-be/src/main/resources/swagger-config/sdce-7.yaml b/catalog-be/src/main/resources/swagger-config/sdce-7.yaml new file mode 100644 index 0000000000..074ca54731 --- /dev/null +++ b/catalog-be/src/main/resources/swagger-config/sdce-7.yaml @@ -0,0 +1,25 @@ +resourcePackages: +- org.openecomp.sdc.be.externalapi.servlet +- org.openecomp.sdc.be.distribution.servlet +ignoredRoutes: +- /v1/distributionUebCluster +- /v1/registerForDistribution +- /v1/artifactTypes +- /v1/unRegisterForDistribution +prettyPrint: true +sortOutput: true +openAPI: + info: + title: "SPC API: SDCE-7" + description: "SDC API for retrieval for service models (SDCE-7)" + contact: + name: ONAP + url: https://onap.readthedocs.io + email: onap-discuss@lists.onap.org + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + version: "1.0" + servers: + - url: /sdc + description: "SDCE-7 APIs"
\ No newline at end of file |