README: more details on method blocks #112
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
jhernand
reviewed
Feb 24, 2020
| name and their type. In the above example there are five input parameters | ||
| (named `Page`, `Size`, `Search` and `Order`) and one output parameter (named | ||
| name and their type. In the above example there are four input parameters | ||
| (named `Page`, `Size`, `Search` and `Order`) and four output parameter (named |
There was a problem hiding this comment.
Should be: two output parameters (named TotalandItems`).
There was a problem hiding this comment.
oh, I forgot to edit this part. I meant four, including the in-out Page and Size.
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.
I notice the meaning of parameters depends on method, so decided to document that better.
see openapi: listing collections don't document returning a
kindfield #111 aboutKindparameter in List.wasn't sure where to document the
?method=Getthing. AFAICTMethodMiddlewarecode implementing this is specific to clusters-service, and SDK doesn't use it on client nor server side.But it's used by some requests from the UI, so should be documented, and should appear in openapi (which adding to README doesn't achieve).
An obvious place I thought is on root resource for clusters_mgmt, but its comment doesn't seem to get into the openapi. The doc string for
/api/clusters_mgmt/v1is "Retrieves the version metadata." which is hard-coded in the generator.