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

Converge all messages into a common format strings object #319

Closed
michaelcfanning opened this issue Jan 25, 2019 · 4 comments
Closed

Converge all messages into a common format strings object #319

michaelcfanning opened this issue Jan 25, 2019 · 4 comments
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. design-approved The TC approved the design and I can write the change draft design-improvement e-ballot-3 impact-breaks-consumers impact-breaks-producers merged Changes merged into provisional draft. p1 Priority 1 issue to close resolved-fixed

Comments

@michaelcfanning
Copy link
Contributor

rule.messages would be a dictionary from id to an object which contains various format strings, currently covering plaintext and markdown only (plaintext is required). In future, other formats could fill out this object.

@michaelcfanning michaelcfanning added p1 Priority 1 issue to close design-approved The TC approved the design and I can write the change draft labels Jan 25, 2019
@michaelcfanning
Copy link
Contributor Author

michaelcfanning commented Feb 13, 2019

'run.richTextMessageMimeType' renamed to 'run.markdownMessageMimeType'.
'message.richText' renamed to 'message.markdown'.
'message.richMessageId' deleted.
Create 'multiformatMessageString' object, that holds plain text and markdown message format strings.
'reportingDescriptor.messageStrings' is now a dictionary of these objects, keyed by message id.
'reporting.Descriptor.richMessageStrings' dictionary is deleted.
'toolComponent.globalMessageStrings' now a dictionary of string to multiformat message strings.

@michaelcfanning
Copy link
Contributor Author

This change has been accepted into the 01-24 schema + SDK

@ghost ghost self-assigned this Mar 15, 2019
@ghost ghost changed the title Consider converging all messages into a common format strings object Converge all messages into a common format strings object Mar 16, 2019
@ghost
Copy link

ghost commented Mar 16, 2019

E-BALLOT 3 PROPOSAL

  • Define a multiformatMessageString object with the following properties:
    • text of type string, non-empty, required.
    • markdown of type string, non-empty, optional.
  • In the resource object (it's still there because this is written before Remove current localization mechanism #325):
    • Change the type of the messageStrings property from object with string-valued properties to object with multiformatMessageString-valued properties.
  • In the rule object (it's still there because this is written before Provide full metadata objects for notifications #311):
    • Change the type of the messageStrings property from object with string-valued properties to object with multiformatMessageString-valued properties.
    • Change the type of the help property from string to multiformatMessageString.
    • Remove the richMessageStrings property.
    • Change the type of the help property from message to multiformatMessageString.
  • In the message object:
    • Rename the richText property to markdown.
    • Remove the richMessageId property.
  • In the run object:
    • Remove the richMessageMimeType property.

ghost pushed a commit that referenced this issue Mar 16, 2019
@ghost ghost added change-draft-available merged Changes merged into provisional draft. labels Mar 16, 2019
@ghost
Copy link

ghost commented Apr 6, 2019

Approved in e-ballot-3.

@ghost ghost closed this as completed Apr 6, 2019
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. design-approved The TC approved the design and I can write the change draft design-improvement e-ballot-3 impact-breaks-consumers impact-breaks-producers merged Changes merged into provisional draft. p1 Priority 1 issue to close resolved-fixed
Projects
None yet
Development

No branches or pull requests

1 participant