Repository navigation
docs: user guides, dashboard terms for API keys, LICENSE - #9
Merged
Merged
Conversation
- README: installation, quick start, creating an API key under Account -> Credentials -> API Keys, calls without a key, errors, API overview. - Guides under docs/: client configuration, resources, sessions, errors and retries. - CHANGELOG: unreleased changes under [Unreleased], released entries limited to user-facing changes, compare links for every version. - YARD comments and the missing-key error message use the dashboard's names. - Gem summary and description in user terms; changelog and documentation links per version.
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
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.
User documentation for the SDK.
OctaSpace dashboard (Account → Credentials → API Keys), the calls that work
without a key, error handling, an API overview mapped to the dashboard
sections.
docs/: client configuration, resources, sessions, errorsand retries.
[Unreleased], released entrieslimited to user-facing changes, a compare link for every version.
dashboard's names.
documentation links per version.
MIT-LICENSE; the gem ships it.