Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

Improve migration guide#509

Merged
mojito317 merged 5 commits into
masterfrom
improve-migration-guide
Dec 21, 2021
Merged

Improve migration guide#509
mojito317 merged 5 commits into
masterfrom
improve-migration-guide

Conversation

@mojito317

Copy link
Copy Markdown
Contributor

Checklist

  • Tick to sign-off your agreement to the Developer Certificate of Origin (DCO) 1.1
  • Added tests for code changes or test/build only changes
  • Updated the change log file (CHANGES.md|CHANGELOG.md) or test/build only changes
  • Completed the PR template below:

Description

My goal was to improve the migration guide dispersing the fog around the support of the retry feature an error handling.

Approach

  • applied code style on the links for new operations 7517927
  • fixed incorrect links (8548ee0):
    • the link for postChanges has changed
    • the link for postPartitionFind has changed
    • postMissingRevs is excluded from the SDKs, I replaced it with postRevsDiff
  • Added a warning about the error handling 4103af8
  • Added a note about Replay adapters replacement 4103af8

Schema & API Changes

  • "No change"

Security and Privacy

  • "No change"

Testing

  • N/A build or packaging only changes

Monitoring and Logging

  • "No change"

@mojito317 mojito317 self-assigned this Dec 17, 2021

@emlaver emlaver left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! A couple of comments

Comment thread MIGRATION.md Outdated
1. Replay adapters are replaced by the [automatic retries](https://github.
com/IBM/ibm-cloud-sdk-common/#automatic-retries) feature for failed requests.
1. Error handling is not transferable from `python-cloudant` to `cloudant-python-sdk`. For more information go to the [Error handling section](https://cloud.ibm.com/apidocs/cloudant?code=python#error-handling) in our API docs.
1. Configuring HTTP client is not transferable from `python-cloudant` to `python-java-sdk`. For more information go to the [Configuring the HTTP client section(https://githubcom/IBM/ibm-cloud-sdk-common/#configuring-the-http-client) in the IBM Cloud SDK Common README.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should say something like:

Suggested change
1. Configuring HTTP client is not transferable from `python-cloudant` to `python-java-sdk`. For more information go to the [Configuring the HTTP client section(https://githubcom/IBM/ibm-cloud-sdk-common/#configuring-the-http-client) in the IBM Cloud SDK Common README.
1. Custom HTTP client configurations in `python-cloudant` are not transferable to `python-java-sdk`. For more information go to the [Configuring the HTTP client section(https://githubcom/IBM/ibm-cloud-sdk-common/#configuring-the-http-client) in the IBM Cloud SDK Common README.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 697ad31

Comment thread MIGRATION.md Outdated
|`Document(db, '_local/docid').fetch()`|[`getLocalDocument`](https://cloud.ibm.com/apidocs/cloudant?code=python#getlocaldocument)|
|`Document(db, '_local/docid').save()`|[`putLocalDocument`](https://cloud.ibm.com/apidocs/cloudant?code=python#putlocaldocument)|
|`Document(db, '_local/docid').delete()`|[`deleteLocalDocument`](https://cloud.ibm.com/apidocs/cloudant?code=python#deletelocaldocument)|
|`db.missing_revisions()/db.revisions_diff`|[`postRevsDiff`](https://cloud.ibm.com/apidocs/cloudant?code=python#postrevsdiff)|

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|`db.missing_revisions()/db.revisions_diff`|[`postRevsDiff`](https://cloud.ibm.com/apidocs/cloudant?code=python#postrevsdiff)|
|`db.missing_revisions()/db.revisions_diff()`|[`postRevsDiff`](https://cloud.ibm.com/apidocs/cloudant?code=python#postrevsdiff)|

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 697ad31

@mojito317 mojito317 merged commit c2ffcd6 into master Dec 21, 2021
@mojito317 mojito317 deleted the improve-migration-guide branch December 21, 2021 09:56
Comment thread MIGRATION.md
1. Replay adapters are replaced by the [automatic retries](https://github.
com/IBM/ibm-cloud-sdk-common/#automatic-retries) feature for failed requests.
1. Error handling is not transferable from `python-cloudant` to `cloudant-python-sdk`. For more information go to the [Error handling section](https://cloud.ibm.com/apidocs/cloudant?code=python#error-handling) in our API docs.
1. Custom HTTP client configurations in `python-cloudant` are not transferable to `python-java-sdk`. For more information go to the [Configuring the HTTP client section(https://githubcom/IBM/ibm-cloud-sdk-common/#configuring-the-http-client) in the IBM Cloud SDK Common README.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is python-java-sdk? Shouldn't it be cloudant-python-sdk?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

woops, will fix it in #512

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay! Thanks!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants