fix: OpenAPI validation

aldur commented 2 months ago

Description

While I was poking around the RPC endpoints, I noticed that:

We do not currently lint/validate the OpenAPI definition.
As a result, it was broken.
Plus, it included endpoints that were previously removed and/or changed path (v2 to v3). This is a known issue, see Applicable issues below.

This PR takes a small step into improving things, by:

Removing an outdated action (which now lives in the actions repository).
Removing non-existing endpoints.
Ensuring the definition validate with a bare minimum set of rules (see below).

Applicable issues

Partial improvement to https://github.com/stacks-network/stacks-core/issues/4551, but a lot still needs to be done.

Checklist

Manually lint as follows:

npx @redocly/cli@1.25.0 lint --extends minimal docs/rpc/openapi.yaml

Then try generating the HTML:

npx @redocly/cli@1.25.0 build-docs -o /tmp/open-api-docs.html ./docs/rpc/openapi.yaml

[x] Required documentation changes (e.g., docs/rpc/openapi.yaml and rpc-endpoints.md for v2 endpoints, event-dispatcher.md for new events)

wileyj commented 2 months ago

~this contains some changes from the 2.5.0.0.7 branch. can you rebase from that branch? target to develop is fine (after release, a PR is opened from release branch back to develop ).~

~the latest release branch is release/2.5.0.0.7~

disregard, it's the signer branch - we can deal with any conflicts later

blockstack-devops commented 3 weeks ago

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

stacks-network / stacks-core