More clarity around GetInfo and List #158
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
aricart
reviewed
Sep 20, 2022
piotrpio
approved these changes
Sep 20, 2022
|
|
||
| ``` | ||
| GetInfo(name string) -> ObjectInfo | ||
| ``` | ||
|
|
||
| Optional/Convenience examples: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
This example is written in Go from what I see, but Go does not have method overloading (just variadinc arguments with ...). So in go, the method signature looks something like this:
Get(name string, opts ...GetObjectOpt) (ObjectResult, error)And usage would be:
// will return error if object is deleted
obj, err := obs.Get("A")
// will return deleted object
obj, err := obs.Get("A", GetObjectShowDeleted())
adr/ADR-20.md
Outdated
| Optional/Convenience examples: | ||
|
|
||
| ``` | ||
| List(includingDeleted bool) -> List or array of ObjectInfo |
There was a problem hiding this comment.
Same as the other comment
There was a problem hiding this comment.
this was removed in lieu of a comment
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.
No description provided.