Skip to content

chore(docs): fix readme credentials section headings - #561

Merged
aaguiarz merged 1 commit into
mainfrom
codex/remove--auth0-client-credentials--mentions
Jun 16, 2025
Merged

chore(docs): fix readme credentials section headings#561
aaguiarz merged 1 commit into
mainfrom
codex/remove--auth0-client-credentials--mentions

Conversation

@aaguiarz

@aaguiarz aaguiarz commented Jun 16, 2025

Copy link
Copy Markdown
Member

Summary

  • clean up README templates
  • fix credential titles for OAuth setup

Testing

  • make test (fails: docker not found)

https://chatgpt.com/codex/tasks/task_e_685053a95eb4832280d734b3d6173a31

Summary by CodeRabbit

  • Documentation
    • Updated section headings in the README templates from "Auth0 Client Credentials" to "Client Credentials" for improved clarity.

@aaguiarz
aaguiarz requested a review from a team as a code owner June 16, 2025 17:41
@coderabbitai

coderabbitai Bot commented Jun 16, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The changes consist of updating a section header in two README template files for Go and Java clients. The header "Auth0 Client Credentials" has been renamed to "Client Credentials" in both files. No code, logic, or example content was modified.

Changes

Files Change Summary
config/clients/go/template/README_initializing.mustache Renamed section header from "Auth0 Client Credentials" to "Client Credentials".
config/clients/java/template/README_initializing.mustache Renamed section header from "Auth0 Client Credentials" to "Client Credentials".

Poem

A header changed, so neat and slight,
From "Auth0" to "Client"—just right!
No code was touched, no logic bent,
Just words improved, with kind intent.
README shines with clarity new,
The rabbits hop—this update’s through!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f5dd0b8 and 4c141f2.

📒 Files selected for processing (2)
  • config/clients/go/template/README_initializing.mustache (1 hunks)
  • config/clients/java/template/README_initializing.mustache (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: build-and-test-java-sdk
  • GitHub Check: build-and-test-python-sdk
  • GitHub Check: build-and-test-js-sdk
  • GitHub Check: build-and-test-go-sdk
  • GitHub Check: build-and-test-dotnet-sdk
  • GitHub Check: Analyze (actions)
🔇 Additional comments (2)
config/clients/java/template/README_initializing.mustache (1)

52-52: Genericize credentials section heading
The header has been updated from the Auth0-specific label to a generic “Client Credentials,” improving clarity and aligning with other language templates.

config/clients/go/template/README_initializing.mustache (1)

54-54: Genericize credentials section heading
The heading was renamed from “Auth0 Client Credentials” to “Client Credentials,” matching the Java template and avoiding provider-specific terminology.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@rhamzeh rhamzeh changed the title Fix credentials section headings chore(docs): fix readme credentials section headings Jun 16, 2025
@aaguiarz
aaguiarz added this pull request to the merge queue Jun 16, 2025
Merged via the queue into main with commit 6b3bc32 Jun 16, 2025
@aaguiarz
aaguiarz deleted the codex/remove--auth0-client-credentials--mentions branch June 16, 2025 18:37
rhamzeh pushed a commit to openfga/java-sdk that referenced this pull request Jul 1, 2025
github-merge-queue Bot pushed a commit to openfga/java-sdk that referenced this pull request Jul 1, 2025
* fix(client): fix passing model ID in BatchCheck

bringing the openfga/sdk-generator#555 from the generator

* chore(docs): fix typo in README

source: openfga/sdk-generator#561

* chore: remove unnecessary if condition

source: openfga/sdk-generator#546

---------

Co-authored-by: Andrés Aguiar <andres.aguiar@gmail.com>
Co-authored-by: AlessandroMinoccheri <aminoccheri@inpost.it>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants