فهرست منبع

Update API documentation with new refresh parameter

Signed-off-by: Mihaela Balutoiu <mbalutoiu@cloudbasesolutions.com>
Mihaela Balutoiu 4 ماه پیش
والد
کامیت
4be5960f38
2فایلهای تغییر یافته به همراه10 افزوده شده و 0 حذف شده
  1. 1 0
      coriolis/api-refs/source/endpoint.inc
  2. 9 0
      coriolis/api-refs/source/parameters.yaml

+ 1 - 0
coriolis/api-refs/source/endpoint.inc

@@ -251,6 +251,7 @@ Request
 .. rest_parameters:: parameters.yaml
 
    - endpoint_id : endpoint_id_path
+   - refresh : instance_refresh
 
 Response
 --------

+ 9 - 0
coriolis/api-refs/source/parameters.yaml

@@ -87,6 +87,15 @@ instance_limit:
   in: query
   required: false
   type: integer
+instance_refresh:
+  description: |
+    When set to true, forces a refresh of any cached instance data from the
+    source platform. This is useful when the instance list may have changed
+    and you want to ensure fresh data is retrieved.
+  in: query
+  required: false
+  type: boolean
+  default: false
 show_deleted:
   description: |
     Whether to include deleted resources in the response.