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

Add more information about the purpose of each key in the JSON spec #41

Open
SchoolGuy opened this issue Jul 4, 2021 · 2 comments
Open
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@SchoolGuy
Copy link
Member

Currenty we have an empty table when trying to describe what purpose the keys in our JSON model have. i now found with reading the cobbler/cobbler code at least the purpose of the signatures key. Additionally we have the description of some of the keys already in the docstring of the code of our llibrary.

Purpose of the signatures is the following: It represents the portion of the path from the root of the repository which may indentify the os version. This must be always one or more paths relative from the root of the ISO. If no values in this array are present the attribute should be considered invalid.

@SchoolGuy SchoolGuy added the documentation Improvements or additions to documentation label Jul 4, 2021
@SchoolGuy SchoolGuy added this to the v0.2.0 milestone Apr 16, 2024
@SchoolGuy
Copy link
Member Author

This issue has gotten more priority since I was asked by people in the community multiple times what the functionality of the keys is actually doing and I didn't have any reference at hand.

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

No branches or pull requests

1 participant