Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

[MIGRATION] Add note about authentication errors and server errors #512

Merged
merged 6 commits into from
Jan 11, 2022

Conversation

mojito317
Copy link
Contributor

@mojito317 mojito317 commented Jan 3, 2022

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

There have been some questions regarding migration lately. This PR tries to address them.

Approach

I clarified some of the questionable topics in this change:

  • where users should check the server errors and the authentication errors

I also fixed a typo from python-java-sdk to cloudant-python-sdk

My IDE lately breaks the lines automatically, I have not figured out how I can turn it off yet, but I think this is a great feature, and it helps the reviewers to read the long lines more effectively, so I kept these modifications.

Schema & API Changes

  • "No change"

Security and Privacy

  • "No change"

Testing

  • N/A

Monitoring and Logging

  • "No change"

@mojito317 mojito317 changed the title Add note about authentication errors and server errors [MIGRATION] Add note about authentication errors and server errors Jan 3, 2022
@mojito317 mojito317 mentioned this pull request Jan 3, 2022
4 tasks
MIGRATION.md Outdated
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.
1. Custom HTTP client configurations in `python-cloudant` are not transferable to
`cloudant-python-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

Choose a reason for hiding this comment

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

Suggested change
(https://githubcom/IBM/ibm-cloud-sdk-common/#configuring-the-http-client) in the IBM Cloud SDK Common README.
(https://github.com/IBM/ibm-cloud-sdk-common/#configuring-the-http-client) in the IBM Cloud SDK Common README.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in d8a1756

@mojito317 mojito317 requested a review from vmatyus January 6, 2022 12:30
MIGRATION.md Outdated
`cloudant-python-sdk`. For more information go to the [Configuring the HTTP client section
(https://github.com/IBM/ibm-cloud-sdk-common/#configuring-the-http-client) in the IBM Cloud
SDK Common README.
1. Authentication errors turn out at the time of instantiation of a client, while errors
Copy link

Choose a reason for hiding this comment

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

Would you plan to update this chapter too, like you did with java and nodejs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, I just need to figure out what is the authentication error message first

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in 15a9b60

Copy link

@vmatyus vmatyus left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@emlaver emlaver self-requested a review January 7, 2022 17:51
@mojito317
Copy link
Contributor Author

Thanks for the reviews @emlaver, @vmatyusGitHub! I am merging this!

@mojito317 mojito317 merged commit 5b1ecc2 into master Jan 11, 2022
@mojito317 mojito317 deleted the improve-migration-guide branch January 11, 2022 13:21
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.

3 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.