Skip to content

docs(admin-api): clarify Credential name field description and fix typos - #13837

Open
okaybase wants to merge 1 commit into
apache:masterfrom
okaybase:docs-Credential
Open

docs(admin-api): clarify Credential name field description and fix typos#13837
okaybase wants to merge 1 commit into
apache:masterfrom
okaybase:docs-Credential

Conversation

@okaybase

Copy link
Copy Markdown
Member

Description

This PR clarifies the description of the name field in the Credential API documentation and fixes several typos in the same section.

The name field is an optional name for the Consumer Credential, while {credential_id} in the request path is used to identify the Credential resource. Updating the description avoids confusion between these two values.

This PR also:

  • Fixes three occurrences of NUll to NULL.
  • Fixes the typo Creddential to Credential.

Which issue(s) this PR fixes:

N/A

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list)

@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. doc Documentation things labels Aug 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation things size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants