Introduces response options for room-related API calls, allowing clients to specify which fields to include and which properties to expand.
This change provides more control over the data returned by the API,
reducing payload size and improving performance.
It also fixes an issue where the frontend was not able to request only the fields needed for specific components.
Moves shared type definitions from backend models to the `typings` package.
This change centralizes type definitions, improving code maintainability
and consistency across the project. It removes duplicated type
definitions in backend and uses shared types from `typings` package
instead.
Implements permission-based filtering to restrict access to sensitive room information.
This ensures that only authorized users can view specific fields based on their assigned permissions.
Refactors repository methods to accept an array of fields
instead of a comma-separated string, optimizing data retrieval
and reducing unnecessary string manipulation. Also, modifies
services and validators to use array of fields instead of strings.
Adds functionality to control the room creation and retrieval responses
using the `X-Fields` and `X-Expand` headers.
- `X-Fields` allows clients to specify which fields to include in the
response, optimizing bandwidth usage.
- `X-Expand` allows clients to request the full data of expandable
properties, such as `config`, avoiding subsequent GET requests.
This change introduces new request validators, service methods, and
helper functions to handle the header logic and process the room objects accordingly.
Introduces filtering capabilities for room and recording list endpoints.
This allows users to query rooms and recordings based on various criteria such as name, status, and other relevant properties.
It also implements expansion support for room properties, enabling retrieval of full object details instead of stubs.
The changes include:
- Defines data models for room and recording filter requests.
- Updates Zod schemas for robust input validation.
- Implements logic for collapsing and expanding room properties, improving API response structure and efficiency.
Implements expandable properties for room responses to reduce payload size.
Introduces an `expand` query parameter to control which complex properties, like `config`, are included in the response. By default, these properties are replaced with a stub containing a HATEOAS link to fetch the full data.
This change optimizes network bandwidth and improves API performance by preventing unnecessary data transfer, especially when clients only need a subset of room details.
- Renamed `getWebbhookConfig` and `updateWebbhookConfig` to `getWebhookConfig` and `updateWebhookConfig` respectively for consistency.
- Updated integration tests to reflect the new function names.
- Refactored request helper methods to use `getFullPath` for API endpoint construction.
- Removed unnecessary parameters in `stopRecording` calls across various tests.
- Cleaned up test scenarios by removing redundant room deletion logic.
- Ensured proper handling of recording states in tests to avoid race conditions.
