001/**
002 * Copyright (C) 2006-2025 Talend Inc. - www.talend.com
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.talend.sdk.component.server.api;
017
018import static javax.ws.rs.core.MediaType.APPLICATION_JSON;
019
020import javax.ws.rs.GET;
021import javax.ws.rs.Path;
022
023import org.eclipse.microprofile.openapi.annotations.Operation;
024import org.eclipse.microprofile.openapi.annotations.media.Content;
025import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
026import org.eclipse.microprofile.openapi.annotations.tags.Tag;
027import org.talend.sdk.component.server.front.model.Environment;
028
029@Path("environment")
030@Tag(name = "Environment", description = "Endpoint giving access to versions and last update timestamp of the server.")
031public interface EnvironmentResource {
032
033    @GET
034    @Operation(operationId = "getEnvironment",
035            description = "Returns the environment information of this instance. " +
036                    "Useful to check the version or configure a healthcheck for the server.")
037    @APIResponse(responseCode = "200",
038            description = "Current environment representation.",
039            content = @Content(mediaType = APPLICATION_JSON))
040    Environment get();
041}