docs: improve and include provider schema description#994
Open
docs: improve and include provider schema description#994
Conversation
d0weinberger
previously approved these changes
Feb 24, 2026
Collaborator
Author
|
I wanted to keep the casing consistent with our current one in |
The provider's schema description was missing from the docs. Now it's included and updated, so every field is described.
Aligned casing, such as `Platform`, `Token`, `Provider`, `Environment`, to be lowercase. `REST API` => `API`
Kirdock
force-pushed
the
docs/provider-schema-description
branch
from
a65c317 to
698b461
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why this PR?
The provider's schema description was missing from the docs.
What has changed?
The provider schema description is now visible.
How does it do it?
By adding the schema to the docs and updating the description of several fields.
How is it tested?
Generated the md file and pasted it into the Doc preview tool
How does it affect users?
They see the provider's updated documentation.
Issue: CA-17407