README.md

ortelius-ms-dep-pkg-r

Version 10.0.0

RestAPI endpoint for retrieving SBOM data to a component

Path Table

Method	Path	Description
GET	/health	Health
GET	/msapi/deppkg	Get Comp Pkg Deps

Reference Table

Name	Path	Description
DepPkg	#/components/schemas/DepPkg
DepPkgs	#/components/schemas/DepPkgs
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
  Get Comp Pkg Deps

• Description
  This is the end point used to retrieve the component's SBOM (package dependencies)

Parameters(Query)

compid?: Partial(integer) & Partial(null)

appid?: Partial(integer) & Partial(null)

deptype?: string

Responses

• 200 Successful Response

application/json

{
  data: {
    packagename?: string
    packageversion?: string
    pkgtype?: string
    name?: string
    url?: string
    summary?: string
    fullcompname?: string
    compid?: string
    risklevel?: string
    score?: number
  }[]
}

• 422 Validation Error

application/json

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

References

#/components/schemas/DepPkg

{
  packagename?: string
  packageversion?: string
  pkgtype?: string
  name?: string
  url?: string
  summary?: string
  fullcompname?: string
  compid?: string
  risklevel?: string
  score?: number
}

#/components/schemas/DepPkgs

{
  data: {
    packagename?: string
    packageversion?: string
    pkgtype?: string
    name?: string
    url?: string
    summary?: string
    fullcompname?: string
    compid?: string
    risklevel?: string
    score?: number
  }[]
}

#/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
}