README.md

ortelius-ms-scorecard

Version 0.1.0

ortelius-ms-scorecard

Path Table

Method	Path	Description
GET	/health	Health
GET	/msapi/scorecard	Get Scorecard

Reference Table

Name	Path	Description
HTTPValidationError	#/components/schemas/HTTPValidationError
ScoreCard	#/components/schemas/ScoreCard
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/scorecard

• Summary
  Get Scorecard

Parameters(Query)

frequency?: Partial(string) & Partial(null)

environment?: Partial(string) & Partial(null)

lag?: Partial(string) & Partial(null)

appname?: Partial(string) & Partial(null)

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

Responses

• 200 Successful Response

application/json

{
  domain?: string
[]
[]
}

• 422 Validation Error

application/json

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

References

#/components/schemas/HTTPValidationError

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

#/components/schemas/ScoreCard

{
  domain?: string
[]
[]
}

#/components/schemas/StatusMsg

{
  status?: string
  service_name?: string
}

#/components/schemas/ValidationError

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