Skip to content

Commit

Permalink
Fixed broken links in API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Rachel Nascimento committed Dec 23, 2024
1 parent 46edde4 commit 4e7a98f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions content/api/howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ You need to set a callback URL, this is the url your user will be redirected to

#### **Get a request token**

You have to make a `POST`request to get a [request token](/api/v2/#post-/oauth/request_token) to the API.
You have to make a `POST`request to get a [request token](/developers/api/v2/#post-/oauth/request_token) to the API.

#### **Get the authorization URL**

Ask the API for the [authorization URL](/api/v2/#get-/oauth/authorize) and go to this URL with a browser. Log in with your account and it will send you to the callback URL.
Ask the API for the [authorization URL](/developers/api/v2/#get-/oauth/authorize) and go to this URL with a browser. Log in with your account and it will send you to the callback URL.

Check warning on line 62 in content/api/howto.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/api/howto.md#L62

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "content/api/howto.md", "range": {"start": {"line": 62, "column": 150}}}, "severity": "WARNING"}

#### **Get the verifier token**

Expand All @@ -71,7 +71,7 @@ Where `<verifierToken>` is your token.

#### **Get the access token**

Make a `POST` request to get the [access token](/api/v2/#post-/oauth/access_token) with your request token and the verifier.
Make a `POST` request to get the [access token](/developers/api/v2/#post-/oauth/access_token) with your request token and the verifier.
You can use this access token to make OAuth1 signed requests.

More information about [OAuth dance](https://oauth.net/core/1.0/#anchor9).
Expand All @@ -88,8 +88,8 @@ All the API endpoints are referenced in a swagger documentation. **The base URL

{{< cards >}}

{{< card link="/api/v2" title="Base v2 Endpoints" subtitle="Our base API endpoints with users, organisations, applications, add-ons, etc." icon="endpoints" >}}
{{< card link="/api/v4" title="New v4 Endpoints" subtitle="More recent API endpoints with billing, deployments, load balancers, logs, etc." icon="new" >}}
{{< card link="/developers/api/v2/" title="Base v2 Endpoints" subtitle="Our base API endpoints with users, organisations, applications, add-ons, etc." icon="endpoints" >}}
{{< card link="/developers/api/v4/" title="New v4 Endpoints" subtitle="More recent API endpoints with billing, deployments, load balancers, logs, etc." icon="new" >}}

{{< /cards >}}

Expand Down
2 changes: 1 addition & 1 deletion content/api/v4.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ keywords:
- endpoint
- v4
---
Clever Cloud provides a public REST API used by its own services and customers, known as [`/v2`](/api/v2).
Clever Cloud provides a public REST API used by its own services and customers, known as [`/v2`](/developers/api/v2/).

Check notice on line 12 in content/api/v4.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/api/v4.md#L12

[Google.Acronyms] Spell out 'REST', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'REST', if it's unfamiliar to the audience.", "location": {"path": "content/api/v4.md", "range": {"start": {"line": 12, "column": 32}}}, "severity": "INFO"}
As our platform evolves, we're progressively moving to `/v4` endpoints, adding functionalities, with a more modern approach:
```
https://api.clever-cloud.com/v4/
Expand Down

0 comments on commit 4e7a98f

Please sign in to comment.