https://gitlab.com/tezos/tezos
Raw File
Tip revision: 0e412b6b50d432c7374ea28f3845ce3e23590ecd authored by Felix Puscasu on 22 January 2024, 12:38:57 UTC
RISC-V: M-ext: mul, div
Tip revision: 0e412b6
oxford-mempool-openapi.json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Octez Mempool RPC",
    "description": "The RPC API for the mempool served by the Octez node.",
    "version": "19.1 (dd3a30f891)"
  },
  "paths": {
    "/pending_operations": {
      "get": {
        "description": "List the prevalidated operations.",
        "parameters": [
          {
            "name": "version",
            "in": "query",
            "description": "Supported RPC versions are version \"0\" (deprecated) that will output attestation operations as \"endorsement\" in the \"kind\" field, version \"1\" (default but deprecated) that will output attestation operations as \"endorsement\" in the \"kind\" field, version \"2\"  that will output \"attestation\" in the \"kind\" field",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "applied",
            "in": "query",
            "description": "(DEPRECATED use validated instead) Include validated operations",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "validated",
            "in": "query",
            "description": "Include validated operations (true by default)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "refused",
            "in": "query",
            "description": "Include refused operations (true by default)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "outdated",
            "in": "query",
            "description": "Include outdated operations (true by default)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "branch_refused",
            "in": "query",
            "description": "Include branch refused operations (true by default)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "branch_delayed",
            "in": "query",
            "description": "Include branch delayed operations (true by default)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "validation_pass",
            "in": "query",
            "description": "Include operations filtered by validation pass (all by default)",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "title": "pending_operations_encoding_v2",
                      "type": "object",
                      "properties": {
                        "validated": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              }
                            },
                            "required": [
                              "hash",
                              "branch"
                            ]
                          }
                        },
                        "refused": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "protocol": {
                                "type": "string",
                                "enum": [
                                  "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                ]
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              },
                              "error": {
                                "$ref": "#/components/schemas/error"
                              }
                            },
                            "required": [
                              "hash",
                              "protocol",
                              "branch",
                              "error"
                            ]
                          }
                        },
                        "outdated": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "protocol": {
                                "type": "string",
                                "enum": [
                                  "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                ]
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              },
                              "error": {
                                "$ref": "#/components/schemas/error"
                              }
                            },
                            "required": [
                              "hash",
                              "protocol",
                              "branch",
                              "error"
                            ]
                          }
                        },
                        "branch_refused": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "protocol": {
                                "type": "string",
                                "enum": [
                                  "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                ]
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              },
                              "error": {
                                "$ref": "#/components/schemas/error"
                              }
                            },
                            "required": [
                              "hash",
                              "protocol",
                              "branch",
                              "error"
                            ]
                          }
                        },
                        "branch_delayed": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "protocol": {
                                "type": "string",
                                "enum": [
                                  "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                ]
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              },
                              "error": {
                                "$ref": "#/components/schemas/error"
                              }
                            },
                            "required": [
                              "hash",
                              "protocol",
                              "branch",
                              "error"
                            ]
                          }
                        },
                        "unprocessed": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "protocol": {
                                "type": "string",
                                "enum": [
                                  "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                ]
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              }
                            },
                            "required": [
                              "hash",
                              "protocol",
                              "branch"
                            ]
                          }
                        }
                      },
                      "required": [
                        "validated",
                        "refused",
                        "outdated",
                        "branch_refused",
                        "branch_delayed",
                        "unprocessed"
                      ]
                    },
                    {
                      "title": "pending_operations_encoding_v0",
                      "type": "object",
                      "properties": {
                        "applied": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              }
                            },
                            "required": [
                              "hash",
                              "branch"
                            ]
                          }
                        },
                        "refused": {
                          "type": "array",
                          "items": {
                            "type": "array",
                            "items": {
                              "oneOf": [
                                {
                                  "$ref": "#/components/schemas/Operation_hash"
                                },
                                {
                                  "description": "An operation's shell header.",
                                  "type": "object",
                                  "properties": {
                                    "protocol": {
                                      "type": "string",
                                      "enum": [
                                        "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                      ]
                                    },
                                    "branch": {
                                      "$ref": "#/components/schemas/block_hash"
                                    },
                                    "error": {
                                      "$ref": "#/components/schemas/error"
                                    }
                                  },
                                  "required": [
                                    "protocol",
                                    "branch",
                                    "error"
                                  ]
                                }
                              ]
                            }
                          }
                        },
                        "outdated": {
                          "type": "array",
                          "items": {
                            "type": "array",
                            "items": {
                              "oneOf": [
                                {
                                  "$ref": "#/components/schemas/Operation_hash"
                                },
                                {
                                  "description": "An operation's shell header.",
                                  "type": "object",
                                  "properties": {
                                    "protocol": {
                                      "type": "string",
                                      "enum": [
                                        "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                      ]
                                    },
                                    "branch": {
                                      "$ref": "#/components/schemas/block_hash"
                                    },
                                    "error": {
                                      "$ref": "#/components/schemas/error"
                                    }
                                  },
                                  "required": [
                                    "protocol",
                                    "branch",
                                    "error"
                                  ]
                                }
                              ]
                            }
                          }
                        },
                        "branch_refused": {
                          "type": "array",
                          "items": {
                            "type": "array",
                            "items": {
                              "oneOf": [
                                {
                                  "$ref": "#/components/schemas/Operation_hash"
                                },
                                {
                                  "description": "An operation's shell header.",
                                  "type": "object",
                                  "properties": {
                                    "protocol": {
                                      "type": "string",
                                      "enum": [
                                        "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                      ]
                                    },
                                    "branch": {
                                      "$ref": "#/components/schemas/block_hash"
                                    },
                                    "error": {
                                      "$ref": "#/components/schemas/error"
                                    }
                                  },
                                  "required": [
                                    "protocol",
                                    "branch",
                                    "error"
                                  ]
                                }
                              ]
                            }
                          }
                        },
                        "branch_delayed": {
                          "type": "array",
                          "items": {
                            "type": "array",
                            "items": {
                              "oneOf": [
                                {
                                  "$ref": "#/components/schemas/Operation_hash"
                                },
                                {
                                  "description": "An operation's shell header.",
                                  "type": "object",
                                  "properties": {
                                    "protocol": {
                                      "type": "string",
                                      "enum": [
                                        "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                      ]
                                    },
                                    "branch": {
                                      "$ref": "#/components/schemas/block_hash"
                                    },
                                    "error": {
                                      "$ref": "#/components/schemas/error"
                                    }
                                  },
                                  "required": [
                                    "protocol",
                                    "branch",
                                    "error"
                                  ]
                                }
                              ]
                            }
                          }
                        },
                        "unprocessed": {
                          "type": "array",
                          "items": {
                            "type": "array",
                            "items": {
                              "oneOf": [
                                {
                                  "$ref": "#/components/schemas/Operation_hash"
                                },
                                {
                                  "$ref": "#/components/schemas/next_operation_with_legacy_attestation_name"
                                }
                              ]
                            }
                          }
                        }
                      },
                      "required": [
                        "applied",
                        "refused",
                        "outdated",
                        "branch_refused",
                        "branch_delayed",
                        "unprocessed"
                      ]
                    },
                    {
                      "title": "pending_operations_encoding_v1",
                      "type": "object",
                      "properties": {
                        "applied": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              }
                            },
                            "required": [
                              "hash",
                              "branch"
                            ]
                          }
                        },
                        "refused": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "protocol": {
                                "type": "string",
                                "enum": [
                                  "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                ]
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              },
                              "error": {
                                "$ref": "#/components/schemas/error"
                              }
                            },
                            "required": [
                              "hash",
                              "protocol",
                              "branch",
                              "error"
                            ]
                          }
                        },
                        "outdated": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "protocol": {
                                "type": "string",
                                "enum": [
                                  "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                ]
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              },
                              "error": {
                                "$ref": "#/components/schemas/error"
                              }
                            },
                            "required": [
                              "hash",
                              "protocol",
                              "branch",
                              "error"
                            ]
                          }
                        },
                        "branch_refused": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "protocol": {
                                "type": "string",
                                "enum": [
                                  "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                ]
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              },
                              "error": {
                                "$ref": "#/components/schemas/error"
                              }
                            },
                            "required": [
                              "hash",
                              "protocol",
                              "branch",
                              "error"
                            ]
                          }
                        },
                        "branch_delayed": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "protocol": {
                                "type": "string",
                                "enum": [
                                  "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                ]
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              },
                              "error": {
                                "$ref": "#/components/schemas/error"
                              }
                            },
                            "required": [
                              "hash",
                              "protocol",
                              "branch",
                              "error"
                            ]
                          }
                        },
                        "unprocessed": {
                          "type": "array",
                          "items": {
                            "description": "An operation's shell header.",
                            "type": "object",
                            "properties": {
                              "hash": {
                                "$ref": "#/components/schemas/Operation_hash"
                              },
                              "protocol": {
                                "type": "string",
                                "enum": [
                                  "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
                                ]
                              },
                              "branch": {
                                "$ref": "#/components/schemas/block_hash"
                              }
                            },
                            "required": [
                              "hash",
                              "protocol",
                              "branch"
                            ]
                          }
                        }
                      },
                      "required": [
                        "applied",
                        "refused",
                        "outdated",
                        "branch_refused",
                        "branch_delayed",
                        "unprocessed"
                      ]
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "description": "The full list of errors is available with the global RPC `GET errors`"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Operation_hash": {
        "title": "A Tezos operation ID (Base58Check-encoded)",
        "oneOf": [
          {
            "$ref": "#/components/schemas/unistring"
          }
        ]
      },
      "block_hash": {
        "title": "A block identifier (Base58Check-encoded)",
        "oneOf": [
          {
            "$ref": "#/components/schemas/unistring"
          }
        ]
      },
      "error": {
        "description": "The full list of errors is available with the global RPC `GET errors`"
      },
      "next_operation_with_legacy_attestation_name": {
        "description": "An operation's shell header.",
        "type": "object",
        "properties": {
          "protocol": {
            "type": "string",
            "enum": [
              "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i"
            ]
          },
          "branch": {
            "$ref": "#/components/schemas/block_hash"
          }
        },
        "required": [
          "protocol",
          "branch"
        ]
      },
      "unistring": {
        "title": "Universal string representation",
        "description": "Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.",
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "object",
            "properties": {
              "invalid_utf8_string": {
                "type": "array",
                "items": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 255
                }
              }
            },
            "required": [
              "invalid_utf8_string"
            ]
          }
        ]
      }
    }
  }
}
back to top