ortelius-ms-compitem-crud

Version 0.1.0

ortelius-ms-compitem-crud

Path Table

Method	Path	Description
GET	/health	Health
GET	/msapi/compitem	Get Compitem
POST	/msapi/compitem	Create Compitem
DELETE	/msapi/compitem	Delete Compitem
PUT	/msapi/compitem	Update Compitem

Reference Table

Name	Path	Description
CompItemModel	#/components/schemas/CompItemModel
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/compitem

• Summary
  Get Compitem

Parameters(Query)

compitemid: integer

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

Responses

• 200 Successful Response

application/json

{
  compid?: integer
  id?: integer
  builddate?: Partial(string) & Partial(null)
  buildid?: Partial(string) & Partial(null)
  buildurl?: Partial(string) & Partial(null)
  chart?: Partial(string) & Partial(null)
  chartnamespace?: Partial(string) & Partial(null)
  chartrepo?: Partial(string) & Partial(null)
  chartrepourl?: Partial(string) & Partial(null)
  chartversion?: Partial(string) & Partial(null)
  created?: Partial(integer) & Partial(null)
  creatorid?: Partial(integer) & Partial(null)
  discordchannel?: Partial(string) & Partial(null)
  dockerrepo?: Partial(string) & Partial(null)
  dockersha?: Partial(string) & Partial(null)
  dockertag?: Partial(string) & Partial(null)
  gitcommit?: Partial(string) & Partial(null)
  gitrepo?: Partial(string) & Partial(null)
  gittag?: Partial(string) & Partial(null)
  giturl?: Partial(string) & Partial(null)
  hipchatchannel?: Partial(string) & Partial(null)
  kind?: Partial(string) & Partial(null)
  modified?: Partial(integer) & Partial(null)
  modifierid?: Partial(integer) & Partial(null)
  name?: Partial(string) & Partial(null)
  pagerdutybusinessurl?: Partial(string) & Partial(null)
  pagerdutyurl?: Partial(string) & Partial(null)
  predecessorid?: Partial(integer) & Partial(null)
  purl?: Partial(string) & Partial(null)
  repository?: Partial(string) & Partial(null)
  rollback?: Partial(integer) & Partial(null)
  rollup?: Partial(integer) & Partial(null)
  serviceowner?: Partial(string) & Partial(null)
  serviceowneremail?: Partial(string) & Partial(null)
  serviceownerid?: Partial(string) & Partial(null)
  serviceownerphone?: Partial(string) & Partial(null)
  slackchannel?: Partial(string) & Partial(null)
  status?: Partial(string) & Partial(null)
  summary?: Partial(string) & Partial(null)
  targetdirectory?: Partial(string) & Partial(null)
  xpos?: Partial(integer) & Partial(null)
  ypos?: Partial(integer) & Partial(null)
  scorecardpinned?: Partial(string) & Partial(null)
  scorecardscore?: Partial(string) & Partial(null)
  binaryartifacts?: Partial(string) & Partial(null)
  branchprotection?: Partial(string) & Partial(null)
  ciibestpractices?: Partial(string) & Partial(null)
  codereview?: Partial(string) & Partial(null)
  dangerousworkflow?: Partial(string) & Partial(null)
  fuzzing?: Partial(string) & Partial(null)
  license?: Partial(string) & Partial(null)
  maintained?: Partial(string) & Partial(null)
  packaging?: Partial(string) & Partial(null)
  pinneddependencies?: Partial(string) & Partial(null)
  sast?: Partial(string) & Partial(null)
  securitypolicy?: Partial(string) & Partial(null)
  signedreleases?: Partial(string) & Partial(null)
  tokenpermissions?: Partial(string) & Partial(null)
  vulnerabilities?: Partial(string) & Partial(null)
}[]

• 422 Validation Error

application/json

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

---

[POST]/msapi/compitem

• Summary
  Create Compitem

RequestBody

• application/json

