[API] OpenAPI Spec Fixes

[Olshansk]

Objective

Fix the generated OpenAPI spec.

Origin Document

Background

pocket-core (Morse) has a really nice OpenAPI spec that I like to link to: https://editor.swagger.io/?url=https://raw.githubusercontent.com/pokt-network/pocket-core/staging/doc/specs/rpc-spec.yaml

It would be helpful to have an easily accessible swagger populated by the spec in Shannon as well.

Bug

If make ignite_openapi_gen is run on main, the resulting openapi.yml file is:

{
  "id": "github.com/pokt-network/poktroll",
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "swagger": "2.0",
  "info":
    {
      "description": "Chain github.com/pokt-network/poktroll REST API",
      "title": "HTTP API Console",
      "contact": { "name": "github.com/pokt-network/poktroll" },
      "version": "version not set",
    },
  "paths": {},
  "definitions":
    {
      "google.protobuf.Any":
        {
          "type": "object",
          "properties": { "@type": { "type": "string" } },
          "additionalProperties": {},
        },
      "google.rpc.Status":
        {
          "type": "object",
          "properties":
            {
              "code": { "type": "integer", "format": "int32" },
              "details":
                {
                  "type": "array",
                  "items":
                    {
                      "type": "object",
                      "$ref": "#/definitions/google.protobuf.Any",
                    },
                },
              "message": { "type": "string" },
            },
        },
    },
}

In order to fix it, we need:

1. git reset --hard acd7fc8a60f44a05a117050c441609361dd608d3
2. Comment out staking_fee in proto/poktroll/supplier/params.proto
3. Rerun make ignite_openapi_gen

Goals

• Make the OpenAPI spec of Shannon easily accessible
• Make the OpenAPI spec of Shannon easily accessible
• Fixing existing bugs on main related to generated the spec

Deliverables

• Figure out why a bug was introduced (see the background section)
• After fixing ☝️, Replace all instances of openapi.yml in the code with openapi.json (it was incorrect)
• Add a link to swagger pointing to the raw (correct) openapi spec in README and docusaurus/README
• Optionally, find a way to autoformat the generated spec in version control
• Optionally, find a way to have an easily accessibly .yml file in version control

---

Creator: @Olshansk
Co-Owners: @bryanchriswhite

[Olshansk]

Was also speaking with @commoddity about:

1. Updating [1] to have an API section
2. Directly link to a swagger doc that makes the OpenAPI spec accessible