d4a87f8a45
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.
20 lines
642 B
YAML
20 lines
642 B
YAML
name: X-Expand
|
|
in: header
|
|
description: >
|
|
Specifies which complex properties to include fully expanded in the response.
|
|
|
|
By default, certain large or nested properties (like `config`) are replaced with expandable stubs
|
|
to optimize payload size and reduce network bandwidth.
|
|
|
|
Use this header to include the full data of these properties in the creation response,
|
|
avoiding the need for a subsequent GET request.
|
|
|
|
Provide a comma-separated list of property names to expand.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
examples:
|
|
config:
|
|
value: 'config'
|
|
summary: Include full room configuration in response
|