docs(schema): #13 - improve json property descriptions#17
Open
jeanbaptisterevel wants to merge 1 commit into
Open
docs(schema): #13 - improve json property descriptions#17jeanbaptisterevel wants to merge 1 commit into
jeanbaptisterevel wants to merge 1 commit into
Conversation
jeanbaptisterevel
force-pushed
the
docs/improve-json-property-descriptions
branch
2 times, most recently
from
521094d to
1e575f7
Compare
Djaytan
requested changes
Jul 15, 2025
| "resources": { | ||
| "type": "object", | ||
| "description": "Resource requests and limits.", | ||
| "description": "Kubernetes resource constraints for the container, used to control CPU, memory, and ephemeral storage usage. See: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes", |
Owner
There was a problem hiding this comment.
Ends with dot even if the last element is an URL.
| }, | ||
| "memory": { | ||
| "type": "string", | ||
| "description": "Maximum amount of memory requested (e.g., '8Gi').See: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes" |
| "memory": { "type": "string" } | ||
| "ephemeralStorage": { | ||
| "type": "string", | ||
| "description": "Maximum amount of ephemeral (temporary) storage requested (e.g., '10Gi').See: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes" |
jeanbaptisterevel
force-pushed
the
docs/improve-json-property-descriptions
branch
from
1e575f7 to
80f68df
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
2 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.
Improve descriptions of properties in the json schema.
I'm not sure this is exactly what you asked for, I'm having a hard time making these descriptions more accurate...
Closes #13