scalingo / developers-documentation Goto Github PK

To prevent confusion with the token used for our main API.

The details of the object returned by the following API endpoint is missing :
-> https://api.scalingo.com/v1/apps/:app_id/addons/:addon_id/sso

The notifier webhook is still talking about notification and not notifier.
Plus not every params are documented.

Example of endpoint to add:
/v1/apps/APP_ID/stats/cpu/web?since=3&last=true with possibility to substitute swap by cpu and web by the container type.

Related conversation: https://app.intercom.com/a/apps/w4oogu7s/inbox/inbox/all/conversations/12375700009181

The route /account/usage is missing from the documentation.

No account-related endpoints are currently documented (self, update, disabling, etc).

We should specify that the token used for this API is not the same as the one used for the main API.

The limits field is currently missing from payloads in the dev doc.

• Add limits fields in the payload of application (list and show app requests) => https://developers.scalingo.com/apps#list-your-applications and https://developers.scalingo.com/apps#get-a-precise-application
• Explain that the default limits of an app is not returned
• Only limits that was modified by a Scalingo operator is returned in the payload of an application
• Maybe specify the list of app limits type ?

SCM events are missing, for example.

Check if other events are missing.

{
  "id": "5e98705db94df700013b7a30",
  "created_at": "2020-04-16T14:49:01.573Z",
  "type": "link_scm",
  "app_id": "5e98705db94df700013b7a2c",
  "app_name": "sample-node-express-pr1",
  "user": {
    "username": "test",
    "email": "[email protected]",
    "id": "us-5bdndc3-6421-40ef-96f6-c4fd83935a2d"
  },
  "type_data": {
    "repo_name": "test/sample-node-express",
    "linker_username": "test",
    "source": "https://github.com/test/sample-node-express"
  }
}

show to get a single notification platform from its ID

search to get a single notification platform from its name

Inside the returned object of an application, in addition to the url field, which returns either the scalingo app url or the canonical when there is one, it should also return the base url that corresponds to the scalingo app url (e.g exemple-app.scalingo.io).

1. The result panel is not entirely visible
2. it seems the result comes from doc.scalingo.com

POST https://$DB_API_URL/api/databases/[:db_id]/upgrade

Related intercom conv: https://app.intercom.com/a/apps/w4oogu7s/inbox/inbox/all/conversations/12375700034166
Related slack conv: https://scalingo.slack.com/archives/C03T384J3/p1620131383039300

https://developers.scalingo.com/scalingo-json-schema/index

Doc indicates that an array is return even for those singular-resource methods, which is not what the API is actually returning. https://developers.scalingo.com/keys#get-a-precise-ssh-key

https://developers.scalingo.com/scalingo-json-schema/index

Cf this PR https://github.com/Scalingo/go-scalingo/pull/187/files for the response format

We currently have 3 different API and those three APIs use 3 different tokens/auth methods. It would be nice to add a page explaining how the authentication work between those APIs.

The pagination should be in the documentation

Scalingo/scalingo.js#95 (comment)

https://developers.scalingo.com/notifiers#update-a-notification

And the params are not notification but notifier

• backup create
• DB update automatic backup and scheduled at
• PITR restore endppoint

https://developers.scalingo.com/notifications#add-a-notification

GET /scm_integrations/:id/search_repos?query=XXX

GET /scm_integrations/:id/search_pull_requests?query=XXX

GET /scm_integrations/:id/orgs

https://developers.scalingo.com/notifiers#data-sent-to-the-webhook-endpoint-non-slack

States "At the moment only deployment events are sent." which is wrong. There are a lot of events sent.

Moreover we should double check the content of the HTTP request.