org.lockss.laaws.mdq.api.MetadataApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of laaws-metadata-service Show documentation
LOCKSS Metadata Service
The newest version!
/**
 * NOTE: This class is auto generated by the swagger code generator program (3.0.52).
 * https://github.com/swagger-api/swagger-codegen
 * Do not edit the class manually.
 */
package org.lockss.laaws.mdq.api;

import org.lockss.laaws.mdq.model.AuMetadataPageInfo;
import org.lockss.laaws.mdq.model.ErrorResult;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RequestPart;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.bind.annotation.CookieValue;

import jakarta.validation.Valid;
import jakarta.validation.constraints.*;
import java.util.List;
import java.util.Map;


@Validated
public interface MetadataApi {

    MetadataApiDelegate getDelegate();

    @Operation(summary = "Get the metadata stored for an AU", description = "Get the full metadata stored for an AU given the AU identifier or a pageful of the metadata defined by the continuation token and size", security = {
        @SecurityRequirement(name = "basicAuth")    }, tags={ "metadata" })
    @ApiResponses(value = { 
        @ApiResponse(responseCode = "200", description = "The metadata of the specified AU", content = @Content(mediaType = "application/json", schema = @Schema(implementation = AuMetadataPageInfo.class))),
        
        @ApiResponse(responseCode = "200", description = "The resulting error payload.", content = @Content(mediaType = "application/json", schema = @Schema(implementation = ErrorResult.class))) })
    @RequestMapping(value = "/metadata/aus/{auid}",
        produces = { "application/json" }, 
        method = RequestMethod.GET)
    default ResponseEntity getMetadataAusAuid(@Parameter(in = ParameterIn.PATH, description = "The identifier of the AU for which the metadata is requested", required=true, schema=@Schema()) @PathVariable("auid") String auid
, @Parameter(in = ParameterIn.QUERY, description = "The number of items per page" ,schema=@Schema( defaultValue="50")) @Valid @RequestParam(value = "limit", required = false, defaultValue="50") Integer limit
, @Parameter(in = ParameterIn.QUERY, description = "The continuation token of the next page of metadata to be returned" ,schema=@Schema()) @Valid @RequestParam(value = "continuationToken", required = false) String continuationToken
) {
        return getDelegate().getMetadataAusAuid(auid, limit, continuationToken);
    }

}