diff options
author | 2022-12-01 15:24:57 +0000 | |
---|---|---|
committer | 2022-12-06 12:53:44 +0000 | |
commit | cf5af3fd2e67b0aef402114a0f3ae263fdfc7efe (patch) | |
tree | 844e1f34ffe75187e1a76ebbfe724874f2dba188 /participant/participant-impl/participant-impl-kubernetes/src/main | |
parent | 7af90cd8fdabdd1c3ae79d3551980016d6b24f7e (diff) |
Replace SpringFox with SpringDoc in CLAMP
This commit:
- Remove springfox from CLAMP
- updates the commissioning, AC Element, and K8S particiapnt to use the
generated interface rather than the hard coded one
- removes swagger annotations from handwritten code
- implements SpringDoc for the <base_path>/v3/api-docs on endpoints
Issue-ID: POLICY-4404
Change-Id: I49f48bc7828cb49dab854ef9ed16a9aa377983e1
Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'participant/participant-impl/participant-impl-kubernetes/src/main')
-rw-r--r-- | participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/configurations/SpringDocBean.java (renamed from participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/configurations/SpringFoxConfig.java) | 29 | ||||
-rw-r--r-- | participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/controller/ChartController.java | 105 | ||||
-rw-r--r-- | participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceException.java | 4 | ||||
-rw-r--r-- | participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceRuntimeException.java | 37 | ||||
-rw-r--r-- | participant/participant-impl/participant-impl-kubernetes/src/main/resources/openapi/openapi.yaml | 494 |
5 files changed, 597 insertions, 72 deletions
diff --git a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/configurations/SpringFoxConfig.java b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/configurations/SpringDocBean.java index cfa98bd65..17e1b16d1 100644 --- a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/configurations/SpringFoxConfig.java +++ b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/configurations/SpringDocBean.java @@ -1,6 +1,6 @@ /*- * ============LICENSE_START======================================================= - * Copyright (C) 2021 Nordix Foundation. + * Copyright (C) 2021-2022 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,26 +20,29 @@ package org.onap.policy.clamp.acm.participant.kubernetes.configurations; -import org.onap.policy.clamp.acm.participant.kubernetes.controller.ChartController; +import io.swagger.v3.oas.models.ExternalDocumentation; +import io.swagger.v3.oas.models.OpenAPI; +import io.swagger.v3.oas.models.info.Info; +import io.swagger.v3.oas.models.info.License; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; -import springfox.documentation.builders.PathSelectors; -import springfox.documentation.builders.RequestHandlerSelectors; -import springfox.documentation.spi.DocumentationType; -import springfox.documentation.spring.web.plugins.Docket; @Configuration -public class SpringFoxConfig { +public class SpringDocBean { /** - * Docket Spring Fox Config. + * Bean to configure Springdoc. * - * @return Docket + * @return the OpenAPI specification */ @Bean - public Docket api() { - return new Docket(DocumentationType.SWAGGER_2).select() - .apis(RequestHandlerSelectors.basePackage(ChartController.class.getPackageName())) - .paths(PathSelectors.any()).build(); + public OpenAPI kubernetesParticipantOpenApi() { + return new OpenAPI() + .info(new Info().title("ACM Kubernetes Participant") + .description("CLAMP Automation Composition Management Kubernetes Participant API") + .license(new License().name("Apache 2.0").url("http://www.apache.org/licenses/LICENSE-2.0"))) + .externalDocs(new ExternalDocumentation() + .description("CLAMP Automation Composition Management Documentation") + .url("https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/clamp.html")); } } diff --git a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/controller/ChartController.java b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/controller/ChartController.java index 1186b7bf5..3928dd4f8 100644 --- a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/controller/ChartController.java +++ b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/controller/ChartController.java @@ -18,15 +18,14 @@ package org.onap.policy.clamp.acm.participant.kubernetes.controller; -import io.swagger.v3.oas.annotations.Operation; -import io.swagger.v3.oas.annotations.responses.ApiResponse; -import io.swagger.v3.oas.annotations.responses.ApiResponses; -import io.swagger.v3.oas.annotations.tags.Tag; import java.io.IOException; import java.lang.invoke.MethodHandles; import java.util.ArrayList; +import java.util.UUID; import lombok.RequiredArgsConstructor; +import org.onap.policy.clamp.acm.participant.kubernetes.controller.genapi.KubernetesParticipantControllerApi; import org.onap.policy.clamp.acm.participant.kubernetes.exception.ServiceException; +import org.onap.policy.clamp.acm.participant.kubernetes.exception.ServiceRuntimeException; import org.onap.policy.clamp.acm.participant.kubernetes.models.ChartInfo; import org.onap.policy.clamp.acm.participant.kubernetes.models.ChartList; import org.onap.policy.clamp.acm.participant.kubernetes.models.HelmRepository; @@ -38,16 +37,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression; import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; -import org.springframework.web.bind.annotation.DeleteMapping; -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.PathVariable; -import org.springframework.web.bind.annotation.PostMapping; -import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.bind.annotation.RequestParam; -import org.springframework.web.bind.annotation.RequestPart; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.multipart.MultipartFile; @@ -55,8 +46,7 @@ import org.springframework.web.multipart.MultipartFile; @RestController("chartController") @ConditionalOnExpression("${chart.api.enabled:false}") @RequestMapping("helm") -@Tag(name = "k8s-participant") -public class ChartController { +public class ChartController implements KubernetesParticipantControllerApi { private final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); private final ChartService chartService; @@ -68,12 +58,10 @@ public class ChartController { * * @return List of charts installed */ - @GetMapping(path = "/charts", produces = MediaType.APPLICATION_JSON_VALUE) - @Operation(summary = "Return all Charts") - @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "chart List")}) - public ResponseEntity<ChartList> getAllCharts() { + @Override + public ResponseEntity<ChartList> getAllCharts(UUID onapRequestId) { return new ResponseEntity<>(ChartList.builder().charts(new ArrayList<>(chartService.getAllCharts())).build(), - HttpStatus.OK); + HttpStatus.OK); } /** @@ -84,18 +72,18 @@ public class ChartController { * @throws ServiceException in case of error * @throws IOException in case of IO error */ - @PostMapping(path = "/install", consumes = MediaType.APPLICATION_JSON_VALUE, - produces = MediaType.APPLICATION_JSON_VALUE) - @Operation(summary = "Install the chart") - @ApiResponses(value = {@ApiResponse(responseCode = "201", description = "chart Installed")}) - public ResponseEntity<Void> installChart(@RequestBody InstallationInfo info) - throws ServiceException, IOException { + @Override + public ResponseEntity<Void> installChart(UUID onapRequestId, InstallationInfo info) { ChartInfo chart = chartService.getChart(info.getName(), info.getVersion()); if (chart == null) { return new ResponseEntity<>(HttpStatus.NOT_FOUND); } - chartService.installChart(chart); + try { + chartService.installChart(chart); + } catch (ServiceException | IOException e) { + throw new ServiceRuntimeException(e); + } return new ResponseEntity<>(HttpStatus.CREATED); } @@ -107,18 +95,19 @@ public class ChartController { * @return Status of operation * @throws ServiceException in case of error. */ - @DeleteMapping(path = "/uninstall/{name}/{version}", produces = MediaType.APPLICATION_JSON_VALUE) - @Operation(summary = "Uninstall the Chart") - @ApiResponses(value = {@ApiResponse(responseCode = "204", description = "chart Uninstalled")}) - public ResponseEntity<Void> uninstallChart(@PathVariable("name") String name, - @PathVariable("version") String version) throws ServiceException { + @Override + public ResponseEntity<Void> uninstallChart(String name, String version, UUID onapRequestId) { ChartInfo chart = chartService.getChart(name, version); if (chart == null) { return new ResponseEntity<>(HttpStatus.NOT_FOUND); } - chartService.uninstallChart(chart); - return new ResponseEntity<>(HttpStatus.NO_CONTENT); + try { + chartService.uninstallChart(chart); + return new ResponseEntity<>(HttpStatus.NO_CONTENT); + } catch (ServiceException se) { + throw se.asRuntimeException(); + } } /** @@ -131,23 +120,23 @@ public class ChartController { * @throws ServiceException in case of error * @throws IOException in case of IO error */ - @PostMapping(path = "/onboard/chart", consumes = MediaType.MULTIPART_FORM_DATA_VALUE, - produces = MediaType.APPLICATION_JSON_VALUE) - @Operation(summary = "Onboard the Chart") - @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Chart Onboarded")}) - public ResponseEntity<Void> onboardChart(@RequestPart("chart") MultipartFile chartFile, - @RequestParam(name = "values", required = false) MultipartFile overrideFile, - @RequestParam("info") String infoJson) throws ServiceException, IOException { + @Override + public ResponseEntity<Void> onboardChart(MultipartFile chartFile, MultipartFile overrideFile, String infoJson, + UUID onapRequestId) { ChartInfo info; try { info = CODER.decode(infoJson, ChartInfo.class); } catch (CoderException e) { - throw new ServiceException("Error parsing the chart information", e); + throw new ServiceRuntimeException("Error parsing the chart information", e); } - chartService.saveChart(info, chartFile, overrideFile); - return new ResponseEntity<>(HttpStatus.OK); + try { + chartService.saveChart(info, chartFile, overrideFile); + return new ResponseEntity<>(HttpStatus.OK); + } catch (IOException | ServiceException e) { + throw new ServiceRuntimeException(e); + } } /** @@ -157,11 +146,8 @@ public class ChartController { * @param version version of the chart * @return Status of operation */ - @DeleteMapping(path = "/chart/{name}/{version}") - @Operation(summary = "Delete the chart") - @ApiResponses(value = {@ApiResponse(responseCode = "204", description = "Chart Deleted")}) - public ResponseEntity<Void> deleteChart(@PathVariable("name") String name, - @PathVariable("version") String version) { + @Override + public ResponseEntity<Void> deleteChart(String name, String version, UUID onapRequestId) { ChartInfo chart = chartService.getChart(name, version); if (chart == null) { @@ -180,24 +166,25 @@ public class ChartController { * @throws ServiceException in case of error * @throws IOException in case of IO error */ - @PostMapping(path = "/repo", consumes = MediaType.APPLICATION_JSON_VALUE, - produces = MediaType.APPLICATION_JSON_VALUE) - @ApiResponses( - value = {@ApiResponse(responseCode = "201", description = "Repository added"), - @ApiResponse(responseCode = "409", description = "Repository already Exist")}) - public ResponseEntity<String> configureRepo(@RequestBody String repo) - throws ServiceException, IOException { + @Override + public ResponseEntity<String> configureRepo(UUID onapRequestId, String repo) { HelmRepository repository; try { repository = CODER.decode(repo, HelmRepository.class); } catch (CoderException e) { logger.warn("Error parsing the repository information:", e); return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR) - .body("Error parsing the repository information"); + .body("Error parsing the repository information"); } - if (chartService.configureRepository(repository)) { - return new ResponseEntity<>(HttpStatus.CREATED); + + try { + if (chartService.configureRepository(repository)) { + return new ResponseEntity<>(HttpStatus.CREATED); + } else { + return new ResponseEntity<>(HttpStatus.CONFLICT); + } + } catch (ServiceException se) { + throw se.asRuntimeException(); } - return new ResponseEntity<>(HttpStatus.CONFLICT); } } diff --git a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceException.java b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceException.java index 6414f2fa9..f4701e0ac 100644 --- a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceException.java +++ b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceException.java @@ -29,4 +29,8 @@ public class ServiceException extends Exception { public ServiceException(String message, Exception originalException) { super(message, originalException); } + + public ServiceRuntimeException asRuntimeException() { + return new ServiceRuntimeException(this); + } } diff --git a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceRuntimeException.java b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceRuntimeException.java new file mode 100644 index 000000000..9aa2eefa3 --- /dev/null +++ b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceRuntimeException.java @@ -0,0 +1,37 @@ +/*- + * ========================LICENSE_START================================= + * Copyright (C) 2021 Nordix Foundation. All rights reserved. + * ====================================================================== + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ========================LICENSE_END=================================== + */ + +package org.onap.policy.clamp.acm.participant.kubernetes.exception; + +public class ServiceRuntimeException extends RuntimeException { + + + private static final long serialVersionUID = -4702572294307202439L; + + public ServiceRuntimeException(String message) { + super(message); + } + + public ServiceRuntimeException(String message, Exception originalException) { + super(message, originalException); + } + + public ServiceRuntimeException(Exception originalException) { + super(originalException); + } +} diff --git a/participant/participant-impl/participant-impl-kubernetes/src/main/resources/openapi/openapi.yaml b/participant/participant-impl/participant-impl-kubernetes/src/main/resources/openapi/openapi.yaml new file mode 100644 index 000000000..457b66fc9 --- /dev/null +++ b/participant/participant-impl/participant-impl-kubernetes/src/main/resources/openapi/openapi.yaml @@ -0,0 +1,494 @@ +openapi: 3.0.3 +info: + title: ACM Kubernetes Participant + description: CLAMP Automation Composition Management Kubernetes Participant API + contact: + name: ONAP Support + url: https://lists.onap.org/g/onap-discuss + email: onap-discuss@lists.onap.org + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + version: '1.0' +externalDocs: + description: CLAMP Automation Composition Management Documentation + url: https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/clamp.html +tags: + - name: kubernetes-participant-controller + description: Automation Composition Element Test Participant controller +servers: + - url: http:{port}/{server} + variables: + port: + default: "30295" + description: This value is assigned by the service provider + server: + default: /onap/policy/clamp/acm/k8sparticipant + description: This value is assigned by the service provider +paths: + /charts: + get: + tags: + - kubernetes-participant-controller + summary: Return all Charts + description: Return all the charts configured in the Kubernetes Participant + operationId: getAllCharts + parameters: + - name: X-onap-RequestId + in: header + description: RequestID for http transaction + schema: + type: string + format: uuid + responses: + 200: + description: OK, reutrns a serialised instance of + [ChartList](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/models/ChartList.java) + headers: + api-version: + schema: + type: string + X-LatestVersion: + schema: + type: string + description: Used only to communicate an API's latest version + X-PatchVersion: + schema: + type: string + description: + Used only to communicate a PATCH version in a response for troubleshooting purposes only, + and will not be provided by the client on request + X-MinorVersion: + schema: + type: string + description: + Used to request or communicate a MINOR version back from the client + to the server, and from the server back to the client + X-onap-RequestId: + schema: + type: string + format: uuid + description: Used to track REST transactions for logging purposes + content: + application/json: + schema: + $ref: '#/components/schemas/ChartList' + application/yaml: + schema: + $ref: '#/components/schemas/ChartList' + 401: + description: Authorization Error + 404: + description: Not Found + 500: + description: Internal Server Error + security: + - basicAuth: [] + /install: + post: + tags: + - kubernetes-participant-controller + summary: Installs a chart + description: >- + Installs a Helm Chart for use by an Automation Composition Element in the Kubernetes Participant + operationId: installChart + parameters: + - name: X-ONAP-RequestID + in: header + description: RequestID for http transaction + required: false + schema: + type: string + format: uuid + requestBody: + description: The installation information for the chart to install in a serialised instance of + [InstallationInfo](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/models/InstallationInfo.java) + content: + application/json: + schema: + $ref: '#/components/schemas/InstallationInfo' + application/yaml: + schema: + $ref: '#/components/schemas/InstallationInfo' + responses: + 201: + description: OK, the Helm chart has been installed + headers: + api-version: + schema: + type: string + X-LatestVersion: + schema: + type: string + description: Used only to communicate an API's latest version + X-PatchVersion: + schema: + type: string + description: + Used only to communicate a PATCH version in a response for troubleshooting purposes only, + and will not be provided by the client on request + X-MinorVersion: + schema: + type: string + description: + Used to request or communicate a MINOR version back from the client + to the server, and from the server back to the client + X-onap-RequestId: + schema: + type: string + format: uuid + description: Used to track REST transactions for logging purposes + 400: + description: Bad Request + 401: + description: Authorization Error + 500: + description: Internal Server Error + security: + - basicAuth: [] + /uninstall/{name}/{version}: + delete: + tags: + - kubernetes-participant-controller + summary: Uninstall a Helm Chart + description: Uninstall a Helm Chart from the helm charts that can be used by an Automation Composition element in the + Kubernetes Participant + operationId: uninstallChart + parameters: + - name: X-onap-RequestId + in: header + description: RequestID for http transaction + schema: + type: string + format: uuid + - name : name + in: path + description: The name of the chart to uninstall + required: true + schema: + type: string + - name : version + in: path + description: The version of the chart to uninstall + required: true + schema: + type: string + responses: + 204: + description: No Content, the chart has been uninstalled + headers: + api-version: + schema: + type: string + X-LatestVersion: + schema: + type: string + description: Used only to communicate an API's latest version + X-PatchVersion: + schema: + type: string + description: + Used only to communicate a PATCH version in a response for troubleshooting purposes only, + and will not be provided by the client on request + X-MinorVersion: + schema: + type: string + description: + Used to request or communicate a MINOR version back from the client + to the server, and from the server back to the client + X-onap-RequestId: + schema: + type: string + format: uuid + description: Used to track REST transactions for logging purposes + 400: + description: Bad Request + 401: + description: Authorization Error + 409: + description: Not Defined, the chart is not defined + headers: + api-version: + schema: + type: string + X-LatestVersion: + schema: + type: string + description: Used only to communicate an API's latest version + X-PatchVersion: + schema: + type: string + description: + Used only to communicate a PATCH version in a response for troubleshooting purposes only, + and will not be provided by the client on request + X-MinorVersion: + schema: + type: string + description: + Used to request or communicate a MINOR version back from the client + to the server, and from the server back to the client + X-onap-RequestId: + schema: + type: string + format: uuid + description: Used to track REST transactions for logging purposes + 500: + description: Internal Server Error + security: + - basicAuth: [] + /onboard/chart: + post: + tags: + - kubernetes-participant-controller + summary: Onboards a chart onto Kubernetes + description: >- + Onboards a Helm Chart onto a Kubernetes Cluster + operationId: onboardChart + parameters: + - name: X-ONAP-RequestID + in: header + description: RequestID for http transaction + required: false + schema: + type: string + format: uuid + requestBody: + required: true + content: + multipart/form-data: + schema: + required: + - chartFile + - info + type: object + properties: + chartFile: + type: string + format: binary + nullable: false + overrideFile: + type: string + format: binary + nullable: true + info: + type: string + description: A JSON or YAML serialized instance of + [ChartInfo](https://github.com/onap/policy-clamp/blob/master/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/models/ChartInfo.java) + encoding: + chartFile: + contentType: application/octet-stream + overrideFile: + contentType: application/octet-stream + info: + contentType: application/json + responses: + 200: + description: OK, the Helm chart has been onboarded + headers: + api-version: + schema: + type: string + X-LatestVersion: + schema: + type: string + description: Used only to communicate an API's latest version + X-PatchVersion: + schema: + type: string + description: + Used only to communicate a PATCH version in a response for troubleshooting purposes only, + and will not be provided by the client on request + X-MinorVersion: + schema: + type: string + description: + Used to request or communicate a MINOR version back from the client + to the server, and from the server back to the client + X-onap-RequestId: + schema: + type: string + format: uuid + description: Used to track REST transactions for logging purposes + 400: + description: Bad Request + 401: + description: Authorization Error + 500: + description: Internal Server Error + security: + - basicAuth: [] + /chart/{name}/{version}: + delete: + tags: + - kubernetes-participant-controller + summary: Delete a Helm Chart + description: Delete a Helm Chart from the helm charts that can be used by an Automation Composition element in the + Kubernetes Participant + operationId: deleteChart + parameters: + - name: X-onap-RequestId + required: false + in: header + description: RequestID for http transaction + schema: + type: string + format: uuid + - name : name + in: path + description: The name of the chart to uninstall + required: true + schema: + type: string + - name : version + in: path + description: The version of the chart to uninstall + required: true + schema: + type: string + responses: + 204: + description: No Content, the chart has been deleted + headers: + api-version: + schema: + type: string + X-LatestVersion: + schema: + type: string + description: Used only to communicate an API's latest version + X-PatchVersion: + schema: + type: string + description: + Used only to communicate a PATCH version in a response for troubleshooting purposes only, + and will not be provided by the client on request + X-MinorVersion: + schema: + type: string + description: + Used to request or communicate a MINOR version back from the client + to the server, and from the server back to the client + X-onap-RequestId: + schema: + type: string + format: uuid + description: Used to track REST transactions for logging purposes + 400: + description: Bad Request + 401: + description: Authorization Error + 409: + description: Not Defined, the chart is not defined + headers: + api-version: + schema: + type: string + X-LatestVersion: + schema: + type: string + description: Used only to communicate an API's latest version + X-PatchVersion: + schema: + type: string + description: + Used only to communicate a PATCH version in a response for troubleshooting purposes only, + and will not be provided by the client on request + X-MinorVersion: + schema: + type: string + description: + Used to request or communicate a MINOR version back from the client + to the server, and from the server back to the client + X-onap-RequestId: + schema: + type: string + format: uuid + description: Used to track REST transactions for logging purposes + 500: + description: Internal Server Error + security: + - basicAuth: [] + /repo: + post: + tags: + - kubernetes-participant-controller + summary: Configure a Helm repository + description: >- + Configure a Helm repository to the Kubernetes Participant, which the participant can then use + operationId: configureRepo + parameters: + - name: X-ONAP-RequestID + in: header + description: RequestID for http transaction + required: false + schema: + type: string + format: uuid + requestBody: + description: The Helm repository to be configured + content: + application/json: + schema: + type: string + application/yaml: + schema: + type: string + responses: + 201: + description: OK, the repository has been configured + headers: + api-version: + schema: + type: string + X-LatestVersion: + schema: + type: string + description: Used only to communicate an API's latest version + X-PatchVersion: + schema: + type: string + description: + Used only to communicate a PATCH version in a response for troubleshooting purposes only, + and will not be provided by the client on request + X-MinorVersion: + schema: + type: string + description: + Used to request or communicate a MINOR version back from the client + to the server, and from the server back to the client + X-onap-RequestId: + schema: + type: string + format: uuid + description: Used to track REST transactions for logging purposes + content: + application/json: + schema: + type: string + example: Success + application/yaml: + schema: + type: string + example: Success + 400: + description: Bad Request + 401: + description: Authorization Error + 409: + description: Conflict, the repository already exists + 500: + description: Internal Server Error + security: + - basicAuth: [] +components: + securitySchemes: + basicAuth: + type: http + scheme: basic + schemas: + ChartList: + title: ChartList + type: object + InstallationInfo: + title: InstallationInfo + type: object |