{
  compid?: integer
  id?: integer
  builddate?: Partial(string) & Partial(null)
  buildid?: Partial(string) & Partial(null)
  buildurl?: Partial(string) & Partial(null)
  chart?: Partial(string) & Partial(null)
  chartnamespace?: Partial(string) & Partial(null)
  chartrepo?: Partial(string) & Partial(null)
  chartrepourl?: Partial(string) & Partial(null)
  chartversion?: Partial(string) & Partial(null)
  created?: Partial(integer) & Partial(null)
  creatorid?: Partial(integer) & Partial(null)
  discordchannel?: Partial(string) & Partial(null)
  dockerrepo?: Partial(string) & Partial(null)
  dockersha?: Partial(string) & Partial(null)
  dockertag?: Partial(string) & Partial(null)
  gitcommit?: Partial(string) & Partial(null)
  gitrepo?: Partial(string) & Partial(null)
  gittag?: Partial(string) & Partial(null)
  giturl?: Partial(string) & Partial(null)
  hipchatchannel?: Partial(string) & Partial(null)
  kind?: Partial(string) & Partial(null)
  modified?: Partial(integer) & Partial(null)
  modifierid?: Partial(integer) & Partial(null)
  name?: Partial(string) & Partial(null)
  pagerdutybusinessurl?: Partial(string) & Partial(null)
  pagerdutyurl?: Partial(string) & Partial(null)
  predecessorid?: Partial(integer) & Partial(null)
  purl?: Partial(string) & Partial(null)
  repository?: Partial(string) & Partial(null)
  rollback?: Partial(integer) & Partial(null)
  rollup?: Partial(integer) & Partial(null)
  serviceowner?: Partial(string) & Partial(null)
  serviceowneremail?: Partial(string) & Partial(null)
  serviceownerid?: Partial(string) & Partial(null)
  serviceownerphone?: Partial(string) & Partial(null)
  slackchannel?: Partial(string) & Partial(null)
  status?: Partial(string) & Partial(null)
  summary?: Partial(string) & Partial(null)
  targetdirectory?: Partial(string) & Partial(null)
  xpos?: Partial(integer) & Partial(null)
  ypos?: Partial(integer) & Partial(null)
  scorecardpinned?: Partial(string) & Partial(null)
  scorecardscore?: Partial(string) & Partial(null)
  binaryartifacts?: Partial(string) & Partial(null)
  branchprotection?: Partial(string) & Partial(null)
  ciibestpractices?: Partial(string) & Partial(null)
  codereview?: Partial(string) & Partial(null)
  dangerousworkflow?: Partial(string) & Partial(null)
  fuzzing?: Partial(string) & Partial(null)
  license?: Partial(string) & Partial(null)
  maintained?: Partial(string) & Partial(null)
  packaging?: Partial(string) & Partial(null)
  pinneddependencies?: Partial(string) & Partial(null)
  sast?: Partial(string) & Partial(null)
  securitypolicy?: Partial(string) & Partial(null)
  signedreleases?: Partial(string) & Partial(null)
  tokenpermissions?: Partial(string) & Partial(null)
  vulnerabilities?: 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
  }[]
}

---

[DELETE]/msapi/compitem

• Summary
  Delete Compitem

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
  }[]
}

---

[PUT]/msapi/compitem

• Summary
  Update Compitem

RequestBody

• application/json

{
  compid?: integer
  id?: integer
  builddate?: Partial(string) & Partial(null)
  buildid?: Partial(string) & Partial(null)
  buildurl?: Partial(string) & Partial(null)
  chart?: Partial(string) & Partial(null)
  chartnamespace?: Partial(string) & Partial(null)
  chartrepo?: Partial(string) & Partial(null)
  chartrepourl?: Partial(string) & Partial(null)
  chartversion?: Partial(string) & Partial(null)
  created?: Partial(integer) & Partial(null)
  creatorid?: Partial(integer) & Partial(null)
  discordchannel?: Partial(string) & Partial(null)
  dockerrepo?: Partial(string) & Partial(null)
  dockersha?: Partial(string) & Partial(null)
  dockertag?: Partial(string) & Partial(null)
  gitcommit?: Partial(string) & Partial(null)
  gitrepo?: Partial(string) & Partial(null)
  gittag?: Partial(string) & Partial(null)
  giturl?: Partial(string) & Partial(null)
  hipchatchannel?: Partial(string) & Partial(null)
  kind?: Partial(string) & Partial(null)
  modified?: Partial(integer) & Partial(null)
  modifierid?: Partial(integer) & Partial(null)
  name?: Partial(string) & Partial(null)
  pagerdutybusinessurl?: Partial(string) & Partial(null)
  pagerdutyurl?: Partial(string) & Partial(null)
  predecessorid?: Partial(integer) & Partial(null)
  purl?: Partial(string) & Partial(null)
  repository?: Partial(string) & Partial(null)
  rollback?: Partial(integer) & Partial(null)
  rollup?: Partial(integer) & Partial(null)
  serviceowner?: Partial(string) & Partial(null)
  serviceowneremail?: Partial(string) & Partial(null)
  serviceownerid?: Partial(string) & Partial(null)
  serviceownerphone?: Partial(string) & Partial(null)
  slackchannel?: Partial(string) & Partial(null)
  status?: Partial(string) & Partial(null)
  summary?: Partial(string) & Partial(null)
  targetdirectory?: Partial(string) & Partial(null)
  xpos?: Partial(integer) & Partial(null)
  ypos?: Partial(integer) & Partial(null)
  scorecardpinned?: Partial(string) & Partial(null)
  scorecardscore?: Partial(string) & Partial(null)
  binaryartifacts?: Partial(string) & Partial(null)
  branchprotection?: Partial(string) & Partial(null)
  ciibestpractices?: Partial(string) & Partial(null)
  codereview?: Partial(string) & Partial(null)
  dangerousworkflow?: Partial(string) & Partial(null)
  fuzzing?: Partial(string) & Partial(null)
  license?: Partial(string) & Partial(null)
  maintained?: Partial(string) & Partial(null)
  packaging?: Partial(string) & Partial(null)
  pinneddependencies?: Partial(string) & Partial(null)
  sast?: Partial(string) & Partial(null)
  securitypolicy?: Partial(string) & Partial(null)
  signedreleases?: Partial(string) & Partial(null)
  tokenpermissions?: Partial(string) & Partial(null)
  vulnerabilities?: 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
  }[]
}

