Rename proposer parameter to proposers

In `GET /v2/block-headers`, rename the `proposer` parameter to `proposers` to follow conventions through the rest of the API.
algorand · Dec 5, 2024 · dff12aa · dff12aa
1 parent 8924c97
commit dff12aa
Show file tree

Hide file tree

Showing 7 changed files with 387 additions and 387 deletions.
diff --git a/api/converter_utils.go b/api/converter_utils.go
@@ -885,7 +885,7 @@ func (si *ServerImplementation) blockParamsToBlockFilter(params generated.Search
 	{
 		// Make sure at most one of the participation parameters is set
 		numParticipationFilters := 0
-		if params.Proposer != nil {
+		if params.Proposers != nil {
 			numParticipationFilters++
 		}
 		if params.Expired != nil {
@@ -899,8 +899,8 @@ func (si *ServerImplementation) blockParamsToBlockFilter(params generated.Search
 		}
 
 		// Validate the number of items in the participation account lists
-		if params.Proposer != nil && uint64(len(*params.Proposer)) > si.opts.MaxAccountListSize {
-			errs = append(errs, fmt.Errorf("proposer list too long, max size is %d", si.opts.MaxAccountListSize))
+		if params.Proposers != nil && uint64(len(*params.Proposers)) > si.opts.MaxAccountListSize {
+			errs = append(errs, fmt.Errorf("proposers list too long, max size is %d", si.opts.MaxAccountListSize))
 		}
 		if params.Expired != nil && uint64(len(*params.Expired)) > si.opts.MaxAccountListSize {
 			errs = append(errs, fmt.Errorf("expired list too long, max size is %d", si.opts.MaxAccountListSize))
@@ -910,8 +910,8 @@ func (si *ServerImplementation) blockParamsToBlockFilter(params generated.Search
 		}
 
 		filter.Proposers = make(map[sdk.Address]struct{}, 0)
-		if params.Proposer != nil {
-			for _, s := range *params.Proposer {
+		if params.Proposers != nil {
+			for _, s := range *params.Proposers {
 				addr, err := sdk.DecodeAddress(s)
 				if err != nil {
 					errs = append(errs, fmt.Errorf("unable to parse proposer address `%s`: %w", s, err))

diff --git a/api/generated/common/routes.go b/api/generated/common/routes.go
diff --git a/api/generated/common/types.go b/api/generated/common/types.go
diff --git a/api/generated/v2/routes.go b/api/generated/v2/routes.go
diff --git a/api/generated/v2/types.go b/api/generated/v2/types.go
diff --git a/api/indexer.oas2.json b/api/indexer.oas2.json
@@ -886,7 +886,7 @@
             "$ref": "#/parameters/after-time"
           },
           {
-            "$ref": "#/parameters/proposer"
+            "$ref": "#/parameters/proposers"
           },
           {
             "$ref": "#/parameters/expired"
@@ -2732,14 +2732,14 @@
     }
   },
   "parameters": {
-    "proposer": {
+    "proposers": {
       "type": "array",
       "items": {
         "type": "string",
         "x-algorand-format": "Address"
       },
       "description": "Accounts marked as proposer in the block header's participation updates. This parameter accepts a comma separated list of addresses.",
-      "name": "proposer",
+      "name": "proposers",
       "in": "query",
       "required": false
     },

diff --git a/api/indexer.oas3.yml b/api/indexer.oas3.yml
@@ -221,11 +221,11 @@
         },
         "x-algorand-format": "base64"
       },
-      "proposer": {
+      "proposers": {
         "description": "Accounts marked as proposer in the block header's participation updates. This parameter accepts a comma separated list of addresses.",
         "explode": false,
         "in": "query",
-        "name": "proposer",
+        "name": "proposers",
         "schema": {
           "items": {
             "type": "string",
@@ -4898,7 +4898,7 @@
             "description": "Accounts marked as proposer in the block header's participation updates. This parameter accepts a comma separated list of addresses.",
             "explode": false,
             "in": "query",
-            "name": "proposer",
+            "name": "proposers",
             "schema": {
               "items": {
                 "type": "string",