2501 lines
65 KiB
YAML
2501 lines
65 KiB
YAML
info:
|
|
title: Probo MCP Server
|
|
version: 1.0.0
|
|
description: Probo MCP Server API
|
|
|
|
components:
|
|
schemas:
|
|
OrderDirection:
|
|
type: string
|
|
enum:
|
|
- ASC
|
|
- DESC
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/page.OrderDirection
|
|
|
|
VendorOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- UPDATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.VendorOrderField
|
|
|
|
VendorOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/VendorOrderField"
|
|
description: Vendor order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Vendor order direction
|
|
|
|
PeopleOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/PeopleOrderField"
|
|
description: People order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: People order direction
|
|
|
|
PeopleOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- FULL_NAME
|
|
- KIND
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.PeopleOrderField
|
|
|
|
PeopleKind:
|
|
type: string
|
|
enum:
|
|
- EMPLOYEE
|
|
- CONTRACTOR
|
|
- SERVICE_ACCOUNT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.PeopleKind
|
|
|
|
People:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- full_name
|
|
- primary_email_address
|
|
- additional_email_addresses
|
|
- kind
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: People ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
full_name:
|
|
type: string
|
|
description: Full name
|
|
primary_email_address:
|
|
type: string
|
|
description: Primary email address
|
|
additional_email_addresses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Additional email addresses
|
|
kind:
|
|
$ref: "#/components/schemas/PeopleKind"
|
|
description: People kind
|
|
position:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Position
|
|
contract_start_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Contract start date
|
|
contract_end_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Contract end date
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListPeopleInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/PeopleOrderBy"
|
|
description: People order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
exclude_contract_ended:
|
|
type: boolean
|
|
description: Exclude people with ended contracts
|
|
|
|
ListPeopleOutput:
|
|
type: object
|
|
required:
|
|
- people
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
people:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/People"
|
|
|
|
GID:
|
|
type: string
|
|
format: string
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/gid.GID
|
|
|
|
CursorKey:
|
|
type: string
|
|
format: string
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/page.CursorKey
|
|
|
|
ListOrganizationsInput:
|
|
type: object
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
|
|
ListOrganizationsOutput:
|
|
type: object
|
|
properties:
|
|
organizations:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Organization"
|
|
|
|
Organization:
|
|
type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- description
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Organization name
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Organization description
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListVendorsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/VendorOrderBy"
|
|
description: Vendor order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
snapshot_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Snapshot ID
|
|
|
|
ListVendorsOutput:
|
|
type: object
|
|
required:
|
|
- vendors
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
vendors:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Vendor"
|
|
|
|
Vendor:
|
|
type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- organization_id
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Vendor ID
|
|
name:
|
|
type: string
|
|
description: Vendor name
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Vendor description
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
AddVendorInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Vendor name
|
|
description:
|
|
type: string
|
|
description: Vendor description
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
AddVendorOutput:
|
|
type: object
|
|
required:
|
|
- vendor
|
|
properties:
|
|
vendor:
|
|
$ref: "#/components/schemas/Vendor"
|
|
|
|
UpdateVendorInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Vendor ID
|
|
name:
|
|
type: string
|
|
description: Vendor name
|
|
description:
|
|
type: string
|
|
description: Vendor description
|
|
|
|
UpdateVendorOutput:
|
|
type: object
|
|
required:
|
|
- vendor
|
|
properties:
|
|
vendor:
|
|
$ref: "#/components/schemas/Vendor"
|
|
|
|
GetPeopleInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: People ID
|
|
|
|
GetPeopleOutput:
|
|
type: object
|
|
required:
|
|
- people
|
|
properties:
|
|
people:
|
|
$ref: "#/components/schemas/People"
|
|
|
|
AddPeopleInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- full_name
|
|
- primary_email_address
|
|
- kind
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
full_name:
|
|
type: string
|
|
description: Full name
|
|
primary_email_address:
|
|
type: string
|
|
description: Primary email address
|
|
additional_email_addresses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Additional email addresses
|
|
kind:
|
|
$ref: "#/components/schemas/PeopleKind"
|
|
description: People kind
|
|
position:
|
|
type: string
|
|
description: Position
|
|
contract_start_date:
|
|
type: string
|
|
format: date-time
|
|
description: Contract start date
|
|
contract_end_date:
|
|
type: string
|
|
format: date-time
|
|
description: Contract end date
|
|
|
|
AddPeopleOutput:
|
|
type: object
|
|
required:
|
|
- people
|
|
properties:
|
|
people:
|
|
$ref: "#/components/schemas/People"
|
|
|
|
RiskOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- UPDATED_AT
|
|
- NAME
|
|
- CATEGORY
|
|
- TREATMENT
|
|
- INHERENT_RISK_SCORE
|
|
- RESIDUAL_RISK_SCORE
|
|
- OWNER_FULL_NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RiskOrderField
|
|
|
|
RiskOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/RiskOrderField"
|
|
description: Risk order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Risk order direction
|
|
|
|
RiskTreatment:
|
|
type: string
|
|
enum:
|
|
- MITIGATED
|
|
- ACCEPTED
|
|
- AVOIDED
|
|
- TRANSFERRED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.RiskTreatment
|
|
|
|
Risk:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- category
|
|
- treatment
|
|
- inherent_likelihood
|
|
- inherent_impact
|
|
- inherent_risk_score
|
|
- residual_likelihood
|
|
- residual_impact
|
|
- residual_risk_score
|
|
- note
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
snapshot_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: No snapshot
|
|
description: Snapshot ID
|
|
name:
|
|
type: string
|
|
description: Risk name
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Risk description
|
|
category:
|
|
type: string
|
|
description: Risk category
|
|
treatment:
|
|
$ref: "#/components/schemas/RiskTreatment"
|
|
description: Risk treatment
|
|
inherent_likelihood:
|
|
type: integer
|
|
description: Inherent likelihood
|
|
inherent_impact:
|
|
type: integer
|
|
description: Inherent impact
|
|
inherent_risk_score:
|
|
type: integer
|
|
description: Inherent risk score
|
|
residual_likelihood:
|
|
type: integer
|
|
description: Residual likelihood
|
|
residual_impact:
|
|
type: integer
|
|
description: Residual impact
|
|
residual_risk_score:
|
|
type: integer
|
|
description: Residual risk score
|
|
note:
|
|
type: string
|
|
description: Risk note
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: No owner
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListRisksInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/RiskOrderBy"
|
|
description: Risk order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
query:
|
|
type: string
|
|
description: Search query
|
|
snapshot_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Snapshot ID
|
|
|
|
ListRisksOutput:
|
|
type: object
|
|
required:
|
|
- risks
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
risks:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Risk"
|
|
|
|
GetRiskInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
|
|
GetRiskOutput:
|
|
type: object
|
|
required:
|
|
- risk
|
|
properties:
|
|
risk:
|
|
$ref: "#/components/schemas/Risk"
|
|
|
|
AddRiskInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
- category
|
|
- treatment
|
|
- inherent_likelihood
|
|
- inherent_impact
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Risk name
|
|
description:
|
|
type: string
|
|
description: Risk description
|
|
category:
|
|
type: string
|
|
description: Risk category
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
treatment:
|
|
$ref: "#/components/schemas/RiskTreatment"
|
|
description: Risk treatment
|
|
inherent_likelihood:
|
|
type: integer
|
|
description: Inherent likelihood
|
|
inherent_impact:
|
|
type: integer
|
|
description: Inherent impact
|
|
residual_likelihood:
|
|
type: integer
|
|
description: Residual likelihood
|
|
residual_impact:
|
|
type: integer
|
|
description: Residual impact
|
|
note:
|
|
type: string
|
|
description: Risk note
|
|
|
|
AddRiskOutput:
|
|
type: object
|
|
required:
|
|
- risk
|
|
properties:
|
|
risk:
|
|
$ref: "#/components/schemas/Risk"
|
|
|
|
UpdateRiskInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Risk ID
|
|
name:
|
|
type: string
|
|
description: Risk name
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Risk description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
category:
|
|
type: string
|
|
description: Risk category
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
go.probo.inc/mcpgen/omittable: true
|
|
treatment:
|
|
$ref: "#/components/schemas/RiskTreatment"
|
|
description: Risk treatment
|
|
inherent_likelihood:
|
|
type: integer
|
|
description: Inherent likelihood
|
|
inherent_impact:
|
|
type: integer
|
|
description: Inherent impact
|
|
residual_likelihood:
|
|
type: integer
|
|
description: Residual likelihood
|
|
residual_impact:
|
|
type: integer
|
|
description: Residual impact
|
|
note:
|
|
type: string
|
|
description: Risk note
|
|
|
|
UpdateRiskOutput:
|
|
type: object
|
|
required:
|
|
- risk
|
|
properties:
|
|
risk:
|
|
$ref: "#/components/schemas/Risk"
|
|
|
|
MeasureState:
|
|
type: string
|
|
enum:
|
|
- NOT_STARTED
|
|
- IN_PROGRESS
|
|
- NOT_APPLICABLE
|
|
- IMPLEMENTED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.MeasureState
|
|
|
|
MeasureOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.MeasureOrderField
|
|
|
|
MeasureOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/MeasureOrderField"
|
|
description: Measure order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Measure order direction
|
|
|
|
Measure:
|
|
type: object
|
|
required:
|
|
- id
|
|
- category
|
|
- name
|
|
- state
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
category:
|
|
type: string
|
|
description: Measure category
|
|
name:
|
|
type: string
|
|
description: Measure name
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Measure description
|
|
state:
|
|
$ref: "#/components/schemas/MeasureState"
|
|
description: Measure state
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListMeasuresInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/MeasureOrderBy"
|
|
description: Measure order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
query:
|
|
type: string
|
|
description: Search query
|
|
state:
|
|
$ref: "#/components/schemas/MeasureState"
|
|
description: Measure state filter
|
|
|
|
ListMeasuresOutput:
|
|
type: object
|
|
required:
|
|
- measures
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
measures:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Measure"
|
|
|
|
GetMeasureInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
|
|
GetMeasureOutput:
|
|
type: object
|
|
required:
|
|
- measure
|
|
properties:
|
|
measure:
|
|
$ref: "#/components/schemas/Measure"
|
|
|
|
AddMeasureInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
- category
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Measure name
|
|
description:
|
|
type: string
|
|
description: Measure description
|
|
category:
|
|
type: string
|
|
description: Measure category
|
|
|
|
AddMeasureOutput:
|
|
type: object
|
|
required:
|
|
- measure
|
|
properties:
|
|
measure:
|
|
$ref: "#/components/schemas/Measure"
|
|
|
|
UpdateMeasureInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Measure ID
|
|
name:
|
|
type: string
|
|
description: Measure name
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Measure description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
category:
|
|
type: string
|
|
description: Measure category
|
|
state:
|
|
$ref: "#/components/schemas/MeasureState"
|
|
description: Measure state
|
|
|
|
UpdateMeasureOutput:
|
|
type: object
|
|
required:
|
|
- measure
|
|
properties:
|
|
measure:
|
|
$ref: "#/components/schemas/Measure"
|
|
|
|
FrameworkOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.FrameworkOrderField
|
|
|
|
FrameworkOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/FrameworkOrderField"
|
|
description: Framework order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Framework order direction
|
|
|
|
Framework:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Framework ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Framework name
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Framework description
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListFrameworksInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/FrameworkOrderBy"
|
|
description: Framework order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
|
|
ListFrameworksOutput:
|
|
type: object
|
|
required:
|
|
- frameworks
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
frameworks:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Framework"
|
|
|
|
GetFrameworkInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Framework ID
|
|
|
|
GetFrameworkOutput:
|
|
type: object
|
|
required:
|
|
- framework
|
|
properties:
|
|
framework:
|
|
$ref: "#/components/schemas/Framework"
|
|
|
|
AddFrameworkInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Framework name
|
|
description:
|
|
type: string
|
|
description: Framework description
|
|
|
|
AddFrameworkOutput:
|
|
type: object
|
|
required:
|
|
- framework
|
|
properties:
|
|
framework:
|
|
$ref: "#/components/schemas/Framework"
|
|
|
|
UpdateFrameworkInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Framework ID
|
|
name:
|
|
type: string
|
|
description: Framework name
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Framework description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateFrameworkOutput:
|
|
type: object
|
|
required:
|
|
- framework
|
|
properties:
|
|
framework:
|
|
$ref: "#/components/schemas/Framework"
|
|
|
|
AssetType:
|
|
type: string
|
|
enum:
|
|
- PHYSICAL
|
|
- VIRTUAL
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AssetType
|
|
|
|
AssetOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- AMOUNT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.AssetOrderField
|
|
|
|
AssetOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/AssetOrderField"
|
|
description: Asset order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Asset order direction
|
|
|
|
Asset:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- amount
|
|
- owner_id
|
|
- asset_type
|
|
- data_types_stored
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Asset ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
snapshot_id:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Snapshot ID
|
|
name:
|
|
type: string
|
|
description: Asset name
|
|
amount:
|
|
type: integer
|
|
description: Asset amount
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
asset_type:
|
|
$ref: "#/components/schemas/AssetType"
|
|
description: Asset type
|
|
data_types_stored:
|
|
type: string
|
|
description: Data types stored
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListAssetsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/AssetOrderBy"
|
|
description: Asset order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
snapshot_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Snapshot ID
|
|
|
|
ListAssetsOutput:
|
|
type: object
|
|
required:
|
|
- assets
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
assets:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Asset"
|
|
|
|
GetAssetInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Asset ID
|
|
|
|
GetAssetOutput:
|
|
type: object
|
|
required:
|
|
- asset
|
|
properties:
|
|
asset:
|
|
$ref: "#/components/schemas/Asset"
|
|
|
|
AddAssetInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
- amount
|
|
- owner_id
|
|
- asset_type
|
|
- data_types_stored
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Asset name
|
|
amount:
|
|
type: integer
|
|
description: Asset amount
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
asset_type:
|
|
$ref: "#/components/schemas/AssetType"
|
|
description: Asset type
|
|
data_types_stored:
|
|
type: string
|
|
description: Data types stored
|
|
vendor_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Vendor IDs
|
|
|
|
AddAssetOutput:
|
|
type: object
|
|
required:
|
|
- asset
|
|
properties:
|
|
asset:
|
|
$ref: "#/components/schemas/Asset"
|
|
|
|
UpdateAssetInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Asset ID
|
|
name:
|
|
type: string
|
|
description: Asset name
|
|
amount:
|
|
type: integer
|
|
description: Asset amount
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
asset_type:
|
|
$ref: "#/components/schemas/AssetType"
|
|
description: Asset type
|
|
data_types_stored:
|
|
type: string
|
|
description: Data types stored
|
|
vendor_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Vendor IDs
|
|
|
|
UpdateAssetOutput:
|
|
type: object
|
|
required:
|
|
- asset
|
|
properties:
|
|
asset:
|
|
$ref: "#/components/schemas/Asset"
|
|
|
|
DataClassification:
|
|
type: string
|
|
enum:
|
|
- PUBLIC
|
|
- INTERNAL
|
|
- CONFIDENTIAL
|
|
- SECRET
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DataClassification
|
|
|
|
DatumOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- NAME
|
|
- DATA_CLASSIFICATION
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.DatumOrderField
|
|
|
|
DatumOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/DatumOrderField"
|
|
description: Datum order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Datum order direction
|
|
|
|
Datum:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- name
|
|
- data_classification
|
|
- owner_id
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Datum ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
snapshot_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
description: Snapshot ID
|
|
- type: "null"
|
|
description: No snapshot
|
|
description: Snapshot ID
|
|
name:
|
|
type: string
|
|
description: Datum name
|
|
data_classification:
|
|
$ref: "#/components/schemas/DataClassification"
|
|
description: Data classification
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListDataInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/DatumOrderBy"
|
|
description: Datum order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
snapshot_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Snapshot ID
|
|
|
|
ListDataOutput:
|
|
type: object
|
|
required:
|
|
- data
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
data:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Datum"
|
|
|
|
GetDatumInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Datum ID
|
|
|
|
GetDatumOutput:
|
|
type: object
|
|
required:
|
|
- datum
|
|
properties:
|
|
datum:
|
|
$ref: "#/components/schemas/Datum"
|
|
|
|
AddDatumInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- name
|
|
- data_classification
|
|
- owner_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
name:
|
|
type: string
|
|
description: Datum name
|
|
data_classification:
|
|
$ref: "#/components/schemas/DataClassification"
|
|
description: Data classification
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
vendor_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Vendor IDs
|
|
|
|
AddDatumOutput:
|
|
type: object
|
|
required:
|
|
- datum
|
|
properties:
|
|
datum:
|
|
$ref: "#/components/schemas/Datum"
|
|
|
|
UpdateDatumInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Datum ID
|
|
name:
|
|
type: string
|
|
description: Datum name
|
|
data_classification:
|
|
$ref: "#/components/schemas/DataClassification"
|
|
description: Data classification
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
vendor_ids:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Vendor IDs
|
|
|
|
UpdateDatumOutput:
|
|
type: object
|
|
required:
|
|
- datum
|
|
properties:
|
|
datum:
|
|
$ref: "#/components/schemas/Datum"
|
|
|
|
NonconformityStatus:
|
|
type: string
|
|
enum:
|
|
- OPEN
|
|
- IN_PROGRESS
|
|
- CLOSED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.NonconformityStatus
|
|
|
|
NonconformityOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- REFERENCE_ID
|
|
- DATE_IDENTIFIED
|
|
- DUE_DATE
|
|
- STATUS
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.NonconformityOrderField
|
|
|
|
NonconformityOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/NonconformityOrderField"
|
|
description: Nonconformity order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Nonconformity order direction
|
|
|
|
Nonconformity:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- reference_id
|
|
- audit_id
|
|
- root_cause
|
|
- owner_id
|
|
- status
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Nonconformity ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
snapshot_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
description: Snapshot ID
|
|
- type: "null"
|
|
description: No snapshot
|
|
description: Snapshot ID
|
|
reference_id:
|
|
type: string
|
|
description: Reference ID
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Description
|
|
audit_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Audit ID
|
|
date_identified:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Date identified
|
|
root_cause:
|
|
type: string
|
|
description: Root cause
|
|
corrective_action:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Corrective action
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
due_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Due date
|
|
status:
|
|
$ref: "#/components/schemas/NonconformityStatus"
|
|
description: Status
|
|
effectiveness_check:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Effectiveness check
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListNonconformitiesInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/NonconformityOrderBy"
|
|
description: Nonconformity order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
snapshot_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Snapshot ID
|
|
|
|
ListNonconformitiesOutput:
|
|
type: object
|
|
required:
|
|
- nonconformities
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
nonconformities:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Nonconformity"
|
|
|
|
GetNonconformityInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Nonconformity ID
|
|
|
|
GetNonconformityOutput:
|
|
type: object
|
|
required:
|
|
- nonconformity
|
|
properties:
|
|
nonconformity:
|
|
$ref: "#/components/schemas/Nonconformity"
|
|
|
|
AddNonconformityInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- reference_id
|
|
- audit_id
|
|
- root_cause
|
|
- owner_id
|
|
- status
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
reference_id:
|
|
type: string
|
|
description: Reference ID
|
|
description:
|
|
type: string
|
|
description: Description
|
|
audit_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Audit ID
|
|
date_identified:
|
|
type: string
|
|
format: date-time
|
|
description: Date identified
|
|
root_cause:
|
|
type: string
|
|
description: Root cause
|
|
corrective_action:
|
|
type: string
|
|
description: Corrective action
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
due_date:
|
|
type: string
|
|
format: date-time
|
|
description: Due date
|
|
status:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/NonconformityStatus"
|
|
description: Nonconformity status
|
|
- type: "null"
|
|
description: No status
|
|
description: Status
|
|
effectiveness_check:
|
|
type: string
|
|
description: Effectiveness check
|
|
|
|
AddNonconformityOutput:
|
|
type: object
|
|
required:
|
|
- nonconformity
|
|
properties:
|
|
nonconformity:
|
|
$ref: "#/components/schemas/Nonconformity"
|
|
|
|
UpdateNonconformityInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Nonconformity ID
|
|
reference_id:
|
|
type: string
|
|
description: Reference ID
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
date_identified:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Date identified
|
|
go.probo.inc/mcpgen/omittable: true
|
|
root_cause:
|
|
type: string
|
|
description: Root cause
|
|
corrective_action:
|
|
type: ["string", "null"]
|
|
description: Corrective action
|
|
go.probo.inc/mcpgen/omittable: true
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
audit_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Audit ID
|
|
due_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Due date
|
|
go.probo.inc/mcpgen/omittable: true
|
|
status:
|
|
$ref: "#/components/schemas/NonconformityStatus"
|
|
description: Status
|
|
effectiveness_check:
|
|
type: ["string", "null"]
|
|
description: Effectiveness check
|
|
go.probo.inc/mcpgen/omittable: true
|
|
|
|
UpdateNonconformityOutput:
|
|
type: object
|
|
required:
|
|
- nonconformity
|
|
properties:
|
|
nonconformity:
|
|
$ref: "#/components/schemas/Nonconformity"
|
|
|
|
ObligationStatus:
|
|
type: string
|
|
enum:
|
|
- NON_COMPLIANT
|
|
- PARTIALLY_COMPLIANT
|
|
- COMPLIANT
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ObligationStatus
|
|
|
|
ObligationOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- LAST_REVIEW_DATE
|
|
- DUE_DATE
|
|
- STATUS
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ObligationOrderField
|
|
|
|
ObligationOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/ObligationOrderField"
|
|
description: Obligation order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Obligation order direction
|
|
|
|
Obligation:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- owner_id
|
|
- status
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Obligation ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
snapshot_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
description: Snapshot ID
|
|
- type: "null"
|
|
description: No snapshot
|
|
description: Snapshot ID
|
|
source_id:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Source ID
|
|
area:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Area
|
|
source:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Source
|
|
requirement:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Requirement
|
|
actions_to_be_implemented:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Actions to be implemented
|
|
regulator:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Regulator
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
last_review_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Last review date
|
|
due_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Due date
|
|
status:
|
|
$ref: "#/components/schemas/ObligationStatus"
|
|
description: Status
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListObligationsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/ObligationOrderBy"
|
|
description: Obligation order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
snapshot_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Snapshot ID
|
|
|
|
ListObligationsOutput:
|
|
type: object
|
|
required:
|
|
- obligations
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
obligations:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Obligation"
|
|
|
|
GetObligationInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Obligation ID
|
|
|
|
GetObligationOutput:
|
|
type: object
|
|
required:
|
|
- obligation
|
|
properties:
|
|
obligation:
|
|
$ref: "#/components/schemas/Obligation"
|
|
|
|
AddObligationInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- owner_id
|
|
- status
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
area:
|
|
type: string
|
|
description: Area
|
|
source:
|
|
type: string
|
|
description: Source
|
|
requirement:
|
|
type: string
|
|
description: Requirement
|
|
actions_to_be_implemented:
|
|
type: string
|
|
description: Actions to be implemented
|
|
regulator:
|
|
type: string
|
|
description: Regulator
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
last_review_date:
|
|
type: string
|
|
format: date-time
|
|
description: Last review date
|
|
due_date:
|
|
type: string
|
|
format: date-time
|
|
description: Due date
|
|
status:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ObligationStatus"
|
|
description: Obligation status
|
|
- type: "null"
|
|
description: No status
|
|
description: Status
|
|
|
|
AddObligationOutput:
|
|
type: object
|
|
required:
|
|
- obligation
|
|
properties:
|
|
obligation:
|
|
$ref: "#/components/schemas/Obligation"
|
|
|
|
UpdateObligationInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Obligation ID
|
|
area:
|
|
type: ["string", "null"]
|
|
description: Area
|
|
go.probo.inc/mcpgen/omittable: true
|
|
source:
|
|
type: ["string", "null"]
|
|
description: Source
|
|
go.probo.inc/mcpgen/omittable: true
|
|
requirement:
|
|
type: ["string", "null"]
|
|
description: Requirement
|
|
go.probo.inc/mcpgen/omittable: true
|
|
actions_to_be_implemented:
|
|
type: ["string", "null"]
|
|
description: Actions to be implemented
|
|
go.probo.inc/mcpgen/omittable: true
|
|
regulator:
|
|
type: ["string", "null"]
|
|
description: Regulator
|
|
go.probo.inc/mcpgen/omittable: true
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
last_review_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Last review date
|
|
go.probo.inc/mcpgen/omittable: true
|
|
due_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Due date
|
|
go.probo.inc/mcpgen/omittable: true
|
|
status:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ObligationStatus"
|
|
description: Obligation status
|
|
- type: "null"
|
|
description: No status
|
|
description: Status
|
|
|
|
UpdateObligationOutput:
|
|
type: object
|
|
required:
|
|
- obligation
|
|
properties:
|
|
obligation:
|
|
$ref: "#/components/schemas/Obligation"
|
|
|
|
ContinualImprovementStatus:
|
|
type: string
|
|
enum:
|
|
- OPEN
|
|
- IN_PROGRESS
|
|
- CLOSED
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ContinualImprovementStatus
|
|
|
|
ContinualImprovementPriority:
|
|
type: string
|
|
enum:
|
|
- LOW
|
|
- MEDIUM
|
|
- HIGH
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ContinualImprovementPriority
|
|
|
|
ContinualImprovementOrderField:
|
|
type: string
|
|
enum:
|
|
- CREATED_AT
|
|
- REFERENCE_ID
|
|
- TARGET_DATE
|
|
- STATUS
|
|
- PRIORITY
|
|
go.probo.inc/mcpgen/type: go.probo.inc/probo/pkg/coredata.ContinualImprovementOrderField
|
|
|
|
ContinualImprovementOrderBy:
|
|
type: object
|
|
required:
|
|
- field
|
|
- direction
|
|
properties:
|
|
field:
|
|
$ref: "#/components/schemas/ContinualImprovementOrderField"
|
|
description: Continual improvement order field
|
|
direction:
|
|
$ref: "#/components/schemas/OrderDirection"
|
|
description: Continual improvement order direction
|
|
|
|
ContinualImprovement:
|
|
type: object
|
|
required:
|
|
- id
|
|
- organization_id
|
|
- reference_id
|
|
- owner_id
|
|
- status
|
|
- priority
|
|
- created_at
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Continual improvement ID
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
snapshot_id:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/GID"
|
|
description: Snapshot ID
|
|
- type: "null"
|
|
description: No snapshot
|
|
description: Snapshot ID
|
|
source_id:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Source ID
|
|
reference_id:
|
|
type: string
|
|
description: Reference ID
|
|
description:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Description
|
|
source:
|
|
type:
|
|
- string
|
|
- "null"
|
|
description: Source
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
target_date:
|
|
type:
|
|
- string
|
|
- "null"
|
|
format: date-time
|
|
description: Target date
|
|
status:
|
|
$ref: "#/components/schemas/ContinualImprovementStatus"
|
|
description: Status
|
|
priority:
|
|
$ref: "#/components/schemas/ContinualImprovementPriority"
|
|
description: Priority
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
description: Creation timestamp
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
description: Update timestamp
|
|
|
|
ListContinualImprovementsInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
order_by:
|
|
$ref: "#/components/schemas/ContinualImprovementOrderBy"
|
|
description: Continual improvement order by
|
|
size:
|
|
type: integer
|
|
description: Page size
|
|
cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Page cursor
|
|
filter:
|
|
type: object
|
|
properties:
|
|
snapshot_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Snapshot ID
|
|
|
|
ListContinualImprovementsOutput:
|
|
type: object
|
|
required:
|
|
- continual_improvements
|
|
properties:
|
|
next_cursor:
|
|
$ref: "#/components/schemas/CursorKey"
|
|
description: Next cursor
|
|
continual_improvements:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/ContinualImprovement"
|
|
|
|
GetContinualImprovementInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Continual improvement ID
|
|
|
|
GetContinualImprovementOutput:
|
|
type: object
|
|
required:
|
|
- continual_improvement
|
|
properties:
|
|
continual_improvement:
|
|
$ref: "#/components/schemas/ContinualImprovement"
|
|
|
|
AddContinualImprovementInput:
|
|
type: object
|
|
required:
|
|
- organization_id
|
|
- reference_id
|
|
- owner_id
|
|
properties:
|
|
organization_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Organization ID
|
|
reference_id:
|
|
type: string
|
|
description: Reference ID
|
|
description:
|
|
type: string
|
|
description: Description
|
|
source:
|
|
type: string
|
|
description: Source
|
|
owner_id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Owner ID
|
|
target_date:
|
|
type: string
|
|
format: date-time
|
|
description: Target date
|
|
status:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ContinualImprovementStatus"
|
|
description: Continual improvement status
|
|
- type: "null"
|
|
description: No status
|
|
description: Status
|
|
priority:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ContinualImprovementPriority"
|
|
description: Continual improvement priority
|
|
- type: "null"
|
|
description: No priority
|
|
description: Priority
|
|
|
|
AddContinualImprovementOutput:
|
|
type: object
|
|
required:
|
|
- continual_improvement
|
|
properties:
|
|
continual_improvement:
|
|
$ref: "#/components/schemas/ContinualImprovement"
|
|
|
|
UpdateContinualImprovementInput:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
$ref: "#/components/schemas/GID"
|
|
description: Continual improvement ID
|
|
reference_id:
|
|
type: string
|
|
description: Reference ID
|
|
description:
|
|
type: ["string", "null"]
|
|
description: Description
|
|
go.probo.inc/mcpgen/omittable: true
|
|
source:
|
|
type: ["string", "null"]
|
|
description: Source
|
|
go.probo.inc/mcpgen/omittable: true
|
|
owner_id:
|
|
anyOf:
|
|
- type: string
|
|
$ref: "#/components/schemas/GID"
|
|
- type: "null"
|
|
description: Owner ID
|
|
target_date:
|
|
type: ["string", "null"]
|
|
format: date-time
|
|
description: Target date
|
|
go.probo.inc/mcpgen/omittable: true
|
|
status:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ContinualImprovementStatus"
|
|
description: Continual improvement status
|
|
- type: "null"
|
|
description: No status
|
|
description: Status
|
|
priority:
|
|
anyOf:
|
|
- $ref: "#/components/schemas/ContinualImprovementPriority"
|
|
description: Continual improvement priority
|
|
- type: "null"
|
|
description: No priority
|
|
description: Priority
|
|
|
|
UpdateContinualImprovementOutput:
|
|
type: object
|
|
required:
|
|
- continual_improvement
|
|
properties:
|
|
continual_improvement:
|
|
$ref: "#/components/schemas/ContinualImprovement"
|
|
|
|
tools:
|
|
- name: listOrganizations
|
|
description: List all organizations the user has access to
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListOrganizationsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListOrganizationsOutput"
|
|
- name: listVendors
|
|
description: List all vendors for the organization
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListVendorsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListVendorsOutput"
|
|
- name: listPeople
|
|
description: List all people for the organization
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListPeopleInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListPeopleOutput"
|
|
- name: addVendor
|
|
description: Add a new vendor to the organization
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddVendorInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddVendorOutput"
|
|
- name: updateVendor
|
|
description: Update an existing vendor
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateVendorInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateVendorOutput"
|
|
- name: getPeople
|
|
description: Get a people by ID
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetPeopleInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetPeopleOutput"
|
|
- name: addPeople
|
|
description: Add a new people to the organization
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddPeopleInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddPeopleOutput"
|
|
- name: listRisks
|
|
description: List all risks for the organization
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListRisksInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListRisksOutput"
|
|
- name: getRisk
|
|
description: Get a risk by ID
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetRiskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetRiskOutput"
|
|
- name: addRisk
|
|
description: Add a new risk to the organization
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddRiskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddRiskOutput"
|
|
- name: updateRisk
|
|
description: Update an existing risk
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateRiskOutput"
|
|
- name: listMeasures
|
|
description: List all measures for the organization
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListMeasuresInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListMeasuresOutput"
|
|
- name: getMeasure
|
|
description: Get a measure by ID
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetMeasureInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetMeasureOutput"
|
|
- name: addMeasure
|
|
description: Add a new measure to the organization
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddMeasureInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddMeasureOutput"
|
|
- name: updateMeasure
|
|
description: Update an existing measure
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateMeasureInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateMeasureOutput"
|
|
- name: listFrameworks
|
|
description: List all frameworks for the organization
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListFrameworksInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListFrameworksOutput"
|
|
- name: getFramework
|
|
description: Get a framework by ID
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetFrameworkInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetFrameworkOutput"
|
|
- name: addFramework
|
|
description: Add a new framework to the organization
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddFrameworkInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddFrameworkOutput"
|
|
- name: updateFramework
|
|
description: Update an existing framework
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateFrameworkInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateFrameworkOutput"
|
|
- name: listAssets
|
|
description: List all assets for the organization
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListAssetsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListAssetsOutput"
|
|
- name: getAsset
|
|
description: Get an asset by ID
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetAssetInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetAssetOutput"
|
|
- name: addAsset
|
|
description: Add a new asset to the organization
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddAssetInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddAssetOutput"
|
|
- name: updateAsset
|
|
description: Update an existing asset
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateAssetInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateAssetOutput"
|
|
- name: listData
|
|
description: List all data for the organization
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListDataInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListDataOutput"
|
|
- name: getDatum
|
|
description: Get a datum by ID
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetDatumInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetDatumOutput"
|
|
- name: addDatum
|
|
description: Add a new datum to the organization
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddDatumInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddDatumOutput"
|
|
- name: updateDatum
|
|
description: Update an existing datum
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateDatumInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateDatumOutput"
|
|
- name: listNonconformities
|
|
description: List all nonconformities for the organization
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListNonconformitiesInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListNonconformitiesOutput"
|
|
- name: getNonconformity
|
|
description: Get a nonconformity by ID
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetNonconformityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetNonconformityOutput"
|
|
- name: addNonconformity
|
|
description: Add a new nonconformity to the organization
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddNonconformityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddNonconformityOutput"
|
|
- name: updateNonconformity
|
|
description: Update an existing nonconformity
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateNonconformityInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateNonconformityOutput"
|
|
- name: listObligations
|
|
description: List all obligations for the organization
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListObligationsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListObligationsOutput"
|
|
- name: getObligation
|
|
description: Get an obligation by ID
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetObligationInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetObligationOutput"
|
|
- name: addObligation
|
|
description: Add a new obligation to the organization
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddObligationInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddObligationOutput"
|
|
- name: updateObligation
|
|
description: Update an existing obligation
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateObligationInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateObligationOutput"
|
|
- name: listContinualImprovements
|
|
description: List all continual improvements for the organization
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/ListContinualImprovementsInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/ListContinualImprovementsOutput"
|
|
- name: getContinualImprovement
|
|
description: Get a continual improvement by ID
|
|
readonly: true
|
|
inputSchema:
|
|
$ref: "#/components/schemas/GetContinualImprovementInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/GetContinualImprovementOutput"
|
|
- name: addContinualImprovement
|
|
description: Add a new continual improvement to the organization
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/AddContinualImprovementInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/AddContinualImprovementOutput"
|
|
- name: updateContinualImprovement
|
|
description: Update an existing continual improvement
|
|
readonly: false
|
|
inputSchema:
|
|
$ref: "#/components/schemas/UpdateContinualImprovementInput"
|
|
outputSchema:
|
|
$ref: "#/components/schemas/UpdateContinualImprovementOutput"
|