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.
15 lines
504 B
YAML
15 lines
504 B
YAML
name: X-Fields
|
|
in: header
|
|
description: >
|
|
Specifies which fields to include in the response for the room resource.
|
|
Provide a comma-separated list of field names to filter the response payload.
|
|
|
|
This header allows you to optimize API responses by requesting only the data you need,
|
|
reducing bandwidth usage and improving performance.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
examples:
|
|
basic:
|
|
value: 'roomId,roomName,accessUrl'
|
|
summary: Only return basic room information |