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

Support for Multiple Notes, Products, and IDs #780

Open
santosomar opened this issue Aug 28, 2024 · 3 comments
Open

Support for Multiple Notes, Products, and IDs #780

santosomar opened this issue Aug 28, 2024 · 3 comments
Assignees

Comments

@santosomar
Copy link
Contributor

Note: Background information in #773

As discussed in our TC meeting on 2024-08-28, there were two issues presented in #773 . This issue is to address the challenge that there's currently no mechanism to bind a specific note instance to an individual product_id or a set of product_ids.

@santosomar
Copy link
Contributor Author

Tagging @DarioCiccarone

@santosomar
Copy link
Contributor Author

santosomar commented Sep 25, 2024

As discussed in the TC meeting on September 25, 2024, we have agreed to include the addition of notes in product groups within CSAF 2.1. This enhancement will enable users to provide contextual information, explanations, or important details related to specific product groups.

@tschmidtb51
Copy link
Contributor

We didn't had a formal motion, so here is the suggestion for the TC as JSON schema:

    "notes_t": {
      "title": "List of notes",
      "description": "Contains notes which are specific to the current context.",
      "type": "array",
      "minItems": 1,
      "items": {
        "title": "Note",
        "description": "Is a place to put all manner of text blobs related to the current context.",
        "type": "object",
        "required": [
          "category",
          "text"
        ],
        "properties": {
          "audience": {
            "title": "Audience of note",
            "description": "Indicates who is intended to read it.",
            // ...
          },
          "category": {
            "title": "Note category",
            "description": "Contains the information of what kind of note this is.",
            // ...
          },
          "text": {
            "title": "Note content",
            "description": "Holds the content of the note. Content varies depending on type.",
            // ...
          },
          "title": {
            "title": "Title of note",
            "description": "Provides a concise description of what is contained in the text of the note.",
            // ...
          },
          "group_ids": {
                  "$ref": "#/$defs/product_groups_t"
          },
          "product_ids": {
                  "$ref": "#/$defs/products_t"
         },
        }
      }
    },

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