From dfb71a1cc09c98b1ffa0176a0ce8f0f9739df174 Mon Sep 17 00:00:00 2001
From: Samk <sampurnapyne1710@gmail.com>
Date: Tue, 26 Nov 2024 17:21:34 +0530
Subject: [PATCH] added example for readability

---
 vulnerabilities/pipelines/vmwarephoton_importer.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/vulnerabilities/pipelines/vmwarephoton_importer.py b/vulnerabilities/pipelines/vmwarephoton_importer.py
index 747c1fa3d..077342f68 100644
--- a/vulnerabilities/pipelines/vmwarephoton_importer.py
+++ b/vulnerabilities/pipelines/vmwarephoton_importer.py
@@ -25,6 +25,17 @@
 class VMWAREPHOTONImporterPipeline(VulnerableCodeBaseImporterPipeline):
     """Collect advisories from VMWARE_PHOTON."""
 
+    '''
+    EXAMPLE:
+    {
+    "cve_id": "CVE-2020-11979",
+    "pkg": "apache-ant",
+    "cve_score": 7.5,
+    "aff_ver": "all versions before 1.10.8-2.ph1 are vulnerable",
+    "res_ver": "1.10.8-2.ph1"
+    }
+    '''
+
     pipeline_id = "vmwarephoton_importer"
     repo_url = "https://github.com/vmware/photon/wiki/Security-Advisories"
     spdx_license_expression = "CC BY-SA 4.0"