References

#/components/schemas/CompItemModel

{
  compid?: integer
  id?: integer
  builddate?: Partial(string) & Partial(null)
  buildid?: Partial(string) & Partial(null)
  buildurl?: Partial(string) & Partial(null)
  chart?: Partial(string) & Partial(null)
  chartnamespace?: Partial(string) & Partial(null)
  chartrepo?: Partial(string) & Partial(null)
  chartrepourl?: Partial(string) & Partial(null)
  chartversion?: Partial(string) & Partial(null)
  created?: Partial(integer) & Partial(null)
  creatorid?: Partial(integer) & Partial(null)
  discordchannel?: Partial(string) & Partial(null)
  dockerrepo?: Partial(string) & Partial(null)
  dockersha?: Partial(string) & Partial(null)
  dockertag?: Partial(string) & Partial(null)
  gitcommit?: Partial(string) & Partial(null)
  gitrepo?: Partial(string) & Partial(null)
  gittag?: Partial(string) & Partial(null)
  giturl?: Partial(string) & Partial(null)
  hipchatchannel?: Partial(string) & Partial(null)
  kind?: Partial(string) & Partial(null)
  modified?: Partial(integer) & Partial(null)
  modifierid?: Partial(integer) & Partial(null)
  name?: Partial(string) & Partial(null)
  pagerdutybusinessurl?: Partial(string) & Partial(null)
  pagerdutyurl?: Partial(string) & Partial(null)
  predecessorid?: Partial(integer) & Partial(null)
  purl?: Partial(string) & Partial(null)
  repository?: Partial(string) & Partial(null)
  rollback?: Partial(integer) & Partial(null)
  rollup?: Partial(integer) & Partial(null)
  serviceowner?: Partial(string) & Partial(null)
  serviceowneremail?: Partial(string) & Partial(null)
  serviceownerid?: Partial(string) & Partial(null)
  serviceownerphone?: Partial(string) & Partial(null)
  slackchannel?: Partial(string) & Partial(null)
  status?: Partial(string) & Partial(null)
  summary?: Partial(string) & Partial(null)
  targetdirectory?: Partial(string) & Partial(null)
  xpos?: Partial(integer) & Partial(null)
  ypos?: Partial(integer) & Partial(null)
  scorecardpinned?: Partial(string) & Partial(null)
  scorecardscore?: Partial(string) & Partial(null)
  binaryartifacts?: Partial(string) & Partial(null)
  branchprotection?: Partial(string) & Partial(null)
  ciibestpractices?: Partial(string) & Partial(null)
  codereview?: Partial(string) & Partial(null)
  dangerousworkflow?: Partial(string) & Partial(null)
  fuzzing?: Partial(string) & Partial(null)
  license?: Partial(string) & Partial(null)
  maintained?: Partial(string) & Partial(null)
  packaging?: Partial(string) & Partial(null)
  pinneddependencies?: Partial(string) & Partial(null)
  sast?: Partial(string) & Partial(null)
  securitypolicy?: Partial(string) & Partial(null)
  signedreleases?: Partial(string) & Partial(null)
  tokenpermissions?: Partial(string) & Partial(null)
  vulnerabilities?: Partial(string) & Partial(null)
}

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