Update README.md #65
Open
Update README.md #65
Conversation
This file contains hidden or 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
# Documentation Update: Authorization Token Clarification In the context **docs: Add proper Authorization-Token documentation in README** With this update, the authenticity factor of the API authentication has been improved with clearer documentation on the usage of the Authorization-Token. **Changes - Introduced a "Authorization" section for Usage - Recorded the base64 encoding format: `username:password` – Offered an example with sample credentials - Added information on using the token in API requests Rationale - Makes it easier for new users to understand the base64 authentication process - Acts as example with easy accessibility - Enhances onboarding processes and decreases customer inquiries - Makes the process of authentication clear **EXAMPLE PROVIDED:** Username: foo Password: foo To enable base64 decoding, ``` UCT This way, users easily create the right Authorization Tokens without the need for guesswork.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Documentation Update: Authorization Token Clarification
In the context
docs: Add proper Authorization-Token documentation in README
With this update, the authenticity factor of the API authentication has been improved with clearer documentation on the usage of the Authorization-Token.
**Changes
Introduced a "Authorization" section for Usage
Recorded the base64 encoding format:
username:password– Offered an example with sample credentialsAdded information on using the token in API requests Rationale
Makes it easier for new users to understand the base64 authentication process
Acts as example with easy accessibility
Enhances onboarding processes and decreases customer inquiries
Makes the process of authentication clear EXAMPLE PROVIDED:
Username: foo
Password: foo To enable base64 decoding, ```
UCT This way, users easily create the right Authorization Tokens without the need for guesswork.