validator-openapi-spec.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Validator API",
    "version": "1.0.0-oas3",
    "license": {
      "name": "Business Source License 1.1",
      "url": "https://github.com/primev/mev-commit/blob/main/LICENSE"
    }
  },
  "paths": {
    "/v1/validator/get_validators": {
      "get": {
        "summary": "GetValidators",
        "description": "GetValidators is called by the bidder to get the validators for a given epoch.",
        "operationId": "Validator_GetValidators",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1GetValidatorsResponse"
                }
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/googlerpcStatus"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "epoch",
            "description": "Epoch number for which to get the validators",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "uint64"
            }
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "googlerpcStatus": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/protobufAny"
            }
          }
        }
      },
      "protobufAny": {
        "type": "object",
        "properties": {
          "@type": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      },
      "v1GetValidatorsResponse": {
        "type": "object",
        "example": {
          "items": {
            "1": {
              "BLSKey": "0x1234567890abcdef",
              "isOptedIn": true
            }
          }
        },
        "properties": {
          "items": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/v1SlotInfo"
            },
            "description": "Map of slots numbers to validator bls key and isOptedIn boolean value"
          }
        },
        "description": "Response for GetValidators",
        "title": "GetValidatorsResponse"
      },
      "v1SlotInfo": {
        "type": "object",
        "properties": {
          "BLSKey": {
            "type": "string"
          },
          "isOptedIn": {
            "type": "boolean"
          }
        }
      }
    }
  }
}