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

Advisory Schema - Is :description a type of markdown/markup? #698

Open
istrasci opened this issue Aug 21, 2023 · 1 comment
Open

Advisory Schema - Is :description a type of markdown/markup? #698

istrasci opened this issue Aug 21, 2023 · 1 comment
Assignees

Comments

@istrasci
Copy link

Looking at the Schema section of the README, we can see that both gems and rubies have an associated description attribute that says

[String] (required): One or more paragraphs describing the vulnerability. It may contain multiple paragraphs.

My question is, does this text follow some type of markdown/markup formatting? I've seen several advisories that indicate so (containing # Headers, [Some Links](URL), etc.), but I'm wondering if that's coincidental, or if it's always the case. If so, which "flavour" does it follow? And do any of the other string attributes contain markdown/markup as well?

Basically, I'm doing some bundler-audit automation to email the vulnerabilities found. I'd like to run the :description (and possibly other attributes) through some converter to properly format the email HTML.

@istrasci istrasci changed the title Advisory Schema - Is :description a type of markdown/markup Advisory Schema - Is :description a type of markdown/markup? Aug 21, 2023
@postmodern
Copy link
Member

description was not originally supposed to contain markdown, but markdown has gotten into it over the years, when copy/pasted from advisories. You could try to render description and then fallback to raw text on parse errors. Hope that helps.

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

No branches or pull requests

2 participants