Publish swagger files for SDC APIs
[sdc.git] / openecomp-be / api / openecomp-sdc-rest-webapp / togglz-rest / togglz-rest-services / src / main / java / org / openecomp / sdcrests / togglz / rest / TogglzFeatures.java
1 /*
2  * Copyright © 2016-2017 European Support Limited
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package org.openecomp.sdcrests.togglz.rest;
18
19 import io.swagger.v3.oas.annotations.Operation;
20 import io.swagger.v3.oas.annotations.info.Info;
21 import io.swagger.v3.oas.annotations.media.ArraySchema;
22 import io.swagger.v3.oas.annotations.media.Content;
23 import io.swagger.v3.oas.annotations.media.Schema;
24 import io.swagger.v3.oas.annotations.responses.ApiResponse;
25 import io.swagger.v3.oas.annotations.tags.Tag;
26 import io.swagger.v3.oas.annotations.tags.Tags;
27 import org.openecomp.sdcrests.togglz.types.FeatureDto;
28 import org.openecomp.sdcrests.togglz.types.FeatureSetDto;
29 import org.springframework.validation.annotation.Validated;
30
31 import javax.ws.rs.*;
32 import javax.ws.rs.core.MediaType;
33 import javax.ws.rs.core.Response;
34
35
36 @Path("/v1.0/togglz")
37 @Produces(MediaType.APPLICATION_JSON)
38 @Consumes(MediaType.APPLICATION_JSON)
39 @Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Togglz")})
40 @Validated
41 public interface TogglzFeatures {
42
43   @GET
44   @Operation(description = "Get TOGGLZ Features", responses = @ApiResponse(content = @Content(array = @ArraySchema( schema = @Schema(implementation = FeatureSetDto.class)))))
45   Response getFeatures();
46
47
48   @PUT
49   @Path("/state/{state}")
50   @Operation(description = "Update feature toggle state for all features")
51   Response setAllFeatures(@PathParam("state") boolean state);
52
53
54   @PUT
55   @Path("/{featureName}/state/{state}")
56   @Operation(description = "Update feature toggle state")
57   Response setFeatureState(@PathParam("featureName") String featureName, @PathParam("state") boolean state);
58
59   @GET
60   @Path("/{featureName}/state")
61   @Operation(description = "Get feature toggle state", responses = @ApiResponse(content = @Content(schema = @Schema(implementation = FeatureDto.class))))
62   Response getFeatureState(@PathParam("featureName") String featureName);
63 }