add v3.0 upgrade docs, update README usage instructions #83
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
Signed-off-by: Bruno Vieira <[email protected]>
kmossco
force-pushed
the
update_documentation
branch
from
ed16452 to
c2d2a5c
Compare
swember
approved these changes
Nov 7, 2023
tudorpavel
reviewed
Nov 7, 2023
README.md
Outdated
| ``` | ||
|
|
||
| ### Enrichment API | ||
|
|
||
| Available methods in Enrichment API: | ||
|
|
||
|
|
||
| #### [Customers](https://dev.chartmogul.com/docs/retrieve-customer) |
There was a problem hiding this comment.
Shouldn't the title and link also be changed to Search for Customers here?
There was a problem hiding this comment.
This heading 4 is the higher level endpoint "family", or at least that's how the README look like now for the other endpoints, so it points to https://dev.chartmogul.com/reference/customers-1 instead. The URL was wrong.
There was a problem hiding this comment.
Hmm, but the code sample is about search, that's what confused me.
Signed-off-by: Bruno Vieira <[email protected]>
tudorpavel
approved these changes
Nov 8, 2023
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.
This adds an upgrade guide like we have in the other libraries for updating from v2.x to v3.x.
It also updates the README instructions for several endpoints and orders them like they are ordered in the dev docs so it's easier to compare both when changes occur.