Skip to content

Commit 0504ba7

Browse files
Remove reference to set energy-balance in http api
Closes #119.
1 parent 93d6871 commit 0504ba7

File tree

1 file changed

+1
-40
lines changed

1 file changed

+1
-40
lines changed

docs/http/energy.md

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@ The HTTP endpoints in `/energy` allow clients to query identities' energy balanc
77
| Route | Description |
88
| ------------------------------------------------ | --------------------------------------------------------- |
99
| [`/energy/:identity GET`](#energyidentity-get) | Get the remaining energy balance for the user `identity`. |
10-
| [`/energy/:identity POST`](#energyidentity-post) | Set the energy balance for the user `identity`. |
1110

1211
## `/energy/:identity GET`
1312

1413
Get the energy balance of an identity.
1514

16-
Accessible through the CLI as `spacetime energy status <identity>`.
15+
Accessible through the CLI as [`spacetime energy balance`](/docs/cli-reference#spacetime-energy-balance).
1716

1817
#### Parameters
1918

@@ -34,41 +33,3 @@ Returns JSON in the form:
3433
| Field | Value |
3534
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3635
| `balance` | The identity's energy balance, as a decimal integer. Note that energy balances may be negative, and will frequently be too large to store in a 64-bit integer. |
37-
38-
## `/energy/:identity POST`
39-
40-
Set the energy balance for an identity.
41-
42-
Accessible through the CLI as `spacetime energy set-balance <balance> <identity>`.
43-
44-
#### Parameters
45-
46-
| Name | Value |
47-
| ----------- | ----------------------- |
48-
| `:identity` | The Spacetime identity. |
49-
50-
#### Query Parameters
51-
52-
| Name | Value |
53-
| --------- | ------------------------------------------ |
54-
| `balance` | A decimal integer; the new balance to set. |
55-
56-
#### Required Headers
57-
58-
| Name | Value |
59-
| --------------- | --------------------------------------------------------------- |
60-
| `Authorization` | A Spacetime token [encoded as Basic authorization](/docs/http). |
61-
62-
#### Returns
63-
64-
Returns JSON in the form:
65-
66-
```typescript
67-
{
68-
"balance": number
69-
}
70-
```
71-
72-
| Field | Value |
73-
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
74-
| `balance` | The identity's new energy balance, as a decimal integer. Note that energy balances may be negative, and will frequently be too large to store in a 64-bit integer. |

0 commit comments

Comments
 (0)