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

feat: add missing schema to openapi docs #26

Merged
merged 4 commits into from
Nov 7, 2024
Merged

Conversation

lutr0
Copy link

@lutr0 lutr0 commented Nov 7, 2024

What ❔

Same PR as matter-labs#311
Add type to all empty schemas, e.g.:
just find all instances of:

"schema": {}

That's essentially saying: the type is an object, but in reality you want strings here (for example for the 'address' parameter, you want a string input for the address, not an object

"schema": {
  "type": "string"
}

Why ❔

Some parameters are missing schemas. This affects automation from partners e.g. MeritCircle

Checklist

  • PR title corresponds to the body of PR (we generate changelog entries from PRs).
  • Tests for the changes have been added / updated.
  • Documentation comments have been added / updated.

Copy link

vercel bot commented Nov 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
block-explorer-app ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 7, 2024 4:38pm

Copy link

netlify bot commented Nov 7, 2024

Deploy Preview for explorer-testnet-sophon-xyz canceled.

Name Link
🔨 Latest commit 53d2060
🔍 Latest deploy log https://app.netlify.com/sites/explorer-testnet-sophon-xyz/deploys/672cecd96f55d900086b593c

Copy link

github-actions bot commented Nov 7, 2024

API E2E Test Results

207 tests   207 ✅  21s ⏱️
 14 suites    0 💤
  1 files      0 ❌

Results for commit 53d2060.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Nov 7, 2024

Unit Test Results

    4 files    263 suites   11m 33s ⏱️
2 087 tests 2 086 ✅ 1 💤 0 ❌
2 296 runs  2 295 ✅ 1 💤 0 ❌

Results for commit 53d2060.

♻️ This comment has been updated with latest results.

@lutr0 lutr0 changed the title Add missing schema to openapi docs feat: add missing schema to openapi docs Nov 7, 2024
@lutr0 lutr0 marked this pull request as ready for review November 7, 2024 16:31
@githubdoramon githubdoramon merged commit 20326ef into main Nov 7, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants