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

Extend OpenAPI docs for bus API #1744

Merged
merged 10 commits into from
Dec 16, 2024
Merged

Extend OpenAPI docs for bus API #1744

merged 10 commits into from
Dec 16, 2024

Conversation

peterjan
Copy link
Member

@peterjan peterjan commented Dec 12, 2024

Routes added:

  • consensus
  • /contracts
  • /contract
  • /hosts
  • /metric
  • /multipart
  • /object
  • /params
  • /slabbuffers
  • /sectors
  • /settings
  • /slabs
  • /state
  • /syncer
  • /system
  • /txpool
  • /upload
  • /wallet
  • /webhooks

@peterjan peterjan self-assigned this Dec 12, 2024
@peterjan peterjan marked this pull request as ready for review December 12, 2024 15:17
Copy link
Member

@ChrisSchinnerl ChrisSchinnerl left a comment

Choose a reason for hiding this comment

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

I'd paste the spec into https://editor.swagger.io and go over the examples it generates. There are a bunch of places where the example says "string" which I think never needs to be the case cause we are very specific about what can be returned.

openapi.yml Show resolved Hide resolved
openapi.yml Show resolved Hide resolved
arbitraryData:
type: array
items:
type: string
Copy link
Member

Choose a reason for hiding this comment

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

I'd add a pattern here if it is hex

Copy link
Member Author

Choose a reason for hiding this comment

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

It's not hex encoded, it's really arbitrary data.

openapi.yml Show resolved Hide resolved
openapi.yml Show resolved Hide resolved
@ChrisSchinnerl ChrisSchinnerl merged commit 2abb5c3 into dev Dec 16, 2024
14 of 17 checks passed
@ChrisSchinnerl ChrisSchinnerl deleted the pj/bus-api-spec branch December 16, 2024 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants