Document current REST API in OpenAPI

[cyrildewit]

Description

Many endpoints tracked in #37 have been implemented, but they're currently not documented in the OpenAPI file. They need to be documented so consumers of our REST API can read how to use the API.

Acceptance criteria

• All resources are documented.
• All endpoints are documented.

Technical outworking

Tasks

Schemas

• [x] GroupResource
• [x] GroupTypeResource
• [x] ReservationResource
• [x] ReperationRequestMaterialResource
• [x] ReperationRequestResource
• [x] Space
• [x] UserResource

Endpoints

Groups

• GET api/v1/groups
  • [x] Summary
  • [x] Description
  • [x] Parameters
  • [x] Responses
  • [x] 200
  • [x] 403
• POST api/v1/groups
  • [x] Summary
  • [x] Description
  • [x] Request body
  • [x] Responses
  • [x] 200
  • [x] 403
  • [x] 422
• PUT api/v1/groups/{id}
  • [x] Summary
  • [x] Description
  • [x] Parameters
  • [x] Request body
  • [x] Responses
  • [x] 200
  • [x] 403
  • [x] 422
• GET api/v1/groups/{id}
  • [x] Summary
  • [x] Description
  • [x] Parameters
  • [x] Responses
  • [x] 200
  • [x] 403
• DELETE api/v1/groups/{id}
  • [x] Summary
  • [x] Description
  • [x] Parameters
  • [x] Responses
  • [x] 200
  • [x] 403

Reparation Request Materials

• GET api/v1/reparation_request_materials
  • [x] Summary
  • [x] Description
  • [x] Parameters
  • [x] Responses
  • [x] 200
  • [x] 403
• POST api/v1/reparation_request_materials
  • [x] Summary
  • [x] Description
  • [x] Request body
  • [x] Responses
  • [x] 200
  • [x] 403
  • [x] 422
• PUT api/v1/reparation_request_materials/{id}
  • [x] Summary
  • [x] Description
  • [x] Parameters
  • [x] Request body
  • [x] Responses
  • [x] 200
  • [x] 403
  • [x] 422
• GET api/v1/reparation_request_materials/{id}
  • [x] Summary
  • [x] Description
  • [x] Parameters
  • [x] Responses
  • [x] 200
  • [x] 403
• DELETE api/v1/reparation_request_materials/{id}
  • [x] Summary
  • [x] Description
  • [x] Parameters
  • [x] Responses
  • [x] 200
  • [x] 403

Reparation Requests

• GET api/v1/reparation_requests
  • [x] Summary
  • [x] Description
  • [x] Parameters
  • [x] Responses
  • [x] 200
  • [x] 403
• POST api/v1/reparation_requests
  • [x] Summary
  • [x] Description
  • [x] Request body
  • [x] Responses
  • [x] 200
  • [x] 403
  • [x] 422
• PUT api/v1/reparation_requests/{id}
  • [x] Summary
  • [x] Description
  • [x] Parameters
  • [x] Request body
  • [x] Responses
  • [x] 200
  • [x] 403
  • [x] 422
• GET api/v1/reparation_requests/{id}
  • [x] Summary
  • [x] Description
  • [x] Parameters
  • [x] Responses
  • [x] 200
  • [x] 403
• DELETE api/v1/reparation_requests/{id}
  • [x] Summary
  • [x] Description
  • [x] Parameters
  • [x] Responses
  • [x] 200
  • [x] 403

[cyrildewit]

We could number our error messages with codes that they can provide to us when they need help, but according to this article it looks like it's not needed. We just have to provide valuable feedback when something goes unexpected. This is something we already keep in mind.