com.quorum.tessera.api.common.VersionResource Maven / Gradle / Ivy

Go to download
package com.quorum.tessera.api.common;

import com.quorum.tessera.api.Version;
import com.quorum.tessera.version.ApiVersion;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.ExampleObject;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.tags.Tags;
import jakarta.json.Json;
import jakarta.json.JsonArray;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;

/** Provides endpoints to determine versioning information */
@Tags({@Tag(name = "quorum-to-tessera"), @Tag(name = "peer-to-peer"), @Tag(name = "third-party")})
@Path("/")
public class VersionResource {

  private final Version version;

  public VersionResource(Version version) {
    this.version = version;
  }

  public VersionResource() {
    this(new Version() {});
  }

  @Deprecated
  @Operation(summary = "/version", description = "Tessera distribution version")
  @ApiResponse(
      responseCode = "200",
      description = "Tessera distribution version",
      content =
          @Content(schema = @Schema(type = "string"), examples = @ExampleObject(value = "20.10.1")))
  @GET
  @Path("version")
  @Produces(MediaType.TEXT_PLAIN)
  public String getVersion() {
    return version.version();
  }

  @Operation(summary = "/version/distribution", description = "Tessera distribution version")
  @ApiResponse(
      responseCode = "200",
      description = "Tessera distribution version",
      content =
          @Content(schema = @Schema(type = "string"), examples = @ExampleObject(value = "20.10.1")))
  @GET
  @Path("version/distribution")
  @Produces(MediaType.TEXT_PLAIN)
  public String getDistributionVersion() {
    return version.version();
  }

  @Operation(
      summary = "/version/api",
      operationId = "getApiVersions",
      description = "list currently available API versions")
  @ApiResponse(
      responseCode = "200",
      description = "list of available API versions",
      content =
          @Content(
              mediaType = MediaType.APPLICATION_JSON,
              array = @ArraySchema(schema = @Schema(type = "string")),
              examples = @ExampleObject("[\"1.0\",\"2.0\"]")))
  @GET
  @Path("version/api")
  @Produces(MediaType.APPLICATION_JSON)
  public JsonArray getVersions() {

    List versions =
        ApiVersion.versions().stream()
            .map(v -> v.replaceFirst("v", ""))
            .map(Double::parseDouble)
            .sorted()
            .map(Objects::toString)
            .collect(Collectors.toList());

    return Json.createArrayBuilder(versions).build();
  }
}