website: Document Vagrant Cloud search API #10020
Conversation
| * `provider` - (Optional) Filter results to boxes supporting for a specific provider. | ||
| * `sort` - (Optional, default: `"downloads"`) The field to sort results on. Can be one of `"downloads"`, `"created"`, or `"updated"`. | ||
| * `order` - (Optional, default: `"desc"`) The order to return the sorted field in. Can be `"desc"` os `"asc"`. | ||
| * `limit` - (Optional, default: `10`) The number of results to return (max of TODO). |
There was a problem hiding this comment.
max of TODO should be fixed to whatever the max is
|
|
||
| * `q` - (Optional) The search query. Results will match the `username`, `name`, or `short_description` fields for a box. If omitted, the top boxes based on `sort` and `order` will be returned (defaults to "downloads desc"). | ||
| * `provider` - (Optional) Filter results to boxes supporting for a specific provider. | ||
| * `sort` - (Optional, default: `"downloads"`) The field to sort results on. Can be one of `"downloads"`, `"created"`, or `"updated"`. |
There was a problem hiding this comment.
Maybe this is a better question for the corresponding website PR, but what gets returned when you provide a sort key that isn't supported? Is there a new HTTP response code that needs to be documented here?
There was a problem hiding this comment.
I think right now it just ignores it, but I will check.
There was a problem hiding this comment.
Validated now! Will return 400.
|
|
||
| ```json | ||
| { | ||
| "boxes": [ |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
justincampbell
force-pushed
the
website-vagrant-cloud-api-search
branch
from
63c2839
to
3e0477c
Compare
|
Looking good, I think we're just missing the new HTTP 400 status code documented with the rest of the response codes. |
|
@briancain Switched this to be a 422 instead, see linked PR |
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked and limited conversation to collaborators
No description provided.