List protocol upgrade proposals

GET 
/api/v2/upgrade/proposals

Get a list of protocol upgrade proposals, optionally filtering on status or approver.

Request

Query Parameters

status string
Possible values: [PROTOCOL_UPGRADE_PROPOSAL_STATUS_UNSPECIFIED, PROTOCOL_UPGRADE_PROPOSAL_STATUS_PENDING, PROTOCOL_UPGRADE_PROPOSAL_STATUS_APPROVED, PROTOCOL_UPGRADE_PROPOSAL_STATUS_REJECTED]
Default value: PROTOCOL_UPGRADE_PROPOSAL_STATUS_UNSPECIFIED
Restrict protocol upgrade proposals to those with the given status.
• PROTOCOL_UPGRADE_PROPOSAL_STATUS_PENDING: The proposal is pending
• PROTOCOL_UPGRADE_PROPOSAL_STATUS_APPROVED: The proposal is approved
• PROTOCOL_UPGRADE_PROPOSAL_STATUS_REJECTED: The proposal is rejected
approvedBy string

Restrict protocol upgrade proposals to those approved by the given node ID.

pagination.first int32

Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

pagination.after string

If paging forwards, the cursor string for the last row of the previous page.

pagination.last int32

Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

pagination.before string

If paging forwards, the cursor string for the first row of the previous page.

pagination.newestFirst boolean

Whether to order the results with the newest records first. If not set, the default value is true.

Responses

200

A successful response.

application/json

Schema

Schema

protocolUpgradeProposals object

Page of protocol upgrade proposals and corresponding page information.

edges object[]

Page of protocol upgrade proposals data and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Protocol upgrade proposal data.

approvers string[]

status Status of the proposal (string)

Possible values: [PROTOCOL_UPGRADE_PROPOSAL_STATUS_UNSPECIFIED, PROTOCOL_UPGRADE_PROPOSAL_STATUS_PENDING, PROTOCOL_UPGRADE_PROPOSAL_STATUS_APPROVED, PROTOCOL_UPGRADE_PROPOSAL_STATUS_REJECTED]

Default value: PROTOCOL_UPGRADE_PROPOSAL_STATUS_UNSPECIFIED

upgradeBlockHeight uint64

vegaReleaseTag Release tag for the vega binary (string)

]

pageInfo object

Page information that is used for fetching further pages.

endCursor string

End cursor.

hasNextPage boolean

Indicator if there is a next page.

hasPreviousPage boolean

Indicator if there is a previous page.

startCursor string

Start cursor.

Example (from schema)

{
  "protocolUpgradeProposals": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "approvers": [
            "string"
          ],
          "status": "PROTOCOL_UPGRADE_PROPOSAL_STATUS_UNSPECIFIED",
          "upgradeBlockHeight": "string",
          "vegaReleaseTag": "string"
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "string"
    }
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...