Update Addon API documentation : Add test environment details #337
Conversation
This file contains 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
|
Deployment has finished 👁️👄👁️ Your app is available here |
|
Hi @allemas, you can already check the editorial linter warnings related to this file to modify it. |
juliamrch
added
documentation
miton18
approved these changes
Aug 13, 2024
davlgd
force-pushed
the
marketplace-doc
branch
from
dde6dc1 to
6f64ca4
Compare
|
🚀 You updated your review app. Check it here |
juliamrch
requested changes
Sep 6, 2024
| @@ -66,9 +66,10 @@ Fields | |||
|
|
|||
| * `api/production/sso_url` - The production endpoint for single sign-on. | |||
|
|
|||
| * `api/test/base_url` - The test endpoint on which Clever Cloud sends actions requests. Used to test your service when you create an add-on provider. After the add-on creation,`api/production/base_url` is used. | |||
| * `api/test/base_url` - The test endpoint on which Clever Cloud sends actions requests. Used to test your service when you create an add-on provider. After the add-on creation,`api/production/base_url` is used. If you're **not using** a test environment, set the same value as `api/production/base_url`. | |||
There was a problem hiding this comment.
"After the add-on creation,api/production/base_url is used" : by who or by what @allemas ?
Suggested change
| * `api/test/base_url` - The test endpoint on which Clever Cloud sends actions requests. Used to test your service when you create an add-on provider. After the add-on creation,`api/production/base_url` is used. If you're **not using** a test environment, set the same value as `api/production/base_url`. | |
| * `api/test/base_url` - The test endpoint on which Clever Cloud sends actions requests. Use it to test your service when you create an add-on provider. After the add-on creation,`api/production/base_url` is used. If you're **not using** a test environment, set the same value as `api/production/base_url`. |
|
|
||
| * `api/test/sso_url` - The test endpoint for single sign-on. Used to test your service when you create an add-on provider. After that, the `api/production/sso_url` is used. | ||
| * `api/test/sso_url` - The test endpoint for single sign-on. Used to test your service when you create an add-on provider. After that, the `api/production/sso_url` is used. If you're **not using** a test environment, set the same value as |
There was a problem hiding this comment.
"the api/production/sso_url is used": idem
Suggested change
| * `api/test/sso_url` - The test endpoint for single sign-on. Used to test your service when you create an add-on provider. After that, the `api/production/sso_url` is used. If you're **not using** a test environment, set the same value as | |
| * `api/test/sso_url` - The test endpoint for single sign-on. Use it to test your service when you create an add-on provider. After that, the `api/production/sso_url` is used. If you're **not using** a test environment, set the same value as |
juliamrch
temporarily deployed
to
PR review apps
GitHub Actions
Inactive
|
🚀 You updated your review app. Check it here |
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.
Describe your PR
In clever's internal functioning, if there is no test environment, the addon doesn't work properly.
I've added a note to this subject in the document, specifying that if there is no test environment, the same thing must be entered as for “prod”.