Package nl.janboonen.oas.contractfirstdesign.assistant.adapter.controller

Interface AssistantApi

All Known Implementing Classes:

OfficeAssistantRestAdapter

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2023-12-14T17:23:58.964175032Z[Etc/UTC]")
@Validated
public interface AssistantApi

Method Summary

Modifier and Type	Method	Description
CompletableFuture<List<AssistantSummaryModel>>	getActiveAssistants()	GET /assistants : Get an overview of all active assistants
CompletableFuture<AssistantModel>	getAssistantById(String id)	GET /assistants/{id} : Get all details of an assistant
CompletableFuture<Void>	requestOfficeAssistant(@Valid AssistantRequestModel assistantRequestModel)	POST /assistants : Request a new office assistant

Method Details

getActiveAssistants

@RequestMapping(method=GET,
                value="/assistants",
                produces="application/json")
@ResponseStatus(OK)
CompletableFuture<List<AssistantSummaryModel>> getActiveAssistants()

GET /assistants : Get an overview of all active assistants

Returns:

TODO (status code 200)

getAssistantById

@RequestMapping(method=GET,
                value="/assistants/{id}",
                produces="application/json")
@ResponseStatus(OK)
CompletableFuture<AssistantModel> getAssistantById(@PathVariable("id")
 String id)

GET /assistants/{id} : Get all details of an assistant

Parameters:

id - (required)

Returns:

TODO (status code 200)

requestOfficeAssistant

@RequestMapping(method=POST,
                value="/assistants",
                consumes="application/json")
@ResponseStatus(NO_CONTENT)
CompletableFuture<Void> requestOfficeAssistant(@Valid @RequestBody(required=false)
 @Valid AssistantRequestModel assistantRequestModel)

POST /assistants : Request a new office assistant

Parameters:

assistantRequestModel - (optional)

Returns:

TODO (status code 204)