Skip to content

Commit f0c8abb

Browse files
authored
Merge pull request #1303 from algorandfoundation/automatic-pr-go-algorand-v4.1.2-stable-indexer-3.7.2
Automatic update generated for go-algorand: v4.1.2-stable and indexer: 3.7.2
2 parents b9044d9 + 15e665f commit f0c8abb

File tree

6 files changed

+44
-32
lines changed

6 files changed

+44
-32
lines changed

.go-algorand-stable.version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v4.1.1-stable
1+
v4.1.2-stable

docs/clis/goal/app/box/box.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ goal app box [flags]
7474

7575
* [goal app](../../../app/app/) - Manage applications
7676
* [goal app box info](../info/) - Retrieve information about an application box.
77-
* [goal app box list](../list/) - List application boxes belonging to an application
77+
* [goal app box list](../list/) - List all application boxes belonging to an application
7878

7979

8080

docs/clis/goal/app/box/list.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,19 @@ title: goal app box list
44

55

66

7-
List application boxes belonging to an application
7+
List all application boxes belonging to an application
88

99

1010

1111
### Synopsis
1212

1313

1414

15-
List application boxes belonging to an application.
15+
List all application boxes belonging to an application.
1616

17-
Printable names and values are formatted as 'str:hello' otherwise 'b64:A=='.
17+
For printable strings, the box name is formatted as 'str:hello'
18+
19+
For everything else, the box name is formatted as 'b64:A=='.
1820

1921

2022

@@ -32,15 +34,9 @@ goal app box list [flags]
3234

3335
```
3436
35-
-h, --help help for list
36-
37-
-l, --limit uint The maximum number of boxes to list. 0 means no limit.
38-
39-
-n, --next string The next-token returned from a previous call, used for pagination.
40-
41-
-p, --prefix string Return only boxes that begin with the supplied prefix.
37+
-h, --help help for list
4238
43-
-v, --values Request and display box values.
39+
-m, --max uint Maximum number of boxes to list. 0 means no limit.
4440
4541
```
4642

docs/get-details/algorand-networks/mainnet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
title: MainNet
22

33
# Version
4-
`v4.1.1-stable`
4+
`v4.1.2-stable`
55

66
# Release Version
7-
https://github.com/algorand/go-algorand/releases/tag/v4.1.1-stable
7+
https://github.com/algorand/go-algorand/releases/tag/v4.1.2-stable
88

99
# Genesis ID
1010
`mainnet-v1.0`

docs/get-details/algorand-networks/testnet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
title: TestNet
22

33
# Version
4-
`v4.1.1-stable`
4+
`v4.1.2-stable`
55

66
# Release Version
7-
https://github.com/algorand/go-algorand/releases/tag/v4.1.1-stable
7+
https://github.com/algorand/go-algorand/releases/tag/v4.1.2-stable
88

99
# Genesis ID
1010
`testnet-v1.0`

docs/rest-apis/algod.md

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -569,32 +569,29 @@ Given an application ID and box name, it returns the round, box name, and value
569569

570570
<a name="getapplicationboxes"></a>
571571
### GET /v2/applications/{application-id}/boxes
572-
Get boxes for a given application.
572+
Get all box names for a given application.
573573
```
574574
GET /v2/applications/{application-id}/boxes
575575
```
576576

577577

578578
**Description**
579-
Given an application ID, return boxes in lexographical order by name. If the results must be truncated, a next-token is supplied to continue the request.
579+
Given an application ID, return all Box names. No particular ordering is guaranteed. Request fails when client or server-side configured limits prevent returning all Box names.
580580

581581

582582
**Parameters**
583583

584584
|Type|Name|Description|Schema|
585585
|---|---|---|---|
586586
|**Path**|**application-id** <br>*required*|An application identifier|integer|
587-
|**Query**|**max** <br>*optional*|Maximum number of boxes to return. Server may impose a lower limit.|integer|
588-
|**Query**|**next** <br>*optional*|A box name, in the goal app call arg form 'encoding:value'. When provided, the returned boxes begin (lexographically) with the supplied name. Callers may implement pagination by reinvoking the endpoint with the token from a previous call's next-token.|string|
589-
|**Query**|**prefix** <br>*optional*|A box name prefix, in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.|string|
590-
|**Query**|**values** <br>*optional*|If true, box values will be returned.|boolean|
587+
|**Query**|**max** <br>*optional*|Max number of box names to return. If max is not set, or max == 0, returns all box-names.|integer|
591588

592589

593590
**Responses**
594591

595592
|HTTP Code|Description|Schema|
596593
|---|---|---|
597-
|**200**|Boxes of an application|[Response 200](#getapplicationboxes-response-200)|
594+
|**200**|Box names of an application|[Response 200](#getapplicationboxes-response-200)|
598595
|**400**|Bad Request|[ErrorResponse](#errorresponse)|
599596
|**401**|Invalid API Token|[ErrorResponse](#errorresponse)|
600597
|**500**|Internal Error|[ErrorResponse](#errorresponse)|
@@ -603,11 +600,9 @@ Given an application ID, return boxes in lexographical order by name. If the res
603600
<a name="getapplicationboxes-response-200"></a>
604601
**Response 200**
605602

606-
|Name|Description|Schema|
607-
|---|---|---|
608-
|**boxes** <br>*required*||< [Box](#box) > array|
609-
|**next-token** <br>*optional*|Used for pagination, when making another request provide this token with the next parameter.|string|
610-
|**round** <br>*required*|The round for which this information is relevant.|integer|
603+
|Name|Schema|
604+
|---|---|
605+
|**boxes** <br>*required*|< [BoxDescriptor](#boxdescriptor) > array|
611606

612607

613608
**Produces**
@@ -2662,9 +2657,19 @@ Box name and its content.
26622657

26632658
|Name|Description|Schema|
26642659
|---|---|---|
2665-
|**name** <br>*required*|The box name, base64 encoded <br>**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
2666-
|**round** <br>*optional*|The round for which this information is relevant|integer|
2667-
|**value** <br>*required*|The box value, base64 encoded. <br>**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
2660+
|**name** <br>*required*|\[name\] box name, base64 encoded <br>**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
2661+
|**round** <br>*required*|The round for which this information is relevant|integer|
2662+
|**value** <br>*required*|\[value\] box value, base64 encoded. <br>**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
2663+
2664+
2665+
<a name="boxdescriptor"></a>
2666+
### BoxDescriptor
2667+
Box descriptor describes a Box.
2668+
2669+
2670+
|Name|Description|Schema|
2671+
|---|---|---|
2672+
|**name** <br>*required*|Base64 encoded box name <br>**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
26682673

26692674

26702675
<a name="boxreference"></a>
@@ -2839,6 +2844,17 @@ Key-value pairs for StateDelta.
28392844
|**voteLst** <br>*optional*|integer (uint64)|
28402845

28412846

2847+
<a name="kvdelta"></a>
2848+
### KvDelta
2849+
A single Delta containing the key, the previous value and the current value for a single round.
2850+
2851+
2852+
|Name|Description|Schema|
2853+
|---|---|---|
2854+
|**key** <br>*optional*|The key, base64 encoded. <br>**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
2855+
|**value** <br>*optional*|The new value of the KV store entry, base64 encoded. <br>**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
2856+
2857+
28422858
<a name="ledgerstatedelta"></a>
28432859
### LedgerStateDelta
28442860
Ledger StateDelta object

0 commit comments

Comments
 (0)