ortelius-ms-validate-user

May 14, 2024 ยท View on GitHub

Environments to Applications report microservices

Release license

Build MegaLinter CodeQL OpenSSF
-Scorecard

Discord

Version 0.1.0

ortelius-ms-validate-user

Path Table

MethodPathDescription
GET/healthHealth
GET/msapi/validateuserValidateuser

Reference Table

NamePathDescription
DomainList#/components/schemas/DomainList
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/validateuser

  • Summary
    Validateuser

Parameters(Query)

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

Responses

  • 200 Successful Response

application/json

{
  domains?: integer[]
}
  • 422 Validation Error

application/json

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

References

#/components/schemas/DomainList

{
  domains?: integer[]
}

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