Skip to content

Commit 4be5960

Browse files
mihaelabalutoiuDany9966
authored andcommitted
Update API documentation with new refresh parameter
Signed-off-by: Mihaela Balutoiu <mbalutoiu@cloudbasesolutions.com>
1 parent def53f8 commit 4be5960

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

coriolis/api-refs/source/endpoint.inc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,7 @@ Request
251251
.. rest_parameters:: parameters.yaml
252252

253253
- endpoint_id : endpoint_id_path
254+
- refresh : instance_refresh
254255

255256
Response
256257
--------

coriolis/api-refs/source/parameters.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,15 @@ instance_limit:
8787
in: query
8888
required: false
8989
type: integer
90+
instance_refresh:
91+
description: |
92+
When set to true, forces a refresh of any cached instance data from the
93+
source platform. This is useful when the instance list may have changed
94+
and you want to ensure fresh data is retrieved.
95+
in: query
96+
required: false
97+
type: boolean
98+
default: false
9099
show_deleted:
91100
description: |
92101
Whether to include deleted resources in the response.

0 commit comments

Comments
 (0)