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.

Sign up for GitHub

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

Update Addon API documentation : Add test environment details #337

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Update Addon API documentation : Add test environment details #337

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f64ca4
Update Addon API documentation : Add test environment details
allemas Jul 16, 2024
f6da0aa
Merge branch 'main' into marketplace-doc
juliamrch Sep 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions content/doc/marketplace/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,10 @@

* `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`.

Check warning on line 69 in content/doc/marketplace/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is used').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is used').", "location": {"path": "content/doc/marketplace/_index.md", "range": {"start": {"line": 69, "column": 203}}}, "severity": "INFO"}
Copy link
Collaborator

Choose a reason for hiding this comment

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

"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

Check warning on line 71 in content/doc/marketplace/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'single sign-on' instead of 'sign-on'.

Raw Output:
{"message": "[Google.WordList] Use 'single sign-on' instead of 'sign-on'.", "location": {"path": "content/doc/marketplace/_index.md", "range": {"start": {"line": 71, "column": 53}}}, "severity": "WARNING"}

Check warning on line 71 in content/doc/marketplace/_index.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is used').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is used').", "location": {"path": "content/doc/marketplace/_index.md", "range": {"start": {"line": 71, "column": 165}}}, "severity": "INFO"}
Copy link
Collaborator

Choose a reason for hiding this comment

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

"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

`api/production/sso_url`.

## Add-on Provider requests

Expand Down
Loading