Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

project.ptx Schema? #368

Closed
siefkenj opened this issue Dec 11, 2022 · 3 comments · Fixed by #372 or #847
Closed

project.ptx Schema? #368

siefkenj opened this issue Dec 11, 2022 · 3 comments · Fixed by #372 or #847
Assignees
Milestone

Comments

@siefkenj
Copy link
Contributor

Is there a schema file for project.ptx? Or is there some way to programmatically generate all valid options?

@StevenClontz
Copy link
Member

Nope, though I think at this point the conventions are stable enough that we should encode what's allowed.

@oscarlevin oscarlevin self-assigned this Apr 14, 2023
@oscarlevin oscarlevin added this to the 1.6 milestone Apr 14, 2023
@oscarlevin
Copy link
Member

Now that we validate the manifest using pydantic, does it still help to have a schema for it? I suppose we could set up pretext-tools to complain when something isn't right based on the schema, which would tell users that there is an issue sooner.

Does pydantic have a way to generate a schema from its document model?

@bjones1
Copy link
Collaborator

bjones1 commented Jan 3, 2024

Having a schema would be nice from an VSCode IDE perspective, where the user could be guided into the correct syntax while editing. However, I don't know any way of auto-generating the schema from pydantic / pydantic-xml; the constraints they support is probably a much richer language than XML's schema.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants