[Ticket]: Implement JSON:API include Field

[danielschuster-muc]

Project

API (api.potterdb.com)

Describe the ticket you want to create

To enhance our API's flexibility, we want to introduce support for the JSON:API include field. This feature allows users to request related resources in a single API call, reducing the number of requests needed for complex data retrieval.

If you have any questions or concerns regarding this enhancement, reach out to me below.

Acceptance Criteria

• [ ] Modify our Ruby on Rails API, specifically using stas/jsonapi.rb, to support the include field for related resource inclusion.
• [ ] Update our REST API documentation to reflect the new functionality.
• [ ] Ensure that our OpenAPI documentation is consistent with the updated API behavior by updating the corresponding specs.

Additional Details

No response

Screenshots

No response

Logs

No response

[danielschuster-muc]

Not relevant at the moment.