EpochController.java

package org.cardanofoundation.explorer.api.controller;

import jakarta.validation.Valid;

import lombok.RequiredArgsConstructor;

import org.springframework.data.domain.Sort;

import org.springframework.http.ResponseEntity;

import org.springframework.validation.annotation.Validated;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import io.swagger.v3.oas.annotations.Operation;

import io.swagger.v3.oas.annotations.Parameter;

import io.swagger.v3.oas.annotations.tags.Tag;

import org.springdoc.core.annotations.ParameterObject;

import org.cardanofoundation.explorer.api.config.LogMessage;

import org.cardanofoundation.explorer.api.model.response.BaseFilterResponse;

import org.cardanofoundation.explorer.api.model.response.BlockFilterResponse;

import org.cardanofoundation.explorer.api.model.response.EpochResponse;

import org.cardanofoundation.explorer.api.model.response.dashboard.EpochSummary;

import org.cardanofoundation.explorer.api.service.BlockService;

import org.cardanofoundation.explorer.api.service.EpochService;

import org.cardanofoundation.explorer.common.validation.pagination.Pagination;

import org.cardanofoundation.explorer.common.validation.pagination.PaginationDefault;

import org.cardanofoundation.explorer.common.validation.pagination.PaginationValid;

@RestController

@RequestMapping("/api/v1/epochs")

@Validated

@Tag(name = "epoch", description = "The epoch APIs")

public class EpochController {

  private final EpochService epochService;

  private final BlockService blockService;

  @GetMapping("/{no}")

  @LogMessage

  @Operation(

      summary = "Get summary information of epoch by its number",

      tags = {"epoch"})

  public ResponseEntity<EpochResponse> getEpochDetail(

      @PathVariable @Parameter(description = "The epoch number") String no) {

  }

  @GetMapping("/{no}/blocks")

  @LogMessage

  @Operation(

      summary = "Get block list of epoch by its number",

      tags = {"epoch"})

  public ResponseEntity<BaseFilterResponse<BlockFilterResponse>> getBlockList(

      @PathVariable @Parameter(description = "The epoch number") String no,

      @ParameterObject

          @PaginationValid

          @PaginationDefault(

              size = 20,

              sort = {"id"},

              direction = Sort.Direction.DESC)

          @Valid

          Pagination pagination) {

  }

  @GetMapping

  @LogMessage

  @Operation(

      summary = "Get all epoch",

      tags = {"epoch"})

  public ResponseEntity<BaseFilterResponse<EpochResponse>> filter(

      @ParameterObject

          @PaginationValid

          @PaginationDefault(

              size = 20,

              sort = {"id"},

              direction = Sort.Direction.DESC)

          @Valid

          Pagination pagination) {

  }

  @GetMapping("/current")

  @LogMessage

  @Operation(

      summary = "Get information of current epoch",

      tags = {"epoch"})

  public ResponseEntity<EpochSummary> findCurrentEpoch() {

  }

}

Mutations