Skip to content

Commit

Permalink
Automated API docs swagger to md conversion (https://jenkins.algol60.…
Browse files Browse the repository at this point in the history 
…net/job/Cray-HPE/job/csm/job/v1.6.0-alpha.65/1/)
  • Loading branch information
Jenkins committed Sep 4, 2024
1 parent 3230717 commit 6492be2
Show file tree
Hide file tree
Showing 3 changed files with 205 additions and 73 deletions.
79 changes: 6 additions & 73 deletions api/bos.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5118,7 +5118,7 @@ group of Components.
|enable_cfs|[EnableCfs](#schemaenablecfs)|false|none|Whether to enable the Configuration Framework Service (CFS).|
|cfs|[V2CfsParameters](#schemav2cfsparameters)|false|none|This is the collection of parameters that are passed to the Configuration<br>Framework Service when configuration is enabled. Can be set as the global value for<br>a Session Template, or individually within a Boot Set.|
|boot_sets|object|true|none|Mapping from Boot Set names to Boot Sets.<br><br>* Boot Set names must be 1-127 characters in length.<br>* Boot Set names must use only letters, digits, periods (.), dashes (-), and underscores (_).<br>* Boot Set names must begin and end with a letter or digit.|
|» **additionalProperties**|[V2BootSet](#schemav2bootset)|false|none|none|
|» **additionalProperties**|[V2BootSet](#schemav2bootset)|false|none|A Boot Set is a collection of nodes defined by an explicit list, their functional<br>role, and their logical groupings. This collection of nodes is associated with one<br>set of boot artifacts and optional additional records for configuration and root<br>filesystem provisioning.<br><br>A boot set requires at least one of the following fields to be specified:<br>node_list, node_roles_groups, node_groups<br><br>If specified, the name field must match the key mapping to this boot set in the<br>boot_sets field of the containing V2SessionTemplate.|
|links|[LinkListReadOnly](#schemalinklistreadonly)|false|none|List of links to other resources|

<h2 id="tocS_V2SessionTemplateValidation">V2SessionTemplateValidation</h2>
Expand Down Expand Up @@ -5326,12 +5326,12 @@ Information on the status of a Session.
|status|[V2SessionStatusLabel](#schemav2sessionstatuslabel)|false|none|The status of a Session.|
|error|string¦null|false|none|Error which prevented the Session from running.<br>A null value means the Session has not encountered an error.|

<h2 id="tocS_V2BootSetData">V2BootSetData</h2>
<h2 id="tocS_V2BootSet">V2BootSet</h2>
<!-- backwards compatibility -->
<a id="schemav2bootsetdata"></a>
<a id="schema_V2BootSetData"></a>
<a id="tocSv2bootsetdata"></a>
<a id="tocsv2bootsetdata"></a>
<a id="schemav2bootset"></a>
<a id="schema_V2BootSet"></a>
<a id="tocSv2bootset"></a>
<a id="tocsv2bootset"></a>

```json
{
Expand Down Expand Up @@ -5398,73 +5398,6 @@ boot_sets field of the containing V2SessionTemplate.
|arch|Other|
|arch|Unknown|

<h2 id="tocS_V2BootSet">V2BootSet</h2>
<!-- backwards compatibility -->
<a id="schemav2bootset"></a>
<a id="schema_V2BootSet"></a>
<a id="tocSv2bootset"></a>
<a id="tocsv2bootset"></a>

```json
{
"name": "compute",
"path": "s3://boot-images/9e3c75e1-ac42-42c7-873c-e758048897d6/manifest.json",
"cfs": {
"configuration": "compute-23.4.0"
},
"type": "s3",
"etag": "1cc4eef4f407bd8a62d7d66ee4b9e9c8",
"kernel_parameters": "console=ttyS0,115200 bad_page=panic crashkernel=340M hugepagelist=2m-2g intel_iommu=off intel_pstate=disable iommu=pt ip=dhcp numa_interleave_omit=headless numa_zonelist_order=node oops=panic pageblock_order=14 pcie_ports=native printk.synchronous=y rd.neednet=1 rd.retry=10 rd.shell turbo_boost_limit=999 spire_join_token=${SPIRE_JOIN_TOKEN}",
"node_list": [
"x3000c0s19b1n0",
"x3000c0s19b2n0"
],
"node_roles_groups": [
"Compute",
"Application"
],
"node_groups": [
"string"
],
"arch": "X86",
"rootfs_provider": "cpss3",
"rootfs_provider_passthrough": "dvs:api-gw-service-nmn.local:300:nmn0"
}

```

### Properties

allOf

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|*anonymous*|[V2BootSetData](#schemav2bootsetdata)|false|none|A Boot Set is a collection of nodes defined by an explicit list, their functional<br>role, and their logical groupings. This collection of nodes is associated with one<br>set of boot artifacts and optional additional records for configuration and root<br>filesystem provisioning.<br><br>A boot set requires at least one of the following fields to be specified:<br>node_list, node_roles_groups, node_groups<br><br>If specified, the name field must match the key mapping to this boot set in the<br>boot_sets field of the containing V2SessionTemplate.|

and

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|*anonymous*|any|false|none|none|

anyOf

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|» *anonymous*|object|false|none|none|

or

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|» *anonymous*|object|false|none|none|

or

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|» *anonymous*|object|false|none|none|

<h2 id="tocS_V2SessionTemplateArray">V2SessionTemplateArray</h2>
<!-- backwards compatibility -->
<a id="schemav2sessiontemplatearray"></a>
Expand Down
143 changes: 143 additions & 0 deletions api/ims.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8443,6 +8443,117 @@ To perform this operation, you must be authenticated by means of one of the foll
bearerAuth
</aside>

<h1 id="image-management-service-remote-build-node-status">remote build node status</h1>

## get_all_v3_remote_build_status

<a id="opIdget_all_v3_remote_build_status"></a>

> Code samples
```http
GET https://api-gw-service-nmn.local/apis/ims/v3/remote-build-nodes/status HTTP/1.1
Host: api-gw-service-nmn.local
Accept: application/json
```

```shell
# You can also use wget
curl -X GET https://api-gw-service-nmn.local/apis/ims/v3/remote-build-nodes/status \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

```

```python
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api-gw-service-nmn.local/apis/ims/v3/remote-build-nodes/status', headers = headers)

print(r.json())

```

```go
package main

import (
"bytes"
"net/http"
)

func main() {

headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}

data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api-gw-service-nmn.local/apis/ims/v3/remote-build-nodes/status", data)
req.Header = headers

client := &http.Client{}
resp, err := client.Do(req)
// ...
}

```

`GET /v3/remote-build-nodes/status`

*List remote build node status objects*

Retrieve the status of all remote build nodes that are registered with IMS.

> Example responses
> 200 Response
```json
[
{
"xname": "x3000c1s10b1n0",
"nodeArch": "x86_64",
"numCurrentJobs": 15,
"podmanStatus": "Podman present at /usr/bin/podman",
"sshStatus": "SSH connection established",
"ableToRunJobs": true
}
]
```

<h3 id="get_all_v3_remote_build_status-responses">Responses</h3>

|Status|Meaning|Description|Schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|A collection of the status of each remote build node|Inline|
|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|An internal error occurred. Re-running the request may or may not succeed.|[ProblemDetails](#schemaproblemdetails)|

<h3 id="get_all_v3_remote_build_status-responseschema">Response Schema</h3>

Status Code **200**

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|*anonymous*|[[RemoteBuildNodeStatus](#schemaremotebuildnodestatus)]|false|none|[A Remote Build Node Status]|
|» xname|string|true|none|Xname of the remote build node|
|» nodeArch|string|false|none|Architecture of the remote build node|
|» numCurrentJobs|integer|false|none|Number of current jobs running on the remote build node|
|» podmanStatus|string|false|none|Status of the podman executable on the remote build node|
|» sshStatus|string|false|none|Status of the ssh connection to the remote build node|
|» ableToRunJobs|boolean|false|none|If the node is able to run new jobs|

<aside class="warning">
To perform this operation, you must be authenticated by means of one of the following methods:
bearerAuth
</aside>

# Schemas

<h2 id="tocS_SSHConnectionInfo">SSHConnectionInfo</h2>
Expand Down Expand Up @@ -8641,6 +8752,38 @@ A Remote Build Node Record
|---|---|---|---|---|
|xname|string|true|none|Xname of the remote build node|

<h2 id="tocS_RemoteBuildNodeStatus">RemoteBuildNodeStatus</h2>
<!-- backwards compatibility -->
<a id="schemaremotebuildnodestatus"></a>
<a id="schema_RemoteBuildNodeStatus"></a>
<a id="tocSremotebuildnodestatus"></a>
<a id="tocsremotebuildnodestatus"></a>

```json
{
"xname": "x3000c1s10b1n0",
"nodeArch": "x86_64",
"numCurrentJobs": 15,
"podmanStatus": "Podman present at /usr/bin/podman",
"sshStatus": "SSH connection established",
"ableToRunJobs": true
}

```

A Remote Build Node Status

### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|xname|string|true|none|Xname of the remote build node|
|nodeArch|string|false|none|Architecture of the remote build node|
|numCurrentJobs|integer|false|none|Number of current jobs running on the remote build node|
|podmanStatus|string|false|none|Status of the podman executable on the remote build node|
|sshStatus|string|false|none|Status of the ssh connection to the remote build node|
|ableToRunJobs|boolean|false|none|If the node is able to run new jobs|

<h2 id="tocS_ArtifactLinkRecord">ArtifactLinkRecord</h2>
<!-- backwards compatibility -->
<a id="schemaartifactlinkrecord"></a>
Expand Down
56 changes: 56 additions & 0 deletions api/sls.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,14 @@ Status Code **200**

*xor*

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|»» *anonymous*|[hardware_comptype_virtual_node](#schemahardware_comptype_virtual_node)|false|none|none|
|»»» NodeType|string|true|none|The role type assigned to this node.|
|»»» nid|integer|false|none|none|

*xor*

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|»» *anonymous*|[hardware_ip_and_creds_optional](#schemahardware_ip_and_creds_optional)|false|none|none|
Expand All @@ -349,6 +357,7 @@ Status Code **200**
|NodeType|Application|
|NodeType|Storage|
|NodeType|Management|
|NodeType|Management|

<aside class="warning">
To perform this operation, you must be authenticated by means of one of the following methods:
Expand Down Expand Up @@ -1018,6 +1027,14 @@ Status Code **200**

*xor*

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|»» *anonymous*|[hardware_comptype_virtual_node](#schemahardware_comptype_virtual_node)|false|none|none|
|»»» NodeType|string|true|none|The role type assigned to this node.|
|»»» nid|integer|false|none|none|

*xor*

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|»» *anonymous*|[hardware_ip_and_creds_optional](#schemahardware_ip_and_creds_optional)|false|none|none|
Expand All @@ -1038,6 +1055,7 @@ Status Code **200**
|NodeType|Application|
|NodeType|Storage|
|NodeType|Management|
|NodeType|Management|

<aside class="warning">
To perform this operation, you must be authenticated by means of one of the following methods:
Expand Down Expand Up @@ -1602,6 +1620,9 @@ sls_dump:
|»»»»» *anonymous*|body|[hardware_comptype_node](#schemahardware_comptype_node)|false|none|
|»»»»»» NodeType|body|string|true|The role type assigned to this node.|
|»»»»»» nid|body|integer|false|none|
|»»»»» *anonymous*|body|[hardware_comptype_virtual_node](#schemahardware_comptype_virtual_node)|false|none|
|»»»»»» NodeType|body|string|true|The role type assigned to this node.|
|»»»»»» nid|body|integer|false|none|
|»»»»» *anonymous*|body|[hardware_ip_and_creds_optional](#schemahardware_ip_and_creds_optional)|false|none|
|»»»»»» IP6addr|body|string|false|The ipv6 address that should be assigned to this BMC, or "DHCPv6". If omitted, "DHCPv6" is assumed.|
|»»»»»» IP4addr|body|string|false|The ipv4 address that should be assigned to this BMC, or "DHCPv4". If omitted, "DHCPv4" is assumed.|
Expand Down Expand Up @@ -1647,6 +1668,7 @@ sls_dump:
|»»»»»» NodeType|Application|
|»»»»»» NodeType|Storage|
|»»»»»» NodeType|Management|
|»»»»»» NodeType|Management|

<h3 id="post__loadstate-responses">Responses</h3>

Expand Down Expand Up @@ -3490,6 +3512,34 @@ The human-readable time this object was last created or updated.
|NodeType|Storage|
|NodeType|Management|

<h2 id="tocS_hardware_comptype_virtual_node">hardware_comptype_virtual_node</h2>
<!-- backwards compatibility -->
<a id="schemahardware_comptype_virtual_node"></a>
<a id="schema_hardware_comptype_virtual_node"></a>
<a id="tocShardware_comptype_virtual_node"></a>
<a id="tocshardware_comptype_virtual_node"></a>

```json
{
"NodeType": "Management",
"nid": "2"
}

```

### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|NodeType|string|true|none|The role type assigned to this node.|
|nid|integer|false|none|none|

#### Enumerated Values

|Property|Value|
|---|---|
|NodeType|Management|

<h2 id="tocS_hardware_comptype_nodecard">hardware_comptype_nodecard</h2>
<!-- backwards compatibility -->
<a id="schemahardware_comptype_nodecard"></a>
Expand Down Expand Up @@ -3597,6 +3647,12 @@ xor

xor

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|*anonymous*|[hardware_comptype_virtual_node](#schemahardware_comptype_virtual_node)|false|none|none|

xor

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|*anonymous*|[hardware_comptype_nodecard](#schemahardware_comptype_nodecard)|false|none|none|
Expand Down

0 comments on commit 6492be2

Please sign in to comment.