Publish swagger files for SDC APIs
[sdc.git] / openecomp-be / api / openecomp-sdc-rest-webapp / application-config-rest / application-config-rest-services / src / main / java / org / openecomp / sdcrests / applicationconfig / rest / ApplicationConfiguration.java
1 /*-
2  * ============LICENSE_START=======================================================
3  * SDC
4  * ================================================================================
5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6  * ================================================================================
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  * 
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  * 
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.openecomp.sdcrests.applicationconfig.rest;
22
23 import io.swagger.v3.oas.annotations.Operation;
24 import io.swagger.v3.oas.annotations.info.Info;
25 import io.swagger.v3.oas.annotations.media.ArraySchema;
26 import io.swagger.v3.oas.annotations.media.Content;
27 import io.swagger.v3.oas.annotations.media.Schema;
28 import io.swagger.v3.oas.annotations.responses.ApiResponse;
29 import io.swagger.v3.oas.annotations.tags.Tag;
30 import io.swagger.v3.oas.annotations.tags.Tags;
31 import org.apache.cxf.jaxrs.ext.multipart.Multipart;
32 import org.openecomp.sdcrests.applicationconfiguration.types.ApplicationConfigDto;
33 import org.openecomp.sdcrests.applicationconfiguration.types.ConfigurationDataDto;
34 import org.openecomp.sdcrests.wrappers.GenericCollectionWrapper;
35 import org.springframework.validation.annotation.Validated;
36
37 import javax.ws.rs.*;
38 import javax.ws.rs.core.MediaType;
39 import javax.ws.rs.core.Response;
40 import java.io.InputStream;
41 import java.util.List;
42
43 @Path("/v1.0/application-configuration")
44 @Produces(MediaType.APPLICATION_JSON)
45 @Consumes(MediaType.APPLICATION_JSON)
46 @Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Application Configuration")})
47 @Validated
48 public interface ApplicationConfiguration {
49
50   @POST
51   @Path("/")
52   @Consumes(MediaType.MULTIPART_FORM_DATA)
53   @Operation(description = "Insert JSON schema into application config table")
54   Response insertToTable(@QueryParam("namespace") String namespace, @QueryParam("key") String key,
55                          @Multipart("description") InputStream fileContainingSchema);
56
57
58   @GET
59   @Path("/{namespace}/{key}")
60   @Operation(description = "Get JSON schema by namespace and key", responses = @ApiResponse(content = @Content(schema = @Schema(implementation = ConfigurationDataDto.class))))
61   Response getFromTable(@PathParam("namespace") String namespace, @PathParam("key") String key);
62
63
64   @GET
65   @Path("/{namespace}")
66   @Operation(description = "Get List of keys and descriptions by namespace", responses = @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = ApplicationConfigDto.class)))))
67   Response getListOfConfigurationByNamespaceFromTable(@PathParam("namespace") String namespace);
68
69 }