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 #1753

Merged
merged 15 commits into from
Dec 18, 2024
Merged

Extend OpenAPI docs for bus API #1753

merged 15 commits into from
Dec 18, 2024

Conversation

peterjan
Copy link
Member

@peterjan peterjan commented Dec 16, 2024

Routes added:

  • /contract
  • /hosts
  • /host
  • /metric
  • /multipart
  • /objects
  • /object
  • /params
  • /slabbuffers
  • /sectors
  • /settings
  • /slabs
  • /state
  • /stats
  • /system
  • /upload
  • /webhooks

@peterjan peterjan self-assigned this Dec 16, 2024
@peterjan peterjan marked this pull request as ready for review December 17, 2024 05:52
metric := jc.PathParam("key")
if metric == "" {
jc.Error(errors.New("parameter 'metric' is required"), http.StatusBadRequest)
key := jc.PathParam("key")
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if this is even possible considering it's a path param. If key is "", then the path would be different and the router would probably return a 404 before even calling the handler.

@@ -2806,6 +5502,140 @@ components:
description: The total amount of memory available in bytes
minimum: 1

MultipartUpload:
Copy link
Member

Choose a reason for hiding this comment

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

This seems to be unused. Same for MultipartListPartItem, MultipartCompletedPart and Sector

@peterjan
Copy link
Member Author

@ChrisSchinnerl now has all routes, would like to F/U with a PR where I go over all routes in an editor and see what's missing

@ChrisSchinnerl ChrisSchinnerl merged commit 9d3a308 into dev Dec 18, 2024
4 checks passed
@ChrisSchinnerl ChrisSchinnerl deleted the pj/bus-api-spec branch December 18, 2024 08:57
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