Skip to content

[DOCS]: complete ProtoBuf schema annotations/comments #538

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

Closed
jkowalleck opened this issue Nov 6, 2024 · 1 comment · Fixed by #539
Closed

[DOCS]: complete ProtoBuf schema annotations/comments #538

jkowalleck opened this issue Nov 6, 2024 · 1 comment · Fixed by #539
Assignees
Labels
CDX 1.6 related to release v1.6 documentation
Milestone

Comments

@jkowalleck
Copy link
Member

the protobuf schema needs to be revisit,
and where missing, some documentation annotations need to be added.

the documentation should be taken from JSON schema file, as it is the textual equivalent to the human-readable specification.

to keep docs mandatory, enable the linter rule "COMMENTS" (except for legacy schema files)

@jkowalleck jkowalleck added CDX 1.6 related to release v1.6 documentation labels Nov 6, 2024
@jkowalleck jkowalleck added this to the 1.6.1 milestone Nov 6, 2024
@jkowalleck jkowalleck self-assigned this Nov 6, 2024
@jkowalleck
Copy link
Member Author

i work on this ASAP

@jkowalleck jkowalleck changed the title [DOCS]: complete ProtoBuf schemaannotations [DOCS]: complete ProtoBuf schema annotations/comments Nov 6, 2024
n1ckl0sk0rtge pushed a commit to n1ckl0sk0rtge/specification that referenced this issue Feb 11, 2025
fixes CycloneDX#538 

texts were taken from the human-readable Spec CycloneDX 1.6.0

---------

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
n1ckl0sk0rtge pushed a commit to n1ckl0sk0rtge/specification that referenced this issue Feb 11, 2025
fixes CycloneDX#538 

texts were taken from the human-readable Spec CycloneDX 1.6.0

---------

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CDX 1.6 related to release v1.6 documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant