Skip to content

Latest commit

 

History

History
184 lines (132 loc) · 3.09 KB

README.md

File metadata and controls

184 lines (132 loc) · 3.09 KB

ortelius-ms-textfile-crud

Release license

Build MegaLinter CodeQL OpenSSF -Scorecard

Discord

Version 10.0.0

RestAPI endpoint for retrieving SBOM data to a component

Path Table

Method Path Description
GET /health Health
GET /msapi/textfile Get File Content
POST /msapi/textfile Save File Content

Reference Table

Name Path Description
FileRequest #/components/schemas/FileRequest
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/textfile

  • Summary
    Get File Content

Parameters(Query)

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

Responses

  • 200 Successful Response

application/json

{}
  • 422 Validation Error

application/json

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

[POST]/msapi/textfile

  • Summary
    Save File Content

RequestBody

  • application/json
{
  compid?: integer
  filetype?: string
  file?: string[]
}

Responses

  • 200 Successful Response

application/json

{}
  • 422 Validation Error

application/json

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

References

#/components/schemas/FileRequest

{
  compid?: integer
  filetype?: string
  file?: string[]
}

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