New apis for getting one or more collections #15
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
2 tasks
StefMa
reviewed
Jul 8, 2023
rsjethani
changed the title
rsjethani
changed the title
StefMa
approved these changes
Jul 10, 2023
|
|
||
|
|
||
| // Fetch information about a collection: | ||
| col,err := cl.Collections().Get("collection id").Do(context.Background()) |
There was a problem hiding this comment.
Suggested change
| col,err := cl.Collections().Get("collection id").Do(context.Background()) | |
| col, err := cl.Collections().Get("collection id").Do(context.Background()) |
| @@ -6,23 +6,27 @@ | |||
| # Usage | |||
|
|
|||
| ## Client | |||
| Getting a single document by its id: | |||
There was a problem hiding this comment.
Why did you removed it? 🤔
This is still possible, right?
| Get all documents for a collection: | ||
| ```golang | ||
| cl := outline.New() | ||
| cl.Documents().GetAll().Collection("collection id").Do(context.Background(), func(d *outline.Document, err error) bool { |
There was a problem hiding this comment.
Why did you removed this, this is stil possible right?
There was a problem hiding this comment.
No, these were not possible in the first place. They were just added to show how API may look like. I should have used 'github discussions' rather than adding this I guess. But anyways...upcoming PRs will definitely add documents functionality.
| ID CollectionID `json:"id"` | ||
| }{ID: id} | ||
|
|
||
| copy := sl.New() |
There was a problem hiding this comment.
Just to get it right, this will "copy" the existing setup of Sling (therefore, copy headers and stuff), correct?
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.
New sub-clients types for fetching one or more collections.
Update Client creation to take
http.Clientfrom user. Also take api key as normal string, no need for making it a secret.Text because we inject it into the request immediately after receiving it. New internal common package which houses types and symbols which are required in both external tests and business logic.Updated README to reflect above changes and remove not yet existing scenarios.
Also: Updated minimum Go version to 1.19 as we use some new stuff ;)
Closes #2