Skip to content

Add content to cumulusci.yml Pydantic models and JSON Schema#3724

Open
jlantz wants to merge 5 commits intoSFDO-Tooling:mainfrom
muselab-d2x:feature/json-schema-content
Open

Add content to cumulusci.yml Pydantic models and JSON Schema#3724
jlantz wants to merge 5 commits intoSFDO-Tooling:mainfrom
muselab-d2x:feature/json-schema-content

Conversation

@jlantz
Copy link
Contributor

@jlantz jlantz commented Dec 19, 2023

Added title, description, and examples to all Pydantic models for the cumulusci.yml json schema to provide better help information in IDEs.

There are a few places where I added enums.

cumulusci.yml json schema to provide better help information in IDEs.

Currently the test to compare the generated schema to the schema file is
failing for reasons I can't understand yet, but the content is ready for
review.
@jlantz jlantz requested a review from a team as a code owner December 19, 2023 18:57
@jstvz
Copy link
Contributor

jstvz commented Jan 9, 2024

@jlantz Looks like the some test failures due to a schema mismatch. I'll push a copy of your branch to the remote to resolve the lint failure afterwards.

max=30,
examples=[1, 7, 30],
)
namespaced: bool = Field(
Copy link
Contributor

Choose a reason for hiding this comment

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

yay! the previous definition was wrong (claimed this was a str) and so YAML checking was failing in VSCode

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants