Skip to content

Commit de6a926

Browse files
committed
update specs.yaml schema for 5.4.1
1 parent 15d44d1 commit de6a926

File tree

1 file changed

+41
-40
lines changed

1 file changed

+41
-40
lines changed

specs.yaml

Lines changed: 41 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4966,15 +4966,15 @@ paths:
49664966
required: true
49674967
schema:
49684968
type: string
4969-
example: '2026-01-01'
4969+
example: '2026-02-01'
49704970
- name: checkout
49714971
in: query
49724972
description: |
49734973
Check-out date, in ISO 8601 format (YYYY-MM-DD). Total length of stay cannot exceed 28 nights or 365 nights depending on Vacation Rental configurations.
49744974
required: true
49754975
schema:
49764976
type: string
4977-
example: '2026-01-03'
4977+
example: '2026-02-03'
49784978
- name: currency
49794979
in: query
49804980
description: |
@@ -6202,7 +6202,7 @@ paths:
62026202
If specified must also specify `checkout`.
62036203
schema:
62046204
type: string
6205-
example: '2026-01-01'
6205+
example: '2026-02-01'
62066206
- name: checkout
62076207
in: query
62086208
description: |
@@ -6211,7 +6211,7 @@ paths:
62116211
If specified must also specify `checkin`.<br>
62126212
schema:
62136213
type: string
6214-
example: '2026-01-03'
6214+
example: '2026-02-03'
62156215
- name: exclusion
62166216
in: query
62176217
description: |
@@ -7899,7 +7899,7 @@ paths:
78997899
schema:
79007900
type: string
79017901
format: date
7902-
example: '2026-01-15'
7902+
example: '2026-02-15'
79037903
- name: end_date
79047904
in: query
79057905
description: |
@@ -7908,7 +7908,7 @@ paths:
79087908
schema:
79097909
type: string
79107910
format: date
7911-
example: '2026-07-17'
7911+
example: '2026-08-17'
79127912
responses:
79137913
"200":
79147914
description: OK
@@ -17478,6 +17478,7 @@ paths:
1747817478
example:
1747917479
type: service_unavailable
1748017480
message: This service is currently unavailable.
17481+
deprecated: true
1748117482
security:
1748217483
- rapidAuth: []
1748317484
/references/chains:
@@ -21048,9 +21049,9 @@ paths:
2104821049
- 334242
2104921050
- name: include
2105021051
in: query
21051-
description: Each time this parameter is specified will add to the list of
21052-
fields and associated objects returned in the response. All values and field
21053-
names are lower case. All field names found at the top level of the response
21052+
description: |
21053+
Each time this parameter is specified will add to the list of fields and associated objects returned in the
21054+
response. All values and field names are lower case. All field names found at the top level of the response
2105421055
are valid values for inclusion.
2105521056
schema:
2105621057
type: array
@@ -21619,9 +21620,9 @@ paths:
2161921620
- 987654
2162021621
- name: include
2162121622
in: query
21622-
description: Each time this parameter is specified will add to the list of
21623-
fields and associated objects returned in the response. All values and field
21624-
names are lower case. All field names found at the top level of the response
21623+
description: |
21624+
Each time this parameter is specified will add to the list of fields and associated objects returned in the
21625+
response. All values and field names are lower case. All field names found at the top level of the response
2162521626
are valid values for inclusion.
2162621627
schema:
2162721628
type: array
@@ -23393,7 +23394,10 @@ components:
2339323394
type: string
2339423395
description: Unique Identifier for a rate.
2339523396
status:
23396-
$ref: '#/components/schemas/Status'
23397+
type: string
23398+
description: Rates returned are always available.
23399+
enum:
23400+
- available
2339723401
available_rooms:
2339823402
type: number
2339923403
description: |-
@@ -23477,16 +23481,6 @@ components:
2347723481
items:
2347823482
$ref: '#/components/schemas/Deposit'
2347923483
description: A rate.
23480-
Status:
23481-
type: string
23482-
description: Indicates the status of the rate. If the rate is still available
23483-
then available will be returned. If the rate is no longer available at that
23484-
price then price_changed will be returned. If the rate is no longer available
23485-
at all then sold_out will be returned.
23486-
enum:
23487-
- available
23488-
- price_changed
23489-
- sold_out
2349023484
SaleScenario:
2349123485
type: object
2349223486
properties:
@@ -23712,12 +23706,17 @@ components:
2371223706
description: The price check response.
2371323707
StatusPriceCheck:
2371423708
type: string
23715-
description: Indicates the status of the rate. If the rate is still available
23716-
then available will be returned. If the rate is no longer available at that
23717-
price then price_changed will be returned. If the rate is no longer available
23718-
at all then sold_out will be returned.
23709+
description: |
23710+
Indicates the status of the rate.
23711+
* `available` - The rate is still available at or below the price returned in the shop response.
23712+
* `available_no_change` - **Only in Hard Change flows** - The rate is available but matches the booked rate.
23713+
* `price_changed` - The rate is no longer available at the previous price. Use the `additional_rates` link to
23714+
present updated rooms and rates for this property to travelers.
23715+
* `sold_out` - The rate is no longer available at any price. Use the `additional_rates` link to
23716+
present updated rooms and rates for this property to travelers.
2371923717
enum:
2372023718
- available
23719+
- available_no_change
2372123720
- price_changed
2372223721
- sold_out
2372323722
RoomPriceCheckLinks:
@@ -24389,6 +24388,7 @@ components:
2438924388
loyalty_id:
2439024389
type: string
2439124390
description: Deprecated. Please use the loyalty id inside the loyalty object.
24391+
deprecated: true
2439224392
loyalty:
2439324393
$ref: '#/components/schemas/Loyalty'
2439424394
rate:
@@ -25005,6 +25005,7 @@ components:
2500525005
loyalty_id:
2500625006
type: string
2500725007
description: Deprecated. Please use the loyalty id inside the loyalty object.
25008+
deprecated: true
2500825009
loyalty:
2500925010
$ref: '#/components/schemas/Loyalty'
2501025011
ItineraryCreation:
@@ -25090,6 +25091,7 @@ components:
2509025091
loyalty_id:
2509125092
type: string
2509225093
description: Deprecated. Please use the loyalty id inside the loyalty object.
25094+
deprecated: true
2509325095
loyalty:
2509425096
$ref: '#/components/schemas/Loyalty'
2509525097
example:
@@ -25407,14 +25409,12 @@ components:
2540725409
description: Unique identifier for the promotion
2540825410
blockout_dates:
2540925411
type: array
25410-
description: "An array of stay date ranges within this check-in / check-out\
25411-
\ range that are not eligible for this promotion.\nThe stay dates are\
25412-
\ determined by the would be check-in of that night. With a check-in date\
25413-
\ of 2023-09-01, \nand a check-out date of 2023-09-06, this would be a\
25414-
\ 5 night stay. A `blockout_dates` with start: 2023-09-02 \nand end: 2023-09-03\
25415-
\ would mean 2 of the nights are not eligible. The 1st night is eligible,\
25416-
\ the 2nd and 3rd\nnights are not eligible, and the 4th and 5th nights\
25417-
\ are eligible.\n"
25412+
description: |
25413+
An array of stay date ranges within this check-in / check-out range that are not eligible for this promotion.
25414+
The stay dates are determined by the would be check-in of that night. With a check-in date of 2023-09-01,
25415+
and a check-out date of 2023-09-06, this would be a 5 night stay. A `blockout_dates` with start: '2023-09-02'
25416+
and end: 2023-09-03 would mean 2 of the nights are not eligible. The 1st night is eligible, the 2nd and 3rd
25417+
nights are not eligible, and the 4th and 5th nights are eligible.
2541825418
items:
2541925419
$ref: '#/components/schemas/BlockoutDate'
2542025420
bookable_end:
@@ -25439,8 +25439,9 @@ components:
2543925439
description: The description of the promotion.
2544025440
discount_percentage:
2544125441
type: string
25442-
description: "The percent off of the cost of the property when using this\
25443-
\ promotion. \nThis will only be returned for percentage based promotions\n"
25442+
description: |
25443+
The percent off of the cost of the property when using this promotion.
25444+
This will only be returned for percentage based promotions
2544425445
guest_rating:
2544525446
type: string
2544625447
description: |
@@ -25497,9 +25498,9 @@ components:
2549725498
description: The region id for the property.
2549825499
star_rating:
2549925500
type: string
25500-
description: "The rating assigned to this property. Returns a value between\
25501-
\ 0.0 and 5.0. A value of 0.0 or a blank value \nindicates no rating is\
25502-
\ available.\n"
25501+
description: |
25502+
The rating assigned to this property. Returns a value between 0.0 and 5.0. A value of 0.0 or a blank value
25503+
indicates no rating is available.
2550325504
stay_end:
2550425505
type: string
2550525506
description: The last date that check-ins can be set to in this promotion

0 commit comments

Comments
 (0)