Skip to content

api(howto): enhance OAuth documentation with example#902

Merged
davlgd merged 1 commit intomainfrom
davlgd-oauth-enhance
Mar 25, 2026
Merged

api(howto): enhance OAuth documentation with example#902
davlgd merged 1 commit intomainfrom
davlgd-oauth-enhance

Conversation

@davlgd
Copy link
Copy Markdown
Collaborator

@davlgd davlgd commented Mar 25, 2026

📝 What does this PR do?

This PR enhances OAuth documentaton with tested examples/code.


🧪 Type of Change

  • ⚠️ Bug fix
  • 📅 Changelog update
  • 📚 Documentation update
  • ✨ New content/feature
  • 🔧 Technical/maintenance

✅ Quick Checklist

@davlgd davlgd requested a review from Copilot March 25, 2026 10:12
@davlgd davlgd self-assigned this Mar 25, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 25, 2026

👋` Review app deleted

You closed this PR and deleted the review app.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR expands the Clever Cloud API “howto” documentation to provide a fuller OAuth 1.0a walkthrough, including concrete request examples and guidance for signing requests.

Changes:

  • Adds a link to a complete OAuth1 example repository (Bun/TypeScript).
  • Replaces the brief OAuth1 “dance” section with a step-by-step flow (request token → authorise → access token).
  • Adds examples for authenticated requests and signature construction (PLAINTEXT + HMAC).

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 5 comments.

Copy link
Copy Markdown
Member

@judu judu left a comment

Choose a reason for hiding this comment

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

I’ve seen one small change to be done, apart from the bots remarks.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Co-Authored-By: Julien Durillon <julien.durillon@clever-cloud.com>
@davlgd davlgd force-pushed the davlgd-oauth-enhance branch from 8f16829 to 439adf9 Compare March 25, 2026 12:55
Copy link
Copy Markdown
Member

@judu judu left a comment

Choose a reason for hiding this comment

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

I guess we should update vale’s configuration to let it ignore URL, TIP and the few others in here. Also, the dash thing has to go 👀

@davlgd davlgd merged commit 7380f9a into main Mar 25, 2026
5 checks passed
@davlgd davlgd deleted the davlgd-oauth-enhance branch March 25, 2026 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants