Merge pull request #1223 from CVEProject/jd-1131

Resolves #1131 and #1210 Updated documentation to explain server populated, optional fields, removed unused files
CVEProject · Apr 30, 2024 · 73e1bae · 73e1bae
2 parents 36e9716 + 898d863
commit 73e1bae
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 1,876 deletions.
diff --git a/api-docs/openapi.json b/api-docs/openapi.json
@@ -1388,7 +1388,7 @@
           }
         },
         "requestBody": {
-          "description": "Note: providerMetadata is set by the server. If provided, it will be overwritten.",
+          "description": "<h3>Notes:</h3>  <ul>  <li>**providerMetadata** is set by the server. If provided, it will be overwritten.</li>  <li>**datePublished** and **assignerShortname** are optional fields in the schema, but are set by the server. </li>  </ul>",
           "required": true,
           "content": {
             "application/json": {
@@ -1489,7 +1489,7 @@
           }
         },
         "requestBody": {
-          "description": "Note: providerMetadata is set by the server. If provided, it will be overwritten.",
+          "description": "<h3>Notes:</h3>  <ul>  <li>**providerMetadata** is set by the server. If provided, it will be overwritten.</li>  <li>**datePublished** and **assignerShortname** are optional fields in the schema, but are set by the server. </li>  </ul>",
           "required": true,
           "content": {
             "application/json": {
@@ -1592,7 +1592,7 @@
           }
         },
         "requestBody": {
-          "description": "Note: providerMetadata is set by the server. If provided, it will be overwritten.",
+          "description": "<h3>Notes:</h3>  <ul>  <li>**providerMetadata** is set by the server. If provided, it will be overwritten.</li>  <li>**datePublished** and **assignerShortname** are optional fields in the schema, but are set by the server. </li>  </ul>",
           "required": true,
           "content": {
             "application/json": {
@@ -1693,7 +1693,7 @@
           }
         },
         "requestBody": {
-          "description": "Note: providerMetadata is set by the server. If provided, it will be overwritten.",
+          "description": "<h3>Notes:</h3>  <ul>  <li>**providerMetadata** is set by the server. If provided, it will be overwritten.</li>  <li>**datePublished** and **assignerShortname** are optional fields in the schema, but are set by the server. </li>  </ul>",
           "required": true,
           "content": {
             "application/json": {