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.
17 lines
473 B
YAML
17 lines
473 B
YAML
name: expand
|
|
in: query
|
|
description: >
|
|
Specifies which complex properties to include in the response.
|
|
|
|
By default, certain large or nested properties are excluded to optimize payload size
|
|
and reduce network bandwidth.
|
|
<br/>
|
|
Provide a comma-separated list of property names to include their full data in the response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
examples:
|
|
config:
|
|
value: 'expand=config'
|
|
summary: Expand room configuration
|