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

Jump to bottom

Remove the unsupported "plan change" section for the addon provider #441

Merged
merged 3 commits into from
Nov 26, 2024
Merged

Remove the unsupported "plan change" section for the addon provider #441

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53dcf0f
Remove the unsupported "plan change" section for the addon provider
Nov 19, 2024
394f39b
remove reference to "plan change" endpoint
Nov 23, 2024
5534e3c
Merge branch 'main' into fix_addon_provider_enpoint
cnivolle Nov 26, 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
34 changes: 1 addition & 33 deletions content/doc/marketplace/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@

* `api/regions` - The list of geographical zones supported by your add-on. It cannot be empty. As for now, it *MUST* contain the element "eu". More will be supported.

* `api/production/base_url` - The production endpoint on which Clever Cloud sends actions requests (provision, deprovision, and plan change).
* `api/production/base_url` - The production endpoint on which Clever Cloud sends actions requests (provision and deprovision).

Check failure on line 65 in content/doc/marketplace/_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/doc/marketplace/_index.md#L65 

[Vale.Spelling] Did you really mean 'deprovision'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'deprovision'?", "location": {"path": "content/doc/marketplace/_index.md", "range": {"start": {"line": 65, "column": 115}}}, "severity": "ERROR"}

* `api/production/sso_url` - The production endpoint for single sign-on.

Expand Down Expand Up @@ -148,38 +148,6 @@

* `addon_id` - This is the same as the `id` field set in the response to the provisioning call.

cnivolle marked this conversation as resolved.
Show resolved Hide resolved
### Plan change

When a customer wants to change its add-on's plan, Clever Cloud issues a PUT request to your service.

The request will be the following:

```json
Request: PUT {base_url}/{addon_id}
Request Body: {
"addon_id": "addon_xxx",
"plan": "premium"
}
Response Body: {
"config": { ... },
"message": "your message here"
}
```

* `addon_id` - This is the same as the `id` field set in the response to the provisioning call.

The request body contains:

* `addon_id` - The add-on's id as seen from our side.

* `plan` - The name of the new plan.

The response body contains:

* `config` - The value for the new config map. Same constraints as in the provisioning response.

* `message` - A message displayed in our dashboard.

### Examples

You can find templates for add-on providers in various languages on GitHub:
Expand Down
Loading