ortelius-ms-dep-pkg-cud

Version 10.0.0

RestAPI endpoint for adding SBOM data to a component

Path Table

Method	Path	Description
GET	/health	Health
GET	/msapi/deppkg	Sbom Type
POST	/msapi/deppkg/cyclonedx	Cyclonedx
POST	/msapi/deppkg/spdx	Spdx
POST	/msapi/deppkg/safety	Safety
POST	/msapi/purl2comp	Purl2Comp

Reference Table

Name	Path	Description
HTTPValidationError	#/components/schemas/HTTPValidationError
StatusMsg	#/components/schemas/StatusMsg
ValidationError	#/components/schemas/ValidationError

Path Details

---

[GET]/health

• Summary
  Health

• Description
  This health check end point used by Kubernetes

Responses

• 200 Successful Response

application/json

{
  status?: string
  service_name?: string
}

---

[GET]/msapi/deppkg

• Summary
  Sbom Type

• Description
  This is the end point used determine the type of SBOM format this microservice can handle

Responses

• 200 Successful Response

application/json

{}

---

[POST]/msapi/deppkg/cyclonedx

• Summary
  Cyclonedx

• Description
  This is the end point used to upload a CycloneDX SBOM

Parameters(Query)

compid: integer

Responses

• 200 Successful Response

application/json

{}

• 422 Validation Error

application/json

{
  detail: {
    loc?: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

---

[POST]/msapi/deppkg/spdx

• Summary
  Spdx

• Description
  This is the end point used to upload a SPDX SBOM

Parameters(Query)

compid: integer

Responses

• 200 Successful Response

application/json

{}

• 422 Validation Error

application/json

{
  detail: {
    loc?: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

---

[POST]/msapi/deppkg/safety

• Summary
  Safety

• Description
  This is the end point used to upload a Python Safety SBOM

Parameters(Query)

compid: integer

Responses

• 200 Successful Response

application/json

{}

• 422 Validation Error

application/json

{
  detail: {
    loc?: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

---

[POST]/msapi/purl2comp

• Summary
  Purl2Comp

• Description
  This is the end point used to create a component from a purl

Responses

• 200 Successful Response

application/json

{}

References

#/components/schemas/HTTPValidationError

{
  detail: {
    loc?: Partial(string) & Partial(integer)[]
    msg: string
    type: string
  }[]
}

#/components/schemas/StatusMsg

{
  status?: string
  service_name?: string
}

#/components/schemas/ValidationError

{
  loc?: Partial(string) & Partial(integer)[]
  msg: string
  type: string
}