Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: OpenAPI validation #5160

Merged
merged 8 commits into from
Sep 11, 2024
Merged

Conversation

aldur
Copy link
Contributor

@aldur aldur commented Sep 11, 2024

Description

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

  1. We do not currently lint/validate the OpenAPI definition.
  2. As a result, it was broken.
  3. 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

Checklist

Manually lint as follows:

npx @redocly/[email protected] lint --extends minimal docs/rpc/openapi.yaml

Then try generating the HTML:

npx @redocly/[email protected] build-docs -o /tmp/open-api-docs.html ./docs/rpc/openapi.yaml
  • Required documentation changes (e.g., docs/rpc/openapi.yaml and rpc-endpoints.md for v2 endpoints, event-dispatcher.md for new events)

@aldur aldur requested review from a team as code owners September 11, 2024 15:55
@wileyj
Copy link
Contributor

wileyj commented Sep 11, 2024

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

Copy link
Contributor

@wileyj wileyj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@wileyj wileyj added this pull request to the merge queue Sep 11, 2024
Merged via the queue into stacks-network:develop with commit 6ee1aa9 Sep 11, 2024
1 check passed
@blockstack-devops
Copy link
Contributor

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-network locked as resolved and limited conversation to collaborators Oct 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants