diff --git a/docs/reference/api/openapi-v1.yaml b/docs/reference/api/openapi-v1.yaml index cbf8e77..5cc5479 100644 --- a/docs/reference/api/openapi-v1.yaml +++ b/docs/reference/api/openapi-v1.yaml @@ -465,7 +465,10 @@ paths: or PROJECT_CREATION_UPLOAD permission.
- MediaType supported for BOM artifact is 'application/xml' or 'application/json'.
+ The BOM artifact may be supplied uncompressed or compressed. If the BOM is uncompressed,
+ the supported MediaType is 'application/xml' or 'application/json'. If the BOM is compressed,
+ the supported MediaType is 'application/gzip' or 'application/zstd' and must match the actual
+ compression of the data.
The BOM will be validated against the CycloneDX schema. If schema validation fails,
a response with problem details in RFC 9457 format will be returned. In this case,
the response's content type will be application/problem+json.