org.projectnessie.api.v2.http.HttpConfigApi Maven / Gradle / Ivy
/*
* Copyright (C) 2022 Dremio
*
* 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.
*/
package org.projectnessie.api.v2.http;
import com.fasterxml.jackson.annotation.JsonView;
import java.util.List;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
import org.eclipse.microprofile.openapi.annotations.Operation;
import org.eclipse.microprofile.openapi.annotations.media.Content;
import org.eclipse.microprofile.openapi.annotations.media.ExampleObject;
import org.eclipse.microprofile.openapi.annotations.media.Schema;
import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
import org.eclipse.microprofile.openapi.annotations.responses.APIResponses;
import org.eclipse.microprofile.openapi.annotations.tags.Tag;
import org.projectnessie.api.v2.ConfigApi;
import org.projectnessie.error.NessieConflictException;
import org.projectnessie.model.NessieConfiguration;
import org.projectnessie.model.RepositoryConfigResponse;
import org.projectnessie.model.UpdateRepositoryConfigRequest;
import org.projectnessie.model.UpdateRepositoryConfigResponse;
import org.projectnessie.model.ser.Views;
@Path("v2/config")
@jakarta.ws.rs.Path("v2/config")
@Tag(name = "v2")
public interface HttpConfigApi extends ConfigApi {
@Override
@GET
@jakarta.ws.rs.GET
@Produces(MediaType.APPLICATION_JSON)
@jakarta.ws.rs.Produces(jakarta.ws.rs.core.MediaType.APPLICATION_JSON)
@Operation(
summary = "Returns repository and server settings relevant to clients.",
operationId = "getConfigV2")
@APIResponses({
@APIResponse(
responseCode = "200",
description = "Configuration settings",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = NessieConfiguration.class),
examples = {@ExampleObject(ref = "nessieConfig")})),
@APIResponse(responseCode = "401", description = "Invalid credentials provided")
})
@JsonView(Views.V2.class)
NessieConfiguration getConfig();
@Override
@GET
@jakarta.ws.rs.GET
@Path("repository")
@jakarta.ws.rs.Path("repository")
@Produces(MediaType.APPLICATION_JSON)
@jakarta.ws.rs.Produces(jakarta.ws.rs.core.MediaType.APPLICATION_JSON)
@Operation(
summary = "Returns repository configurations of the requested types.",
operationId = "getRepositoryConfig")
@APIResponses({
@APIResponse(
responseCode = "200",
content =
@Content(
mediaType = "application/json",
schema =
@Schema(
implementation = RepositoryConfigResponse.class,
title = "Repository configuration objects for the requested types.",
description =
"The existing configuration objects for the requested types will be returned. "
+ "Non-existing config objects will not be returned."))),
@APIResponse(responseCode = "401", description = "Invalid credentials provided")
})
@JsonView(Views.V2.class)
RepositoryConfigResponse getRepositoryConfig(
@QueryParam("type") @jakarta.ws.rs.QueryParam("type") List repositoryConfigTypes);
@Override
@POST
@jakarta.ws.rs.POST
@Path("repository")
@jakarta.ws.rs.Path("repository")
@Produces(MediaType.APPLICATION_JSON)
@jakarta.ws.rs.Produces(jakarta.ws.rs.core.MediaType.APPLICATION_JSON)
@Operation(
summary = "Create or update a repository configuration.",
operationId = "updateRepositoryConfig")
@APIResponses({
@APIResponse(
responseCode = "200",
description =
"The configuration was updated. The response body contains the previous configuration value.",
content =
@Content(
mediaType = "application/json",
schema =
@Schema(
implementation = UpdateRepositoryConfigResponse.class,
title = "The previous state of the repository configuration object.",
description =
"When a repository configuration for the same type as in the request object did not exist, "
+ "the response object will be null. Otherwise, if the configuration was updated, the old "
+ "value will be returned."))),
@APIResponse(responseCode = "401", description = "Invalid credentials provided")
})
@JsonView(Views.V2.class)
UpdateRepositoryConfigResponse updateRepositoryConfig(
UpdateRepositoryConfigRequest repositoryConfigUpdate) throws NessieConflictException;
}