Skip to content

Mark merge SBOM API as an experimental feature

Aditya Tiwari requested to merge 333463-export-api-doc into master

What does this MR do and why?

Mark merge SBOM API as an experimental feature. As a part of CycloneDX SBOM export for a CI pipelinewe have introduced a new API endpoint. The ask is to mark it Experimental.

More info: As a part of #333463 (closed) we have introduced documentation for following 3 endpoints out of which 2 endpoints were pre-existing and used by our frontend application. The documentation for the 2 endpoints were not present.

| POST /pipelines/:id/dependency_list_exports | Newly introduced endpoint | newly documented| |

| GET /security/dependency_list_exports/:id | Pre-existing endpoint | newly documented |

| GET /security/dependency_list_exports/:id/download | Pre-existing endpoint | newly documented |

Documentation can be found here.

Since, the 2 out of 3 endpoints are already used by FE and stable, we mark only the newly introduced endpoint experimental.

Screenshots or screen recordings

Screenshot_2023-09-15_at_2.57.01_PM

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #333463 (closed) and #425125 (closed)

Edited by Aditya Tiwari

Merge request reports