Updated api-ref in esi-leap documentation #171
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
sheldor1510
commented
Jul 23, 2024
sheldor1510
commented
- #566
tzumainn
requested changes
Jul 23, 2024
| @@ -10,58 +10,82 @@ The Offer API endpoint can be reached at /v1/offers. | |||
| * This value will default to returning offers with status 'available'. | |||
| * This value can be set to 'any' to return offers without filtering by status. | |||
| * resource_uuid: Returns all offers with given resource_uuid. | |||
| * resource_type: Returns all offers with given resource_type | |||
| * resource_type: Returns all offers with given resource_type. | |||
| * resource_class: Returns all offers with given resource_class. | |||
There was a problem hiding this comment.
Might be worth mentioning here (and below) that this will default to the configured "default resource class", which by default is "ironic_node".
| ``` | ||
| }' | ||
| ``` | ||
| * The /v1/offers/\<uuid>/claim endpoint supports POST requests to claim the offer with the given uuid. The body of the request contains the lease information with the given values. |
There was a problem hiding this comment.
I would format this section so there's an actual header, so it's more apparent that there's another API function here. Right now it's a bit lost within the POST section. You can take a look at https://docs.openstack.org/api-ref/baremetal/ for an example of how specialized API commands are listed.
There was a problem hiding this comment.
I added headers to each endpoint to make it structured in a similar way to the Baremetal API documentation. Let me know if this is fine or too much.
tzumainn
requested changes
Jul 23, 2024
add information about default resource_type + fixed formatting fixed formatting issue
sheldor1510
force-pushed
the
update-api-ref
branch
from
b30b6a3
to
fea2b37
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.