Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add api details for management API to example, remove token requirement. #31

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dafstone
Copy link

@dafstone dafstone commented Jun 5, 2022

In order to have this client function correctly facing the management API both the api_url and api_version must be specified.

API token is not required for the management API, just an OAuth Token

Pull request type

Jira Link: INT-

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Other (please describe):

How to test this PR

Create an OAuth Token and include it in place of OAUTH_TOKEN, and run the example.

What is the new behavior?

This example previously did not work out of the box because the API was not properly specified for management. Generally, information on how to use this gem is under documented in this repository and on the main storyblok documentation and most examples will not run out of the box due to this problem. I suspect there are similar issues on the content API side but this is the only one I've tested and gotten working.

Other information

The ruby documentation on the Storyblok site generally will not run out of the box due to these issues.

In order to have this client function correctly facing the management API both the api_url and api_version must be specified.

And API token is not required for the managment API, just an OAuth Token
Copy link
Contributor

@joaokamun joaokamun left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants