Skip to content

Commit

Permalink
Rename REST API tags annotation
Browse files Browse the repository at this point in the history
  • Loading branch information
hmiguim committed Jul 9, 2024
1 parent 39352e1 commit 007bb13
Show file tree
Hide file tree
Showing 29 changed files with 33 additions and 33 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
@RequestMapping(path = "/api/v2/classification-plans")
@Tag(name = ClassificationPlanController.SWAGGER_ENDPOINT)
public class ClassificationPlanController {
public static final String SWAGGER_ENDPOINT = "v2 classification plans";
public static final String SWAGGER_ENDPOINT = "Classification plan";

@Autowired
HttpServletRequest request;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,7 @@ public Job synchronize(@RequestBody LocalInstance localInstance) {
state = LogEntryState.FAILURE;
throw new RESTException(e);
} finally {
controllerAssistant.registerAction(requestContext.getUser(), state,
controllerAssistant.registerAction(requestContext, state,
RodaConstants.CONTROLLER_LOCAL_INSTANCE_ID_PARAM, localInstance.getId());
}
}
Expand Down Expand Up @@ -451,7 +451,7 @@ public DistributedInstance registerDistributedInstance(
state = LogEntryState.FAILURE;
throw new RESTException(e);
} finally {
controllerAssistant.registerAction(requestContext.getUser(), state,
controllerAssistant.registerAction(requestContext, state,
RodaConstants.CONTROLLER_LOCAL_INSTANCE_ID_PARAM, id);
}
}
Expand Down Expand Up @@ -605,7 +605,7 @@ public ResponseEntity<StreamingResponseBody> remoteActions(
throw new RESTException(e);
} finally {
// register action
controllerAssistant.registerAction(requestContext.getUser(), state, RodaConstants.CONTROLLER_LOCAL_INSTANCE_PARAM,
controllerAssistant.registerAction(requestContext, state, RodaConstants.CONTROLLER_LOCAL_INSTANCE_PARAM,
id);
}
}
Expand Down Expand Up @@ -635,7 +635,7 @@ ResponseEntity<StreamingResponseBody> synchronizationStatus(
throw new RESTException(e);
} finally {
// register action
controllerAssistant.registerAction(requestContext.getUser(), state, RodaConstants.CONTROLLER_LOCAL_INSTANCE_PARAM,
controllerAssistant.registerAction(requestContext, state, RodaConstants.CONTROLLER_LOCAL_INSTANCE_PARAM,
id);
}
}
Expand Down Expand Up @@ -665,7 +665,7 @@ public Job importSyncBundle(
state = LogEntryState.FAILURE;
throw new RESTException(e);
} finally {
controllerAssistant.registerAction(requestContext.getUser(), state,
controllerAssistant.registerAction(requestContext, state,
RodaConstants.CONTROLLER_LOCAL_INSTANCE_PARAM);
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ public AccessToken authenticate(@RequestBody String token) {
state = LogEntryState.FAILURE;
throw new RESTException(e);
} finally {
controllerAssistant.registerAction(requestContext.getUser(), state, RodaConstants.CONTROLLER_ACCESS_KEY_PARAM);
controllerAssistant.registerAction(requestContext, state, RodaConstants.CONTROLLER_ACCESS_KEY_PARAM);
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
@RequestMapping(path = "/api/v2/metrics")
@Tag(name = MetricsController.SWAGGER_ENDPOINT)
public class MetricsController {
public static final String SWAGGER_ENDPOINT = "v2 metrics";
public static final String SWAGGER_ENDPOINT = "Metrics";

@Autowired
MetricsService metricsService;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
@RequestMapping(path = "/api/v2/themes")
@Tag(name = ThemesController.SWAGGER_ENDPOINT)
public class ThemesController {
public static final String SWAGGER_ENDPOINT = "v2 themes";
public static final String SWAGGER_ENDPOINT = "Themes";

@Autowired
ThemeService themeService;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,7 @@

@RestController
@RequestMapping(path = "/api/v2/transfers")
@Tag(name = TransferredResourceController.SWAGGER_ENDPOINT)
public class TransferredResourceController implements TransferredResourceRestService, Exportable {
public static final String SWAGGER_ENDPOINT = "v2 transfers";

@Autowired
private HttpServletRequest request;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
/**
* @author Miguel Guimarães <[email protected]>
*/
@Tag(name = "v2 aips")
@Tag(name = "AIPs")
@RequestMapping(path = "../api/v2/aips")
public interface AIPRestService extends RODAEntityRestService<IndexedAIP> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
/**
* @author Miguel Guimarães <[email protected]>
*/
@Tag(name = "v2 audit logs")
@Tag(name = "Audit logs")
@RequestMapping(path = "../api/v2/audit-logs")
public interface AuditLogRestService extends RODAEntityRestService<LogEntry> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
/**
* @author Miguel Guimarães <[email protected]>
*/
@Tag(name = "v2 configurations")
@Tag(name = "Configurations")
@RequestMapping(path = "../api/v2/configurations")
public interface ConfigurationRestService extends DirectRestService {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/**
* @author Miguel Guimarães <[email protected]>
*/
@Tag(name = "v2 dip files")
@Tag(name = "DIP files")
@RequestMapping(path = "../api/v2/dip-files")
public interface DIPFileRestService extends RODAEntityRestService<DIPFile> {
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
/**
* @author Miguel Guimarães <[email protected]>
*/
@Tag(name = "v2 dips")
@Tag(name = "DIPs")
@RequestMapping(path = "../api/v2/dips")
public interface DIPRestService extends RODAEntityRestService<IndexedDIP> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
* @author Miguel Guimarães <[email protected]>
*/

@Tag(name = "v2 disposal confirmations")
@Tag(name = "Disposal confirmations")
@RequestMapping(path = "../api/v2/disposal/confirmations")
public interface DisposalConfirmationRestService extends RODAEntityRestService<DisposalConfirmation> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* @author Miguel Guimaraes <mguimarã[email protected]>
*/

@Tag(name = "v2 disposal holds")
@Tag(name = "Disposal holds")
@RequestMapping(path = "../api/v2/disposal/holds")
public interface DisposalHoldRestService extends DirectRestService {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
/**
* @author Miguel Guimarães <[email protected]>
*/
@Tag(name = "v2 disposal rules")
@Tag(name = "Disposal rules")
@RequestMapping(path = "../api/v2/disposal/rules")
public interface DisposalRuleRestService extends DirectRestService {
@RequestMapping(method = RequestMethod.GET, path = "", produces = MediaType.APPLICATION_JSON_VALUE)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
/**
* @author Miguel Guimarães <[email protected]>
*/
@Tag(name = "v2 disposal schedules")
@Tag(name = "Disposal schedules")
@RequestMapping(path = "../api/v2/disposal/schedules")
public interface DisposalScheduleRestService extends DirectRestService {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
/**
* @author António Lindo <[email protected]>
*/
@Tag(name = "v2 distributed instances")
@Tag(name = "Distributed instances")
@RequestMapping(path = "../api/v2/distributed-instances")
public interface DistributedInstancesRestService extends DirectRestService {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
/**
* @author Miguel Guimarães <[email protected]>
*/
@Tag(name = "v2 files")
@Tag(name = "Files")
@RequestMapping(path = "../api/v2/files")
public interface FileRestService extends RODAEntityRestService<IndexedFile> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
/**
* @author António Lindo <[email protected]>
*/
@Tag(name = "v2 job reports")
@Tag(name = "Job reports")
@RequestMapping(path = "../api/v2/job-reports")
public interface JobReportRestService extends RODAEntityRestService<IndexedReport> {
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* @author António Lindo <[email protected]>
*/

@Tag(name = "v2 jobs")
@Tag(name = "Jobs")
@RequestMapping(path = "../api/v2/jobs")
public interface JobsRestService extends RODAEntityRestService<Job> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
/**
* @author António Lindo <[email protected]>
*/
@Tag(name = "v2 members")
@Tag(name = "Members")
@RequestMapping(path = "../api/v2/members")
public interface MembersRestService extends RODAEntityRestService<RODAMember> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;

@Tag(name = "v2 notifications")
@Tag(name = "Notifications")
@RequestMapping(path = "../api/v2/notifications")
public interface NotificationRestService extends RODAEntityRestService<Notification> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
/**
* @author Miguel Guimarães <[email protected]>
*/
@Tag(name = "v2 preservation agents")
@Tag(name = "Preservation agents")
@RequestMapping(path = "../api/v2/preservation/agents")
public interface PreservationAgentRestService extends RODAEntityRestService<IndexedPreservationAgent> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
/**
* @author Miguel Guimarães <[email protected]>
*/
@Tag(name = "v2 preservation events")
@Tag(name = "Preservation events")
@RequestMapping(path = "../api/v2/preservation/events")
public interface PreservationEventRestService extends RODAEntityRestService<IndexedPreservationEvent> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
/**
* @author Miguel Guimarães <[email protected]>
*/
@Tag(name = "v2 representation information")
@Tag(name = "Representation information")
@RequestMapping(path = "../api/v2/representation-information")
public interface RepresentationInformationRestService extends RODAEntityRestService<RepresentationInformation> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* @author António Lindo <[email protected]>
*/
@Tag(name = "v2 representations")
@Tag(name = "Representations")
@RequestMapping(path = "../api/v2/representations")
public interface RepresentationRestService extends RODAEntityRestService<IndexedRepresentation> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
* @author Carlos Afonso <[email protected]>
*/

@Tag(name = "v2 incidences")
@Tag(name = "Incidences")
@RequestMapping(path = "../api/v2/incidences")
public interface RiskIncidenceRestService extends RODAEntityRestService<RiskIncidence> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
* @author Carlos Afonso <[email protected]>
*/

@Tag(name = "v2 risks")
@Tag(name = "Risks")
@RequestMapping(path = "../api/v2/risks")
public interface RiskRestService extends RODAEntityRestService<IndexedRisk> {
@RequestMapping(path = "/delete", method = RequestMethod.POST)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
/**
* @author António Lindo <[email protected]>
*/
@Tag(name = "v2 transfers")
@Tag(name = "Transfers")
@RequestMapping(path = "../api/v2/transfers")
public interface TransferredResourceRestService extends RODAEntityRestService<TransferredResource> {

Expand Down
2 changes: 2 additions & 0 deletions roda-ui/roda-wui/src/main/resources/application.properties
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ logging.level.org.springframework.security=DEBUG
spring.servlet.multipart.max-file-size=-1
spring.servlet.multipart.max-request-size=-1

server.forward-headers-strategy=NATIVE

# spring-docs
springdoc.swagger-ui.enabled=false
springdoc.api-docs.enabled=true
Expand Down

0 comments on commit 007bb13

Please sign in to comment.