Automated API docs swagger to md conversion (https://jenkins.algol60.…

…net/job/Cray-HPE/job/csm/job/v1.6.0-alpha.60/1/)
Cray-HPE · Jul 26, 2024 · bd25038 · bd25038
1 parent 59a05c0
commit bd25038
Show file tree

Hide file tree

Showing 3 changed files with 159 additions and 61 deletions.
diff --git a/api/bos.md b/api/bos.md
@@ -190,6 +190,7 @@ Return list of versions currently running.
 |Status|Meaning|Description|Schema|
 |---|---|---|---|
 |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|A collection of Versions|Inline|
+|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|An Internal Server Error occurred handling the request.|[ProblemDetails](#schemaproblemdetails)|
 
 <h3 id="get__-responseschema">Response Schema</h3>
 
@@ -305,7 +306,7 @@ The versioning system uses [semver](https://semver.org/).
 ## Link Relationships
 * self : Link to itself
 * versions : Link back to the versions resource|[Version](#schemaversion)|
-|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Bad Request|[ProblemDetails](#schemaproblemdetails)|
+|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|An Internal Server Error occurred handling the request.|[ProblemDetails](#schemaproblemdetails)|
 
 <aside class="warning">
 To perform this operation, you must be authenticated by means of one of the following methods:
@@ -4102,7 +4103,8 @@ Update one or more of the BOS service options.
   "max_power_on_wait_time": 1048576,
   "max_power_off_wait_time": 1048576,
   "polling_frequency": 1048576,
-  "default_retry_policy": 1
+  "default_retry_policy": 1,
+  "max_component_batch_size": 1000
 }
 ```
 
@@ -4128,7 +4130,8 @@ Update one or more of the BOS service options.
   "max_power_on_wait_time": 1048576,
   "max_power_off_wait_time": 1048576,
   "polling_frequency": 1048576,
-  "default_retry_policy": 1
+  "default_retry_policy": 1,
+  "max_component_batch_size": 1000
 }
 ```
 
@@ -4328,7 +4331,8 @@ Retrieve the list of BOS service options.
   "max_power_on_wait_time": 1048576,
   "max_power_off_wait_time": 1048576,
   "polling_frequency": 1048576,
-  "default_retry_policy": 1
+  "default_retry_policy": 1,
+  "max_component_batch_size": 1000
 }
 ```
 
@@ -6466,7 +6470,8 @@ Mapping from Component staged Session statuses to Components with that status.
   "max_power_on_wait_time": 1048576,
   "max_power_off_wait_time": 1048576,
   "polling_frequency": 1048576,
-  "default_retry_policy": 1
+  "default_retry_policy": 1,
+  "max_component_batch_size": 1000
 }
 
 ```
@@ -6488,4 +6493,5 @@ Options for the Boot Orchestration Service.
 |max_power_off_wait_time|integer|false|none|How long BOS will wait for a node to power off before forcefully powering off (in seconds)|
 |polling_frequency|integer|false|none|How frequently the BOS operators check Component state for needed actions. (in seconds)|
 |default_retry_policy|integer|false|none|The default maximum number attempts per node for failed actions.|
+|max_component_batch_size|integer|false|none|The maximum number of components that a BOS operator will process at once. 0 means no limit.|
 
diff --git a/api/cfs.md b/api/cfs.md
@@ -1072,9 +1072,9 @@ Retrieve all the configuration framework sessions on the system.
 
 |Name|In|Type|Required|Description|
 |---|---|---|---|---|
-|age|query|string|false|Return only sessions older than the given age.  Age is given in the format "1d" or "6h" DEPRECATED: This field has been replaced by min_age and max_age|
-|min_age|query|string|false|Return only sessions older than the given age.  Age is given in the format "1d" or "6h"|
-|max_age|query|string|false|Return only sessions younger than the given age.  Age is given in the format "1d" or "6h"|
+|age|query|string|false|Return only sessions older than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h. DEPRECATED: This field has been replaced by min_age and max_age|
+|min_age|query|string|false|Return only sessions older than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
+|max_age|query|string|false|Return only sessions younger than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
 |status|query|string|false|Return only sessions with the given status.|
 |name_contains|query|string|false|Return only sessions whose session name contains the given string.|
 |succeeded|query|string|false|Return only sessions that have succeeded/failed.|
@@ -1420,13 +1420,13 @@ Delete multiple configuration sessions.  If filters are provided, only sessions
 
 |Name|In|Type|Required|Description|
 |---|---|---|---|---|
-|age|query|string|false|Deletes only sessions older than the given age.  Age is given in the format "1d" or "6h" DEPRECATED: This field has been replaced by min_age and max_age|
-|min_age|query|string|false|Return only sessions older than the given age.  Age is given in the format "1d" or "6h"|
-|max_age|query|string|false|Return only sessions younger than the given age.  Age is given in the format "1d" or "6h"|
+|age|query|string|false|Deletes only sessions older than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h. DEPRECATED: This field has been replaced by min_age and max_age|
+|min_age|query|string|false|Deletes only sessions older than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
+|max_age|query|string|false|Deletes only sessions younger than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
 |status|query|string|false|Deletes only sessions with the given status.|
 |name_contains|query|string|false|Delete only sessions whose session name contains the given string.|
 |succeeded|query|string|false|Delete only sessions that have succeeded/failed.|
-|tags|query|string|false|Return only sessions whose have the matching tags.  Key-value pairs should be separated using =, and tags can be a comma-separated list. Only sessions that match all tags will be deleted.|
+|tags|query|string|false|Deletes only sessions whose have the matching tags.  Key-value pairs should be separated using =, and tags can be a comma-separated list. Only sessions that match all tags will be deleted.|
 
 #### Enumerated Values
 
@@ -1923,8 +1923,8 @@ Retrieve all the configuration framework sessions on the system.
 |---|---|---|---|---|
 |limit|query|integer|false|When set, CFS will only return a number of sessions up to this limit.  Combined with after_id, this enables paging across results|
 |after_id|query|string|false|When set, CFS will only return the sessions after the session specified.  Combined with limit, this enables paging across results.|
-|min_age|query|string|false|Return only sessions older than the given age.  Age is given in the format "1d" or "6h"|
-|max_age|query|string|false|Return only sessions younger than the given age.  Age is given in the format "1d" or "6h"|
+|min_age|query|string|false|Return only sessions older than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
+|max_age|query|string|false|Return only sessions younger than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
 |status|query|string|false|Return only sessions with the given status.|
 |name_contains|query|string|false|Return only sessions whose session name contains the given string.|
 |succeeded|query|string|false|Return only sessions that have succeeded/failed.|
@@ -2285,8 +2285,8 @@ Delete multiple configuration sessions.  If filters are provided, only sessions
 
 |Name|In|Type|Required|Description|
 |---|---|---|---|---|
-|min_age|query|string|false|Return only sessions older than the given age.  Age is given in the format "1d" or "6h"|
-|max_age|query|string|false|Return only sessions younger than the given age.  Age is given in the format "1d" or "6h"|
+|min_age|query|string|false|Deletes only sessions older than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
+|max_age|query|string|false|Deletes only sessions younger than the given age. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h.|
 |status|query|string|false|Deletes only sessions with the given status.|
 |name_contains|query|string|false|Delete only sessions whose session name contains the given string.|
 |succeeded|query|string|false|Delete only sessions that have succeeded/failed.|
@@ -6601,7 +6601,7 @@ Configuration options for the configuration service.
 |defaultBatcherRetryPolicy|integer|false|none|The default maximum number retries per node when configuration fails.|
 |defaultPlaybook|string|false|none|The default playbook to be used if not specified in a node's desired state.|
 |defaultAnsibleConfig|string|false|none|The Kubernetes ConfigMap which holds the default ansible.cfg for a given CFS session. This ConfigMap must be present in the same Kubernetes namespace as the CFS service.|
-|sessionTTL|string|false|none|A time-to-live applied to all completed CFS sessions.  Specified in hours or days. e.g. 3d or 24h.  Set to an empty string to disable.|
+|sessionTTL|string|false|none|A time-to-live applied to all completed CFS sessions. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h. Set to an empty string to disable.|
 |additionalInventoryUrl|string|false|none|The git clone URL of a repo with additional inventory files.  All files in the repo will be copied into the hosts directory of CFS.|
 |batcherMaxBackoff|integer|false|none|The maximum number of seconds that batcher will backoff from session creation if problems are detected.|
 |batcherDisable|boolean|false|none|Disables cfs-batcher's automatic session creation if set to True.|
@@ -6651,7 +6651,7 @@ Configuration options for the configuration service.
 |default_batcher_retry_policy|integer|false|none|The default maximum number retries per node when configuration fails.|
 |default_playbook|string|false|read-only|[DEPRECATED] The default playbook to be used if not specified in a node's desired state. This option is read-only via the v3 API and remains only for compatibility with the v2 API. This option will be removed from v3 when the v2 API is removed.|
 |default_ansible_config|string|false|none|The Kubernetes ConfigMap which holds the default ansible.cfg for a given CFS session. This ConfigMap must be present in the same Kubernetes namespace as the CFS service.|
-|session_ttl|string|false|none|A time-to-live applied to all completed CFS sessions.  Specified in hours or days. e.g. 3d or 24h.  Set to an empty string to disable.|
+|session_ttl|string|false|none|A time-to-live applied to all completed CFS sessions. Specified in minutes, hours, days, or weeks. e.g. 3d or 24h. Set to an empty string to disable.|
 |additional_inventory_url|string|false|none|The git clone URL of a repo with additional inventory files.  All files in the repo will be copied into the hosts directory of CFS. This is mutually exclusive with the additional_inventory_source option and only one can be set.|
 |additional_inventory_source|string|false|none|A CFS source with additional inventory files.  All files in the repo will be copied into the hosts directory of CFS. This is mutually exclusive with the additional_source_url option and only one can be set.|
 |batcher_max_backoff|integer|false|none|The maximum number of seconds that batcher will backoff from session creation if problems are detected.|