Implementation of CRUD for Professional Model in API REST

[NathaelB]

We need to implement a CRUD (Create, Read, Update, Delete) system for the Professional model in our API REST. The Professional modal should support listing all professionals, with an optional filter by companyId, and providing the ability to retrieve, create, update and delete indivual professionals. This impelment must follow RESTFul conventions.

Acceptance Criteria:

• All endpoints for the Professional model are implemented following RESTful conventions.
• Authentication and authorization are enforced appropriately for each endpoint.
• All CRUD operations (list, show, create, update, delete) have been tested with both valid and invalid scenarios, covering the different status codes (200, 201, 401, 403, 422).
• The API documentation is updated to reflect the new endpoints.

[NathaelB]

Response Contract for /v1/professionals

The response for the route /v1/professionals is designed to return a paginated list of professionals, along with metadata to facilitate navigation across multiple pages of results.

{
 "meta": {
   "total": 2,
   "perPage": 10,
   "currentPage": 1,
   "lastPage": 1,
   "firstPage": 1,
   "firstPageUrl": "/?page=1",
   "lastPageUrl": "/?page=1",
   "nextPageUrl": null,
   "previousPageUrl": null
 },
 "data": []
}

Description

• meta: Contains pagination-related metadata to help clients navigate through the list of professionals.
• data (Array): An array of professional objects. This array will contain the actual data of professionals being to retrieved for the current page. Each item in the data array represents an individual professional with their relevant details (e.g., id, name, companyId, etc..).

This structure ensures that clients have enough information to handle pagination effectively, making it easier to manage large datasets and providing a consistent way to navigate through records.

[NathaelB]

To create a Professional, you need to use the Keycloak service to register it in our authentication system, obtain its id and insert the result in the oidcId column.