From b953a52a73a6772557121d7a78fb28723433a974 Mon Sep 17 00:00:00 2001 From: David Whittaker Date: Fri, 20 Jun 2025 14:59:35 -0700 Subject: [PATCH 1/3] feat(case): adds stable status to cases --- docs/scripts/openapi.yaml | 17595 ++++++++-------- src/dispatch/case/enums.py | 1 + src/dispatch/case/flows.py | 99 +- src/dispatch/case/models.py | 8 + src/dispatch/case/scheduled.py | 22 + src/dispatch/case/service.py | 24 +- src/dispatch/case/views.py | 18 +- src/dispatch/case_cost/scheduled.py | 16 +- src/dispatch/case_cost/service.py | 96 +- .../versions/2025-06-20_5ed5defd1a55.py | 28 + src/dispatch/messaging/strings.py | 4 + .../static/dispatch/src/case/CaseStatus.vue | 1 + .../src/case/CaseStatusSelectGroup.vue | 50 +- .../static/dispatch/src/case/DetailsTab.vue | 9 + .../static/dispatch/src/case/Page.vue | 1 + .../dispatch/src/case/TableExportDialog.vue | 1 + .../src/dashboard/case/CaseDialogFilter.vue | 1 + .../src/dashboard/case/CaseOverview.vue | 15 + tests/case_cost/test_case_cost_service.py | 69 +- tests/factories.py | 2 +- 20 files changed, 9193 insertions(+), 8867 deletions(-) create mode 100644 src/dispatch/database/revisions/tenant/versions/2025-06-20_5ed5defd1a55.py diff --git a/docs/scripts/openapi.yaml b/docs/scripts/openapi.yaml index 0a663ac34285..b3d3a4b3dfc1 100644 --- a/docs/scripts/openapi.yaml +++ b/docs/scripts/openapi.yaml @@ -49,7 +49,7 @@ components: title: Originator type: string required: - - id + - id title: AlertRead type: object AlertUpdate: @@ -80,40 +80,40 @@ components: CaseCreate: properties: assignee: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" case_priority: - $ref: '#/components/schemas/CasePriorityRead' + $ref: "#/components/schemas/CasePriorityRead" case_severity: - $ref: '#/components/schemas/CaseSeverityRead' + $ref: "#/components/schemas/CaseSeverityRead" case_type: - $ref: '#/components/schemas/CaseTypeRead' + $ref: "#/components/schemas/CaseTypeRead" description: title: Description type: string project: - $ref: '#/components/schemas/dispatch__case__models__ProjectRead' + $ref: "#/components/schemas/dispatch__case__models__ProjectRead" reporter: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" resolution: title: Resolution type: string resolution_reason: - $ref: '#/components/schemas/CaseResolutionReason' + $ref: "#/components/schemas/CaseResolutionReason" status: - $ref: '#/components/schemas/CaseStatus' + $ref: "#/components/schemas/CaseStatus" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array title: title: Title type: string visibility: - $ref: '#/components/schemas/Visibility' + $ref: "#/components/schemas/Visibility" required: - - title + - title title: CaseCreate type: object CasePriorityBase: @@ -142,12 +142,12 @@ components: title: Page Assignee type: boolean project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" view_order: title: View Order type: integer required: - - name + - name title: CasePriorityBase type: object CasePriorityCreate: @@ -176,12 +176,12 @@ components: title: Page Assignee type: boolean project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" view_order: title: View Order type: integer required: - - name + - name title: CasePriorityCreate type: object CasePriorityPagination: @@ -189,14 +189,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/CasePriorityRead' + $ref: "#/components/schemas/CasePriorityRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: CasePriorityPagination type: object CasePriorityRead: @@ -230,13 +230,13 @@ components: title: Page Assignee type: boolean project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" view_order: title: View Order type: integer required: - - name - - id + - name + - id title: CasePriorityRead type: object CasePriorityUpdate: @@ -265,24 +265,24 @@ components: title: Page Assignee type: boolean project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" view_order: title: View Order type: integer required: - - name + - name title: CasePriorityUpdate type: object CaseReadMinimal: properties: assignee: - $ref: '#/components/schemas/ParticipantReadMinimal' + $ref: "#/components/schemas/ParticipantReadMinimal" case_priority: - $ref: '#/components/schemas/CasePriorityRead' + $ref: "#/components/schemas/CasePriorityRead" case_severity: - $ref: '#/components/schemas/CaseSeverityRead' + $ref: "#/components/schemas/CaseSeverityRead" case_type: - $ref: '#/components/schemas/CaseTypeRead' + $ref: "#/components/schemas/CaseTypeRead" closed_at: format: date-time title: Closed At @@ -297,7 +297,7 @@ components: duplicates: default: [] items: - $ref: '#/components/schemas/CaseReadMinimal' + $ref: "#/components/schemas/CaseReadMinimal" title: Duplicates type: array escalated_at: @@ -312,7 +312,7 @@ components: incidents: default: [] items: - $ref: '#/components/schemas/IncidentReadMinimal' + $ref: "#/components/schemas/IncidentReadMinimal" title: Incidents type: array name: @@ -321,11 +321,11 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__case__models__ProjectRead' + $ref: "#/components/schemas/dispatch__case__models__ProjectRead" related: default: [] items: - $ref: '#/components/schemas/CaseReadMinimal' + $ref: "#/components/schemas/CaseReadMinimal" title: Related type: array reported_at: @@ -336,9 +336,9 @@ components: title: Resolution type: string resolution_reason: - $ref: '#/components/schemas/CaseResolutionReason' + $ref: "#/components/schemas/CaseResolutionReason" status: - $ref: '#/components/schemas/CaseStatus' + $ref: "#/components/schemas/CaseStatus" title: title: Title type: string @@ -347,23 +347,23 @@ components: title: Triage At type: string visibility: - $ref: '#/components/schemas/Visibility' + $ref: "#/components/schemas/Visibility" required: - - title - - id - - case_priority - - case_severity - - case_type - - project + - title + - id + - case_priority + - case_severity + - case_type + - project title: CaseReadMinimal type: object CaseResolutionReason: description: An enumeration. enum: - - False Positive - - User Acknowledged - - Mitigated - - Escalated + - False Positive + - User Acknowledged + - Mitigated + - Escalated title: CaseResolutionReason type: string CaseSeverityBase: @@ -389,12 +389,12 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" view_order: title: View Order type: integer required: - - name + - name title: CaseSeverityBase type: object CaseSeverityCreate: @@ -420,12 +420,12 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" view_order: title: View Order type: integer required: - - name + - name title: CaseSeverityCreate type: object CaseSeverityPagination: @@ -433,14 +433,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/CaseSeverityRead' + $ref: "#/components/schemas/CaseSeverityRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: CaseSeverityPagination type: object CaseSeverityRead: @@ -471,13 +471,13 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" view_order: title: View Order type: integer required: - - name - - id + - name + - id title: CaseSeverityRead type: object CaseSeverityUpdate: @@ -503,27 +503,28 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" view_order: title: View Order type: integer required: - - name + - name title: CaseSeverityUpdate type: object CaseStatus: description: An enumeration. enum: - - New - - Triage - - Escalated - - Closed + - New + - Triage + - Escalated + - Stable + - Closed title: CaseStatus type: string CaseTypeBase: properties: case_template_document: - $ref: '#/components/schemas/dispatch__case__type__models__Document' + $ref: "#/components/schemas/dispatch__case__type__models__Document" conversation_target: title: Conversation Target type: string @@ -543,34 +544,34 @@ components: title: Exclude From Metrics type: boolean incident_type: - $ref: '#/components/schemas/IncidentType' + $ref: "#/components/schemas/IncidentType" name: minLength: 3 pattern: ^(?!\s*$).+ title: Name type: string oncall_service: - $ref: '#/components/schemas/dispatch__case__type__models__Service' + $ref: "#/components/schemas/dispatch__case__type__models__Service" plugin_metadata: default: [] items: - $ref: '#/components/schemas/PluginMetadata' + $ref: "#/components/schemas/PluginMetadata" title: Plugin Metadata type: array project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" visibility: nullable: true title: Visibility type: string required: - - name + - name title: CaseTypeBase type: object CaseTypeCreate: properties: case_template_document: - $ref: '#/components/schemas/dispatch__case__type__models__Document' + $ref: "#/components/schemas/dispatch__case__type__models__Document" conversation_target: title: Conversation Target type: string @@ -590,28 +591,28 @@ components: title: Exclude From Metrics type: boolean incident_type: - $ref: '#/components/schemas/IncidentType' + $ref: "#/components/schemas/IncidentType" name: minLength: 3 pattern: ^(?!\s*$).+ title: Name type: string oncall_service: - $ref: '#/components/schemas/dispatch__case__type__models__Service' + $ref: "#/components/schemas/dispatch__case__type__models__Service" plugin_metadata: default: [] items: - $ref: '#/components/schemas/PluginMetadata' + $ref: "#/components/schemas/PluginMetadata" title: Plugin Metadata type: array project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" visibility: nullable: true title: Visibility type: string required: - - name + - name title: CaseTypeCreate type: object CaseTypePagination: @@ -619,20 +620,20 @@ components: items: default: [] items: - $ref: '#/components/schemas/CaseTypeRead' + $ref: "#/components/schemas/CaseTypeRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: CaseTypePagination type: object CaseTypeRead: properties: case_template_document: - $ref: '#/components/schemas/dispatch__case__type__models__Document' + $ref: "#/components/schemas/dispatch__case__type__models__Document" conversation_target: title: Conversation Target type: string @@ -657,35 +658,35 @@ components: title: Id type: integer incident_type: - $ref: '#/components/schemas/IncidentType' + $ref: "#/components/schemas/IncidentType" name: minLength: 3 pattern: ^(?!\s*$).+ title: Name type: string oncall_service: - $ref: '#/components/schemas/dispatch__case__type__models__Service' + $ref: "#/components/schemas/dispatch__case__type__models__Service" plugin_metadata: default: [] items: - $ref: '#/components/schemas/PluginMetadata' + $ref: "#/components/schemas/PluginMetadata" title: Plugin Metadata type: array project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" visibility: nullable: true title: Visibility type: string required: - - name - - id + - name + - id title: CaseTypeRead type: object CaseTypeUpdate: properties: case_template_document: - $ref: '#/components/schemas/dispatch__case__type__models__Document' + $ref: "#/components/schemas/dispatch__case__type__models__Document" conversation_target: title: Conversation Target type: string @@ -710,47 +711,47 @@ components: title: Id type: integer incident_type: - $ref: '#/components/schemas/IncidentType' + $ref: "#/components/schemas/IncidentType" name: minLength: 3 pattern: ^(?!\s*$).+ title: Name type: string oncall_service: - $ref: '#/components/schemas/dispatch__case__type__models__Service' + $ref: "#/components/schemas/dispatch__case__type__models__Service" plugin_metadata: default: [] items: - $ref: '#/components/schemas/PluginMetadata' + $ref: "#/components/schemas/PluginMetadata" title: Plugin Metadata type: array project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" visibility: nullable: true title: Visibility type: string required: - - name + - name title: CaseTypeUpdate type: object CaseUpdate: properties: assignee: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" case_priority: - $ref: '#/components/schemas/CasePriorityBase' + $ref: "#/components/schemas/CasePriorityBase" case_severity: - $ref: '#/components/schemas/CaseSeverityBase' + $ref: "#/components/schemas/CaseSeverityBase" case_type: - $ref: '#/components/schemas/CaseTypeBase' + $ref: "#/components/schemas/CaseTypeBase" description: title: Description type: string duplicates: default: [] items: - $ref: '#/components/schemas/dispatch__case__models__CaseRead' + $ref: "#/components/schemas/dispatch__case__models__CaseRead" title: Duplicates type: array escalated_at: @@ -760,13 +761,13 @@ components: incidents: default: [] items: - $ref: '#/components/schemas/IncidentReadMinimal' + $ref: "#/components/schemas/IncidentReadMinimal" title: Incidents type: array related: default: [] items: - $ref: '#/components/schemas/dispatch__case__models__CaseRead' + $ref: "#/components/schemas/dispatch__case__models__CaseRead" title: Related type: array reported_at: @@ -777,13 +778,13 @@ components: title: Resolution type: string resolution_reason: - $ref: '#/components/schemas/CaseResolutionReason' + $ref: "#/components/schemas/CaseResolutionReason" status: - $ref: '#/components/schemas/CaseStatus' + $ref: "#/components/schemas/CaseStatus" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array title: @@ -794,9 +795,9 @@ components: title: Triage At type: string visibility: - $ref: '#/components/schemas/Visibility' + $ref: "#/components/schemas/Visibility" required: - - title + - title title: CaseUpdate type: object ConferenceRead: @@ -859,13 +860,13 @@ components: title: Weblink type: string required: - - id + - id title: ConversationRead type: object DefinitionCreate: properties: project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" source: nullable: true title: Source @@ -873,15 +874,15 @@ components: terms: default: [] items: - $ref: '#/components/schemas/DefinitionTerm' + $ref: "#/components/schemas/DefinitionTerm" title: Terms type: array text: title: Text type: string required: - - text - - project + - text + - project title: DefinitionCreate type: object DefinitionPagination: @@ -889,14 +890,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/DefinitionRead' + $ref: "#/components/schemas/DefinitionRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: DefinitionPagination type: object DefinitionRead: @@ -912,15 +913,15 @@ components: type: string terms: items: - $ref: '#/components/schemas/DefinitionTerm' + $ref: "#/components/schemas/DefinitionTerm" title: Terms type: array text: title: Text type: string required: - - text - - id + - text + - id title: DefinitionRead type: object DefinitionTerm: @@ -944,14 +945,14 @@ components: terms: default: [] items: - $ref: '#/components/schemas/DefinitionTerm' + $ref: "#/components/schemas/DefinitionTerm" title: Terms type: array text: title: Text type: string required: - - text + - text title: DefinitionUpdate type: object DocumentCreate: @@ -985,7 +986,7 @@ components: filters: default: [] items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array name: @@ -994,7 +995,7 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" resource_id: nullable: true title: Resource Id @@ -1013,8 +1014,8 @@ components: title: Weblink type: string required: - - name - - project + - name + - project title: DocumentCreate type: object DocumentPagination: @@ -1022,14 +1023,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/DocumentRead' + $ref: "#/components/schemas/DocumentRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: DocumentPagination type: object DocumentRead: @@ -1063,7 +1064,7 @@ components: filters: default: [] items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array id: @@ -1077,7 +1078,7 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" resource_id: nullable: true title: Resource Id @@ -1096,8 +1097,8 @@ components: title: Weblink type: string required: - - name - - id + - name + - id title: DocumentRead type: object DocumentUpdate: @@ -1130,7 +1131,7 @@ components: type: integer filters: items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array name: @@ -1156,7 +1157,7 @@ components: title: Weblink type: string required: - - name + - name title: DocumentUpdate type: object EntityCreate: @@ -1166,7 +1167,7 @@ components: title: Description type: string entity_type: - $ref: '#/components/schemas/EntityTypeCreate' + $ref: "#/components/schemas/EntityTypeCreate" id: exclusiveMaximum: 2147483647.0 exclusiveMinimum: 0.0 @@ -1177,7 +1178,7 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" source: nullable: true title: Source @@ -1187,23 +1188,23 @@ components: title: Value type: string required: - - entity_type - - project + - entity_type + - project title: EntityCreate type: object EntityPagination: properties: items: items: - $ref: '#/components/schemas/EntityRead' + $ref: "#/components/schemas/EntityRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: EntityPagination type: object EntityRead: @@ -1213,7 +1214,7 @@ components: title: Description type: string entity_type: - $ref: '#/components/schemas/EntityTypeRead' + $ref: "#/components/schemas/EntityTypeRead" id: exclusiveMaximum: 2147483647.0 exclusiveMinimum: 0.0 @@ -1224,7 +1225,7 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" source: nullable: true title: Source @@ -1234,8 +1235,8 @@ components: title: Value type: string required: - - id - - project + - id + - project title: EntityRead type: object EntityTypeCreate: @@ -1265,28 +1266,28 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" regular_expression: nullable: true title: Regular Expression type: string required: - - project + - project title: EntityTypeCreate type: object EntityTypePagination: properties: items: items: - $ref: '#/components/schemas/EntityTypeRead' + $ref: "#/components/schemas/EntityTypeRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: EntityTypePagination type: object EntityTypeRead: @@ -1316,14 +1317,14 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" regular_expression: nullable: true title: Regular Expression type: string required: - - id - - project + - id + - project title: EntityTypeRead type: object EntityTypeUpdate: @@ -1365,7 +1366,7 @@ components: title: Description type: string entity_type: - $ref: '#/components/schemas/EntityTypeUpdate' + $ref: "#/components/schemas/EntityTypeUpdate" id: exclusiveMaximum: 2147483647.0 exclusiveMinimum: 0.0 @@ -1391,14 +1392,14 @@ components: title: Msg type: string required: - - msg + - msg title: ErrorMessage type: object ErrorResponse: properties: detail: items: - $ref: '#/components/schemas/ErrorMessage' + $ref: "#/components/schemas/ErrorMessage" title: Detail type: array title: ErrorResponse @@ -1427,11 +1428,11 @@ components: title: Uuid type: string required: - - uuid - - started_at - - ended_at - - source - - description + - uuid + - started_at + - ended_at + - source + - description title: EventRead type: object ExecutiveReportCreate: @@ -1446,9 +1447,9 @@ components: title: Overview type: string required: - - current_status - - overview - - next_steps + - current_status + - overview + - next_steps title: ExecutiveReportCreate type: object FeedbackCreate: @@ -1462,12 +1463,12 @@ components: title: Feedback type: string incident: - $ref: '#/components/schemas/IncidentReadMinimal' + $ref: "#/components/schemas/IncidentReadMinimal" participant: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" rating: allOf: - - $ref: '#/components/schemas/FeedbackRating' + - $ref: "#/components/schemas/FeedbackRating" default: Very satisfied title: FeedbackCreate type: object @@ -1475,25 +1476,25 @@ components: properties: items: items: - $ref: '#/components/schemas/FeedbackRead' + $ref: "#/components/schemas/FeedbackRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: FeedbackPagination type: object FeedbackRating: description: An enumeration. enum: - - Very satisfied - - Somewhat satisfied - - Neither satisfied nor dissatisfied - - Somewhat dissatisfied - - Very dissatisfied + - Very satisfied + - Somewhat satisfied + - Neither satisfied nor dissatisfied + - Somewhat dissatisfied + - Very dissatisfied title: FeedbackRating type: string FeedbackRead: @@ -1512,17 +1513,17 @@ components: title: Id type: integer incident: - $ref: '#/components/schemas/IncidentReadMinimal' + $ref: "#/components/schemas/IncidentReadMinimal" participant: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" rating: allOf: - - $ref: '#/components/schemas/FeedbackRating' + - $ref: "#/components/schemas/FeedbackRating" default: Very satisfied required: - - id + - id title: FeedbackRead type: object FeedbackUpdate: @@ -1541,12 +1542,12 @@ components: title: Id type: integer incident: - $ref: '#/components/schemas/IncidentReadMinimal' + $ref: "#/components/schemas/IncidentReadMinimal" participant: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" rating: allOf: - - $ref: '#/components/schemas/FeedbackRating' + - $ref: "#/components/schemas/FeedbackRating" default: Very satisfied title: FeedbackUpdate type: object @@ -1583,16 +1584,16 @@ components: title: Weblink type: string required: - - name - - email - - id + - name + - email + - id title: GroupRead type: object HTTPValidationError: properties: detail: items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" title: Detail type: array title: HTTPValidationError @@ -1604,12 +1605,12 @@ components: title: Amount type: number incident_cost_type: - $ref: '#/components/schemas/IncidentCostTypeRead' + $ref: "#/components/schemas/IncidentCostTypeRead" project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - incident_cost_type - - project + - incident_cost_type + - project title: IncidentCostCreate type: object IncidentCostPagination: @@ -1617,14 +1618,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/IncidentCostRead' + $ref: "#/components/schemas/IncidentCostRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: IncidentCostPagination type: object IncidentCostRead: @@ -1639,10 +1640,10 @@ components: title: Id type: integer incident_cost_type: - $ref: '#/components/schemas/IncidentCostTypeRead' + $ref: "#/components/schemas/IncidentCostTypeRead" required: - - id - - incident_cost_type + - id + - incident_cost_type title: IncidentCostRead type: object IncidentCostTypeCreate: @@ -1675,10 +1676,10 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - name - - project + - name + - project title: IncidentCostTypeCreate type: object IncidentCostTypePagination: @@ -1686,14 +1687,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/IncidentCostTypeRead' + $ref: "#/components/schemas/IncidentCostTypeRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: IncidentCostTypePagination type: object IncidentCostTypeRead: @@ -1731,8 +1732,8 @@ components: title: Name type: string required: - - name - - id + - name + - id title: IncidentCostTypeRead type: object IncidentCostTypeUpdate: @@ -1770,7 +1771,7 @@ components: title: Name type: string required: - - name + - name title: IncidentCostTypeUpdate type: object IncidentCostUpdate: @@ -1785,47 +1786,47 @@ components: title: Id type: integer incident_cost_type: - $ref: '#/components/schemas/IncidentCostTypeRead' + $ref: "#/components/schemas/IncidentCostTypeRead" required: - - incident_cost_type + - incident_cost_type title: IncidentCostUpdate type: object IncidentCreate: properties: commander: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" description: title: Description type: string incident_priority: - $ref: '#/components/schemas/IncidentPriorityCreate' + $ref: "#/components/schemas/IncidentPriorityCreate" incident_severity: - $ref: '#/components/schemas/IncidentSeverityCreate' + $ref: "#/components/schemas/IncidentSeverityCreate" incident_type: - $ref: '#/components/schemas/IncidentTypeCreate' + $ref: "#/components/schemas/IncidentTypeCreate" project: - $ref: '#/components/schemas/dispatch__incident__models__ProjectRead' + $ref: "#/components/schemas/dispatch__incident__models__ProjectRead" reporter: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" resolution: title: Resolution type: string status: - $ref: '#/components/schemas/IncidentStatus' + $ref: "#/components/schemas/IncidentStatus" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array title: title: Title type: string visibility: - $ref: '#/components/schemas/Visibility' + $ref: "#/components/schemas/Visibility" required: - - title - - description + - title + - description title: IncidentCreate type: object IncidentPriorityBase: @@ -1857,7 +1858,7 @@ components: title: Page Commander type: boolean project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" tactical_report_reminder: title: Tactical Report Reminder type: integer @@ -1865,7 +1866,7 @@ components: title: View Order type: integer required: - - name + - name title: IncidentPriorityBase type: object IncidentPriorityCreate: @@ -1897,7 +1898,7 @@ components: title: Page Commander type: boolean project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" tactical_report_reminder: title: Tactical Report Reminder type: integer @@ -1905,7 +1906,7 @@ components: title: View Order type: integer required: - - name + - name title: IncidentPriorityCreate type: object IncidentPriorityPagination: @@ -1913,14 +1914,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/IncidentPriorityRead' + $ref: "#/components/schemas/IncidentPriorityRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: IncidentPriorityPagination type: object IncidentPriorityRead: @@ -1957,7 +1958,7 @@ components: title: Page Commander type: boolean project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" tactical_report_reminder: title: Tactical Report Reminder type: integer @@ -1965,8 +1966,8 @@ components: title: View Order type: integer required: - - name - - id + - name + - id title: IncidentPriorityRead type: object IncidentPriorityReadMinimal: @@ -2009,8 +2010,8 @@ components: title: View Order type: integer required: - - id - - name + - id + - name title: IncidentPriorityReadMinimal type: object IncidentPriorityUpdate: @@ -2042,7 +2043,7 @@ components: title: Page Commander type: boolean project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" tactical_report_reminder: title: Tactical Report Reminder type: integer @@ -2050,7 +2051,7 @@ components: title: View Order type: integer required: - - name + - name title: IncidentPriorityUpdate type: object IncidentRead: @@ -2058,7 +2059,7 @@ components: cases: default: [] items: - $ref: '#/components/schemas/dispatch__incident__models__CaseRead' + $ref: "#/components/schemas/dispatch__incident__models__CaseRead" title: Cases type: array closed_at: @@ -2066,14 +2067,14 @@ components: title: Closed At type: string commander: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" commanders_location: title: Commanders Location type: string conference: - $ref: '#/components/schemas/ConferenceRead' + $ref: "#/components/schemas/ConferenceRead" conversation: - $ref: '#/components/schemas/ConversationRead' + $ref: "#/components/schemas/ConversationRead" created_at: format: date-time title: Created At @@ -2084,19 +2085,19 @@ components: documents: default: [] items: - $ref: '#/components/schemas/DocumentRead' + $ref: "#/components/schemas/DocumentRead" title: Documents type: array duplicates: default: [] items: - $ref: '#/components/schemas/IncidentReadMinimal' + $ref: "#/components/schemas/IncidentReadMinimal" title: Duplicates type: array events: default: [] items: - $ref: '#/components/schemas/EventRead' + $ref: "#/components/schemas/EventRead" title: Events type: array id: @@ -2107,19 +2108,19 @@ components: incident_costs: default: [] items: - $ref: '#/components/schemas/IncidentCostRead' + $ref: "#/components/schemas/IncidentCostRead" title: Incident Costs type: array incident_priority: - $ref: '#/components/schemas/IncidentPriorityRead' + $ref: "#/components/schemas/IncidentPriorityRead" incident_severity: - $ref: '#/components/schemas/IncidentSeverityRead' + $ref: "#/components/schemas/IncidentSeverityRead" incident_type: - $ref: '#/components/schemas/IncidentTypeRead' + $ref: "#/components/schemas/IncidentTypeRead" last_executive_report: - $ref: '#/components/schemas/ReportRead' + $ref: "#/components/schemas/ReportRead" last_tactical_report: - $ref: '#/components/schemas/ReportRead' + $ref: "#/components/schemas/ReportRead" name: minLength: 3 pattern: ^(?!\s*$).+ @@ -2128,7 +2129,7 @@ components: participants: default: [] items: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" title: Participants type: array participants_location: @@ -2138,13 +2139,13 @@ components: title: Participants Team type: string project: - $ref: '#/components/schemas/dispatch__incident__models__ProjectRead' + $ref: "#/components/schemas/dispatch__incident__models__ProjectRead" reported_at: format: date-time title: Reported At type: string reporter: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" reporters_location: title: Reporters Location type: string @@ -2156,29 +2157,29 @@ components: title: Stable At type: string status: - $ref: '#/components/schemas/IncidentStatus' + $ref: "#/components/schemas/IncidentStatus" storage: - $ref: '#/components/schemas/StorageRead' + $ref: "#/components/schemas/StorageRead" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array tasks: default: [] items: - $ref: '#/components/schemas/dispatch__incident__models__TaskRead' + $ref: "#/components/schemas/dispatch__incident__models__TaskRead" title: Tasks type: array terms: default: [] items: - $ref: '#/components/schemas/TermRead' + $ref: "#/components/schemas/TermRead" title: Terms type: array ticket: - $ref: '#/components/schemas/TicketRead' + $ref: "#/components/schemas/TicketRead" title: title: Title type: string @@ -2186,21 +2187,21 @@ components: title: Total Cost type: number visibility: - $ref: '#/components/schemas/Visibility' + $ref: "#/components/schemas/Visibility" workflow_instances: default: [] items: - $ref: '#/components/schemas/WorkflowInstanceRead' + $ref: "#/components/schemas/WorkflowInstanceRead" title: Workflow Instances type: array required: - - title - - description - - id - - incident_priority - - incident_severity - - incident_type - - project + - title + - description + - id + - incident_priority + - incident_severity + - incident_type + - project title: IncidentRead type: object IncidentReadMinimal: @@ -2210,7 +2211,7 @@ components: title: Closed At type: string commander: - $ref: '#/components/schemas/ParticipantReadMinimal' + $ref: "#/components/schemas/ParticipantReadMinimal" commanders_location: title: Commanders Location type: string @@ -2224,7 +2225,7 @@ components: duplicates: default: [] items: - $ref: '#/components/schemas/IncidentReadMinimal' + $ref: "#/components/schemas/IncidentReadMinimal" title: Duplicates type: array id: @@ -2235,15 +2236,15 @@ components: incident_costs: default: [] items: - $ref: '#/components/schemas/IncidentCostRead' + $ref: "#/components/schemas/IncidentCostRead" title: Incident Costs type: array incident_priority: - $ref: '#/components/schemas/IncidentPriorityReadMinimal' + $ref: "#/components/schemas/IncidentPriorityReadMinimal" incident_severity: - $ref: '#/components/schemas/IncidentSeverityReadMinimal' + $ref: "#/components/schemas/IncidentSeverityReadMinimal" incident_type: - $ref: '#/components/schemas/IncidentTypeReadMinimal' + $ref: "#/components/schemas/IncidentTypeReadMinimal" name: minLength: 3 pattern: ^(?!\s*$).+ @@ -2256,13 +2257,13 @@ components: title: Participants Team type: string project: - $ref: '#/components/schemas/dispatch__incident__models__ProjectRead' + $ref: "#/components/schemas/dispatch__incident__models__ProjectRead" reported_at: format: date-time title: Reported At type: string reporter: - $ref: '#/components/schemas/ParticipantReadMinimal' + $ref: "#/components/schemas/ParticipantReadMinimal" reporters_location: title: Reporters Location type: string @@ -2274,11 +2275,11 @@ components: title: Stable At type: string status: - $ref: '#/components/schemas/IncidentStatus' + $ref: "#/components/schemas/IncidentStatus" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array title: @@ -2288,15 +2289,15 @@ components: title: Total Cost type: number visibility: - $ref: '#/components/schemas/Visibility' + $ref: "#/components/schemas/Visibility" required: - - title - - description - - id - - incident_priority - - incident_severity - - incident_type - - project + - title + - description + - id + - incident_priority + - incident_severity + - incident_type + - project title: IncidentReadMinimal type: object IncidentRoleCreateUpdate: @@ -2311,27 +2312,27 @@ components: type: integer incident_priorities: items: - $ref: '#/components/schemas/IncidentPriorityRead' + $ref: "#/components/schemas/IncidentPriorityRead" title: Incident Priorities type: array incident_types: items: - $ref: '#/components/schemas/IncidentTypeRead' + $ref: "#/components/schemas/IncidentTypeRead" title: Incident Types type: array individual: - $ref: '#/components/schemas/IndividualContactRead' + $ref: "#/components/schemas/IndividualContactRead" order: exclusiveMinimum: 0.0 title: Order type: integer project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" service: - $ref: '#/components/schemas/ServiceRead' + $ref: "#/components/schemas/ServiceRead" tags: items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array title: IncidentRoleCreateUpdate @@ -2352,27 +2353,27 @@ components: type: integer incident_priorities: items: - $ref: '#/components/schemas/IncidentPriorityRead' + $ref: "#/components/schemas/IncidentPriorityRead" title: Incident Priorities type: array incident_types: items: - $ref: '#/components/schemas/IncidentTypeRead' + $ref: "#/components/schemas/IncidentTypeRead" title: Incident Types type: array individual: - $ref: '#/components/schemas/IndividualContactRead' + $ref: "#/components/schemas/IndividualContactRead" order: exclusiveMinimum: 0.0 title: Order type: integer role: - $ref: '#/components/schemas/ParticipantRoleType' + $ref: "#/components/schemas/ParticipantRoleType" service: - $ref: '#/components/schemas/ServiceRead' + $ref: "#/components/schemas/ServiceRead" tags: items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array updated_at: @@ -2380,8 +2381,8 @@ components: title: Updated At type: string required: - - id - - role + - id + - role title: IncidentRoleRead type: object IncidentRoles: @@ -2389,7 +2390,7 @@ components: policies: default: [] items: - $ref: '#/components/schemas/IncidentRoleRead' + $ref: "#/components/schemas/IncidentRoleRead" title: Policies type: array title: IncidentRoles @@ -2398,11 +2399,11 @@ components: properties: policies: items: - $ref: '#/components/schemas/IncidentRoleCreateUpdate' + $ref: "#/components/schemas/IncidentRoleCreateUpdate" title: Policies type: array required: - - policies + - policies title: IncidentRolesCreateUpdate type: object IncidentSeverityBase: @@ -2428,12 +2429,12 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" view_order: title: View Order type: integer required: - - name + - name title: IncidentSeverityBase type: object IncidentSeverityCreate: @@ -2459,12 +2460,12 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" view_order: title: View Order type: integer required: - - name + - name title: IncidentSeverityCreate type: object IncidentSeverityPagination: @@ -2472,14 +2473,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/IncidentSeverityRead' + $ref: "#/components/schemas/IncidentSeverityRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: IncidentSeverityPagination type: object IncidentSeverityRead: @@ -2510,13 +2511,13 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" view_order: title: View Order type: integer required: - - name - - id + - name + - id title: IncidentSeverityRead type: object IncidentSeverityReadMinimal: @@ -2547,8 +2548,8 @@ components: title: Name type: string required: - - id - - name + - id + - name title: IncidentSeverityReadMinimal type: object IncidentSeverityUpdate: @@ -2574,20 +2575,20 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" view_order: title: View Order type: integer required: - - name + - name title: IncidentSeverityUpdate type: object IncidentStatus: description: An enumeration. enum: - - Active - - Stable - - Closed + - Active + - Stable + - Closed title: IncidentStatus type: string IncidentType: @@ -2611,8 +2612,8 @@ components: title: Visibility type: string required: - - id - - name + - id + - name title: IncidentType type: object IncidentTypeBase: @@ -2633,9 +2634,9 @@ components: title: Exclude From Metrics type: boolean executive_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" incident_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" name: minLength: 3 pattern: ^(?!\s*$).+ @@ -2644,21 +2645,21 @@ components: plugin_metadata: default: [] items: - $ref: '#/components/schemas/PluginMetadata' + $ref: "#/components/schemas/PluginMetadata" title: Plugin Metadata type: array project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" review_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" tracking_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" visibility: nullable: true title: Visibility type: string required: - - name + - name title: IncidentTypeBase type: object IncidentTypeCreate: @@ -2679,9 +2680,9 @@ components: title: Exclude From Metrics type: boolean executive_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" incident_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" name: minLength: 3 pattern: ^(?!\s*$).+ @@ -2690,21 +2691,21 @@ components: plugin_metadata: default: [] items: - $ref: '#/components/schemas/PluginMetadata' + $ref: "#/components/schemas/PluginMetadata" title: Plugin Metadata type: array project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" review_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" tracking_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" visibility: nullable: true title: Visibility type: string required: - - name + - name title: IncidentTypeCreate type: object IncidentTypePagination: @@ -2712,14 +2713,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/IncidentTypeRead' + $ref: "#/components/schemas/IncidentTypeRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: IncidentTypePagination type: object IncidentTypeRead: @@ -2740,14 +2741,14 @@ components: title: Exclude From Metrics type: boolean executive_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" id: exclusiveMaximum: 2147483647.0 exclusiveMinimum: 0.0 title: Id type: integer incident_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" name: minLength: 3 pattern: ^(?!\s*$).+ @@ -2756,22 +2757,22 @@ components: plugin_metadata: default: [] items: - $ref: '#/components/schemas/PluginMetadata' + $ref: "#/components/schemas/PluginMetadata" title: Plugin Metadata type: array project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" review_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" tracking_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" visibility: nullable: true title: Visibility type: string required: - - name - - id + - name + - id title: IncidentTypeRead type: object IncidentTypeReadMinimal: @@ -2806,8 +2807,8 @@ components: title: Visibility type: string required: - - id - - name + - id + - name title: IncidentTypeReadMinimal type: object IncidentTypeUpdate: @@ -2828,14 +2829,14 @@ components: title: Exclude From Metrics type: boolean executive_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" id: exclusiveMaximum: 2147483647.0 exclusiveMinimum: 0.0 title: Id type: integer incident_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" name: minLength: 3 pattern: ^(?!\s*$).+ @@ -2844,21 +2845,21 @@ components: plugin_metadata: default: [] items: - $ref: '#/components/schemas/PluginMetadata' + $ref: "#/components/schemas/PluginMetadata" title: Plugin Metadata type: array project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" review_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" tracking_template_document: - $ref: '#/components/schemas/dispatch__incident__type__models__Document' + $ref: "#/components/schemas/dispatch__incident__type__models__Document" visibility: nullable: true title: Visibility type: string required: - - name + - name title: IncidentTypeUpdate type: object IncidentUpdate: @@ -2866,38 +2867,38 @@ components: cases: default: [] items: - $ref: '#/components/schemas/dispatch__incident__models__CaseRead' + $ref: "#/components/schemas/dispatch__incident__models__CaseRead" title: Cases type: array commander: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" description: title: Description type: string duplicates: default: [] items: - $ref: '#/components/schemas/IncidentReadMinimal' + $ref: "#/components/schemas/IncidentReadMinimal" title: Duplicates type: array incident_costs: default: [] items: - $ref: '#/components/schemas/IncidentCostUpdate' + $ref: "#/components/schemas/IncidentCostUpdate" title: Incident Costs type: array incident_priority: - $ref: '#/components/schemas/IncidentPriorityBase' + $ref: "#/components/schemas/IncidentPriorityBase" incident_severity: - $ref: '#/components/schemas/IncidentSeverityBase' + $ref: "#/components/schemas/IncidentSeverityBase" incident_type: - $ref: '#/components/schemas/IncidentTypeBase' + $ref: "#/components/schemas/IncidentTypeBase" reported_at: format: date-time title: Reported At type: string reporter: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" resolution: title: Resolution type: string @@ -2906,30 +2907,30 @@ components: title: Stable At type: string status: - $ref: '#/components/schemas/IncidentStatus' + $ref: "#/components/schemas/IncidentStatus" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array terms: default: [] items: - $ref: '#/components/schemas/TermRead' + $ref: "#/components/schemas/TermRead" title: Terms type: array title: title: Title type: string visibility: - $ref: '#/components/schemas/Visibility' + $ref: "#/components/schemas/Visibility" required: - - title - - description - - incident_priority - - incident_severity - - incident_type + - title + - description + - incident_priority + - incident_severity + - incident_type title: IncidentUpdate type: object IndividualContactCreate: @@ -2952,7 +2953,7 @@ components: type: string filters: items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array is_active: @@ -2984,7 +2985,7 @@ components: title: Owner type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" title: nullable: true title: Title @@ -2994,8 +2995,8 @@ components: title: Weblink type: string required: - - email - - project + - email + - project title: IndividualContactCreate type: object IndividualContactPagination: @@ -3003,14 +3004,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/IndividualContactRead' + $ref: "#/components/schemas/IndividualContactRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: IndividualContactPagination type: object IndividualContactRead: @@ -3038,7 +3039,7 @@ components: filters: default: [] items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array id: @@ -3087,7 +3088,7 @@ components: title: Weblink type: string required: - - email + - email title: IndividualContactRead type: object IndividualContactReadMinimal: @@ -3158,7 +3159,7 @@ components: title: Weblink type: string required: - - email + - email title: IndividualContactReadMinimal type: object IndividualContactUpdate: @@ -3181,7 +3182,7 @@ components: type: string filters: items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array is_active: @@ -3221,7 +3222,7 @@ components: title: Weblink type: string required: - - email + - email title: IndividualContactUpdate type: object KeyValue: @@ -3233,8 +3234,8 @@ components: title: Value type: string required: - - key - - value + - key + - value title: KeyValue type: object NotificationCreate: @@ -3265,7 +3266,7 @@ components: type: integer filters: items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array name: @@ -3274,17 +3275,17 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" target: title: Target type: string type: - $ref: '#/components/schemas/NotificationTypeEnum' + $ref: "#/components/schemas/NotificationTypeEnum" required: - - name - - type - - target - - project + - name + - type + - target + - project title: NotificationCreate type: object NotificationPagination: @@ -3292,14 +3293,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/NotificationRead' + $ref: "#/components/schemas/NotificationRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: NotificationPagination type: object NotificationRead: @@ -3334,7 +3335,7 @@ components: type: integer filters: items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array id: @@ -3351,23 +3352,23 @@ components: title: Target type: string type: - $ref: '#/components/schemas/NotificationTypeEnum' + $ref: "#/components/schemas/NotificationTypeEnum" updated_at: format: date-time title: Updated At type: string required: - - name - - type - - target - - id + - name + - type + - target + - id title: NotificationRead type: object NotificationTypeEnum: description: An enumeration. enum: - - conversation - - email + - conversation + - email title: NotificationTypeEnum type: string NotificationUpdate: @@ -3398,7 +3399,7 @@ components: type: integer filters: items: - $ref: '#/components/schemas/SearchFilterUpdate' + $ref: "#/components/schemas/SearchFilterUpdate" title: Filters type: array name: @@ -3410,11 +3411,11 @@ components: title: Target type: string type: - $ref: '#/components/schemas/NotificationTypeEnum' + $ref: "#/components/schemas/NotificationTypeEnum" required: - - name - - type - - target + - name + - type + - target title: NotificationUpdate type: object OrganizationCreate: @@ -3455,7 +3456,7 @@ components: title: Name type: string required: - - name + - name title: OrganizationCreate type: object OrganizationPagination: @@ -3463,14 +3464,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/OrganizationRead' + $ref: "#/components/schemas/OrganizationRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: OrganizationPagination type: object OrganizationRead: @@ -3516,7 +3517,7 @@ components: title: Slug type: string required: - - name + - name title: OrganizationRead type: object OrganizationUpdate: @@ -3569,7 +3570,7 @@ components: title: Id type: integer individual: - $ref: '#/components/schemas/IndividualContactRead' + $ref: "#/components/schemas/IndividualContactRead" location: nullable: true title: Location @@ -3577,7 +3578,7 @@ components: participant_roles: default: [] items: - $ref: '#/components/schemas/ParticipantRoleRead' + $ref: "#/components/schemas/ParticipantRoleRead" title: Participant Roles type: array team: @@ -3585,7 +3586,7 @@ components: title: Team type: string required: - - id + - id title: ParticipantRead type: object ParticipantReadMinimal: @@ -3604,7 +3605,7 @@ components: title: Id type: integer individual: - $ref: '#/components/schemas/IndividualContactReadMinimal' + $ref: "#/components/schemas/IndividualContactReadMinimal" location: nullable: true title: Location @@ -3612,7 +3613,7 @@ components: participant_roles: default: [] items: - $ref: '#/components/schemas/ParticipantRoleReadMinimal' + $ref: "#/components/schemas/ParticipantRoleReadMinimal" title: Participant Roles type: array team: @@ -3620,7 +3621,7 @@ components: title: Team type: string required: - - id + - id title: ParticipantReadMinimal type: object ParticipantRoleRead: @@ -3645,8 +3646,8 @@ components: title: Role type: string required: - - role - - id + - role + - id title: ParticipantRoleRead type: object ParticipantRoleReadMinimal: @@ -3671,20 +3672,20 @@ components: title: Role type: string required: - - role - - id + - role + - id title: ParticipantRoleReadMinimal type: object ParticipantRoleType: description: An enumeration. enum: - - Assignee - - Incident Commander - - Liaison - - Scribe - - Participant - - Observer - - Reporter + - Assignee + - Incident Commander + - Liaison + - Scribe + - Participant + - Observer + - Reporter title: ParticipantRoleType type: string ParticipantUpdate: @@ -3698,7 +3699,7 @@ components: title: Department type: string individual: - $ref: '#/components/schemas/IndividualContactRead' + $ref: "#/components/schemas/IndividualContactRead" location: nullable: true title: Location @@ -3718,12 +3719,12 @@ components: title: Enabled type: boolean plugin: - $ref: '#/components/schemas/PluginRead' + $ref: "#/components/schemas/PluginRead" project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - plugin - - project + - plugin + - project title: PluginInstanceCreate type: object PluginInstancePagination: @@ -3731,14 +3732,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/PluginInstanceRead' + $ref: "#/components/schemas/PluginInstanceRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: PluginInstancePagination type: object PluginInstanceRead: @@ -3757,12 +3758,12 @@ components: title: Id type: integer plugin: - $ref: '#/components/schemas/PluginRead' + $ref: "#/components/schemas/PluginRead" project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - id - - plugin + - id + - plugin title: PluginInstanceRead type: object PluginInstanceUpdate: @@ -3785,14 +3786,14 @@ components: metadata: default: [] items: - $ref: '#/components/schemas/KeyValue' + $ref: "#/components/schemas/KeyValue" title: Metadata type: array slug: title: Slug type: string required: - - slug + - slug title: PluginMetadata type: object PluginPagination: @@ -3800,14 +3801,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/PluginRead' + $ref: "#/components/schemas/PluginRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: PluginPagination type: object PluginRead: @@ -3842,13 +3843,13 @@ components: title: Type type: string required: - - id - - title - - slug - - author - - author_url - - type - - multiple + - id + - title + - slug + - author + - author_url + - type + - multiple title: PluginRead type: object ProjectCreate: @@ -3882,7 +3883,7 @@ components: title: Name type: string organization: - $ref: '#/components/schemas/OrganizationRead' + $ref: "#/components/schemas/OrganizationRead" owner_conversation: nullable: true title: Owner Conversation @@ -3893,8 +3894,8 @@ components: title: Owner Email type: string required: - - name - - organization + - name + - organization title: ProjectCreate type: object ProjectPagination: @@ -3902,14 +3903,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: ProjectPagination type: object ProjectUpdate: @@ -3952,7 +3953,7 @@ components: title: Owner Email type: string required: - - name + - name title: ProjectUpdate type: object QueryCreate: @@ -3970,13 +3971,13 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" source: - $ref: '#/components/schemas/SourceRead' + $ref: "#/components/schemas/SourceRead" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array text: @@ -3984,23 +3985,23 @@ components: title: Text type: string required: - - source - - project + - source + - project title: QueryCreate type: object QueryPagination: properties: items: items: - $ref: '#/components/schemas/QueryRead' + $ref: "#/components/schemas/QueryRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: QueryPagination type: object QueryRead: @@ -4023,13 +4024,13 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" source: - $ref: '#/components/schemas/SourceRead' + $ref: "#/components/schemas/SourceRead" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array text: @@ -4037,9 +4038,9 @@ components: title: Text type: string required: - - source - - project - - id + - source + - project + - id title: QueryRead type: object QueryReadMinimal: @@ -4056,9 +4057,9 @@ components: title: Name type: string required: - - id - - name - - description + - id + - name + - description title: QueryReadMinimal type: object QueryUpdate: @@ -4081,13 +4082,13 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" source: - $ref: '#/components/schemas/SourceRead' + $ref: "#/components/schemas/SourceRead" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array text: @@ -4095,8 +4096,8 @@ components: title: Text type: string required: - - source - - project + - source + - project title: QueryUpdate type: object ReportRead: @@ -4112,17 +4113,17 @@ components: title: Id type: integer type: - $ref: '#/components/schemas/ReportTypes' + $ref: "#/components/schemas/ReportTypes" required: - - type - - id + - type + - id title: ReportRead type: object ReportTypes: description: An enumeration. enum: - - Tactical Report - - Executive Report + - Tactical Report + - Executive Report title: ReportTypes type: string SearchFilterCreate: @@ -4142,36 +4143,36 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" subject: allOf: - - $ref: '#/components/schemas/SearchFilterSubject' + - $ref: "#/components/schemas/SearchFilterSubject" default: incident required: - - expression - - name - - project + - expression + - name + - project title: SearchFilterCreate type: object SearchFilterPagination: properties: items: items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: SearchFilterPagination type: object SearchFilterRead: properties: creator: - $ref: '#/components/schemas/UserRead' + $ref: "#/components/schemas/UserRead" description: nullable: true title: Description @@ -4193,19 +4194,19 @@ components: type: string subject: allOf: - - $ref: '#/components/schemas/SearchFilterSubject' + - $ref: "#/components/schemas/SearchFilterSubject" default: incident required: - - expression - - name - - id + - expression + - name + - id title: SearchFilterRead type: object SearchFilterSubject: description: An enumeration. enum: - - case - - incident + - case + - incident title: SearchFilterSubject type: string SearchFilterUpdate: @@ -4231,32 +4232,32 @@ components: type: string subject: allOf: - - $ref: '#/components/schemas/SearchFilterSubject' + - $ref: "#/components/schemas/SearchFilterSubject" default: incident required: - - expression - - name + - expression + - name title: SearchFilterUpdate type: object SearchTypes: description: An enumeration. enum: - - Definition - - Document - - Incident - - IncidentPriority - - IncidentType - - IndividualContact - - Plugin - - Query - - SearchFilter - - Case - - Service - - Source - - Tag - - Task - - TeamContact - - Term + - Definition + - Document + - Incident + - IncidentPriority + - IncidentType + - IndividualContact + - Plugin + - Query + - SearchFilter + - Case + - Service + - Source + - Tag + - Task + - TeamContact + - Term title: SearchTypes type: string ServiceCreate: @@ -4289,7 +4290,7 @@ components: filters: default: [] items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array is_active: @@ -4300,13 +4301,13 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" type: nullable: true title: Type type: string required: - - project + - project title: ServiceCreate type: object ServicePagination: @@ -4314,14 +4315,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/ServiceRead' + $ref: "#/components/schemas/ServiceRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: ServicePagination type: object ServiceRead: @@ -4358,7 +4359,7 @@ components: filters: default: [] items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array id: @@ -4382,7 +4383,7 @@ components: title: Updated At type: string required: - - id + - id title: ServiceRead type: object ServiceUpdate: @@ -4415,7 +4416,7 @@ components: filters: default: [] items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array is_active: @@ -4434,9 +4435,9 @@ components: SignalCreate: properties: case_priority: - $ref: '#/components/schemas/CasePriorityRead' + $ref: "#/components/schemas/CasePriorityRead" case_type: - $ref: '#/components/schemas/CaseTypeRead' + $ref: "#/components/schemas/CaseTypeRead" conversation_target: title: Conversation Target type: string @@ -4458,7 +4459,7 @@ components: entity_types: default: [] items: - $ref: '#/components/schemas/EntityTypeRead' + $ref: "#/components/schemas/EntityTypeRead" title: Entity Types type: array external_id: @@ -4470,25 +4471,25 @@ components: filters: default: [] items: - $ref: '#/components/schemas/SignalFilterRead' + $ref: "#/components/schemas/SignalFilterRead" title: Filters type: array name: title: Name type: string oncall_service: - $ref: '#/components/schemas/dispatch__signal__models__Service' + $ref: "#/components/schemas/dispatch__signal__models__Service" owner: title: Owner type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" source: - $ref: '#/components/schemas/SourceBase' + $ref: "#/components/schemas/SourceBase" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array variant: @@ -4497,28 +4498,28 @@ components: workflows: default: [] items: - $ref: '#/components/schemas/WorkflowRead' + $ref: "#/components/schemas/WorkflowRead" title: Workflows type: array required: - - name - - owner - - external_id - - project + - name + - owner + - external_id + - project title: SignalCreate type: object SignalFilterAction: description: An enumeration. enum: - - deduplicate - - snooze + - deduplicate + - snooze title: SignalFilterAction type: string SignalFilterCreate: properties: action: allOf: - - $ref: '#/components/schemas/SignalFilterAction' + - $ref: "#/components/schemas/SignalFilterAction" default: snooze description: nullable: true @@ -4536,7 +4537,7 @@ components: type: array mode: allOf: - - $ref: '#/components/schemas/SignalFilterMode' + - $ref: "#/components/schemas/SignalFilterMode" default: active name: minLength: 3 @@ -4544,46 +4545,46 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" window: default: 600 title: Window type: integer required: - - expression - - name - - project + - expression + - name + - project title: SignalFilterCreate type: object SignalFilterMode: description: An enumeration. enum: - - active - - monitor - - inactive - - expired + - active + - monitor + - inactive + - expired title: SignalFilterMode type: string SignalFilterPagination: properties: items: items: - $ref: '#/components/schemas/SignalFilterRead' + $ref: "#/components/schemas/SignalFilterRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: SignalFilterPagination type: object SignalFilterRead: properties: action: allOf: - - $ref: '#/components/schemas/SignalFilterAction' + - $ref: "#/components/schemas/SignalFilterAction" default: snooze description: nullable: true @@ -4606,7 +4607,7 @@ components: type: integer mode: allOf: - - $ref: '#/components/schemas/SignalFilterMode' + - $ref: "#/components/schemas/SignalFilterMode" default: active name: minLength: 3 @@ -4618,16 +4619,16 @@ components: title: Window type: integer required: - - expression - - name - - id + - expression + - name + - id title: SignalFilterRead type: object SignalFilterUpdate: properties: action: allOf: - - $ref: '#/components/schemas/SignalFilterAction' + - $ref: "#/components/schemas/SignalFilterAction" default: snooze description: nullable: true @@ -4650,7 +4651,7 @@ components: type: integer mode: allOf: - - $ref: '#/components/schemas/SignalFilterMode' + - $ref: "#/components/schemas/SignalFilterMode" default: active name: minLength: 3 @@ -4662,15 +4663,15 @@ components: title: Window type: integer required: - - expression - - name - - id + - expression + - name + - id title: SignalFilterUpdate type: object SignalInstanceCreate: properties: case: - $ref: '#/components/schemas/dispatch__case__models__CaseRead' + $ref: "#/components/schemas/dispatch__case__models__CaseRead" created_at: format: date-time title: Created At @@ -4678,59 +4679,59 @@ components: entities: default: [] items: - $ref: '#/components/schemas/EntityRead' + $ref: "#/components/schemas/EntityRead" title: Entities type: array filter_action: - $ref: '#/components/schemas/SignalFilterAction' + $ref: "#/components/schemas/SignalFilterAction" project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" raw: title: Raw type: object signal: - $ref: '#/components/schemas/dispatch__signal__models__SignalRead' + $ref: "#/components/schemas/dispatch__signal__models__SignalRead" required: - - project - - raw + - project + - raw title: SignalInstanceCreate type: object SignalInstancePagination: properties: items: items: - $ref: '#/components/schemas/dispatch__signal__models__SignalInstanceRead' + $ref: "#/components/schemas/dispatch__signal__models__SignalInstanceRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: SignalInstancePagination type: object SignalPagination: properties: items: items: - $ref: '#/components/schemas/dispatch__signal__models__SignalRead' + $ref: "#/components/schemas/dispatch__signal__models__SignalRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: SignalPagination type: object SignalUpdate: properties: case_priority: - $ref: '#/components/schemas/CasePriorityRead' + $ref: "#/components/schemas/CasePriorityRead" case_type: - $ref: '#/components/schemas/CaseTypeRead' + $ref: "#/components/schemas/CaseTypeRead" conversation_target: title: Conversation Target type: string @@ -4752,7 +4753,7 @@ components: entity_types: default: [] items: - $ref: '#/components/schemas/EntityTypeRead' + $ref: "#/components/schemas/EntityTypeRead" title: Entity Types type: array external_id: @@ -4764,7 +4765,7 @@ components: filters: default: [] items: - $ref: '#/components/schemas/SignalFilterRead' + $ref: "#/components/schemas/SignalFilterRead" title: Filters type: array id: @@ -4776,18 +4777,18 @@ components: title: Name type: string oncall_service: - $ref: '#/components/schemas/dispatch__signal__models__Service' + $ref: "#/components/schemas/dispatch__signal__models__Service" owner: title: Owner type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" source: - $ref: '#/components/schemas/SourceBase' + $ref: "#/components/schemas/SourceBase" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array variant: @@ -4796,15 +4797,15 @@ components: workflows: default: [] items: - $ref: '#/components/schemas/WorkflowRead' + $ref: "#/components/schemas/WorkflowRead" title: Workflows type: array required: - - name - - owner - - external_id - - project - - id + - name + - owner + - external_id + - project + - id title: SignalUpdate type: object SourceBase: @@ -4817,7 +4818,7 @@ components: alerts: default: [] items: - $ref: '#/components/schemas/AlertRead' + $ref: "#/components/schemas/AlertRead" title: Alerts type: array cost: @@ -4847,7 +4848,7 @@ components: incidents: default: [] items: - $ref: '#/components/schemas/IncidentRead' + $ref: "#/components/schemas/IncidentRead" title: Incidents type: array links: @@ -4861,15 +4862,15 @@ components: type: string owner: allOf: - - $ref: '#/components/schemas/ServiceRead' + - $ref: "#/components/schemas/ServiceRead" nullable: true title: Owner project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" queries: default: [] items: - $ref: '#/components/schemas/QueryReadMinimal' + $ref: "#/components/schemas/QueryReadMinimal" title: Queries type: array retention: @@ -4889,27 +4890,27 @@ components: title: Size type: integer source_data_format: - $ref: '#/components/schemas/SourceDataFormatRead' + $ref: "#/components/schemas/SourceDataFormatRead" source_environment: - $ref: '#/components/schemas/SourceEnvironmentRead' + $ref: "#/components/schemas/SourceEnvironmentRead" source_schema: nullable: true title: Source Schema type: string source_status: - $ref: '#/components/schemas/SourceStatusRead' + $ref: "#/components/schemas/SourceStatusRead" source_transport: - $ref: '#/components/schemas/SourceTransportRead' + $ref: "#/components/schemas/SourceTransportRead" source_type: - $ref: '#/components/schemas/SourceTypeRead' + $ref: "#/components/schemas/SourceTypeRead" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array required: - - project + - project title: SourceBase type: object SourceCreate: @@ -4922,7 +4923,7 @@ components: alerts: default: [] items: - $ref: '#/components/schemas/AlertRead' + $ref: "#/components/schemas/AlertRead" title: Alerts type: array cost: @@ -4952,7 +4953,7 @@ components: incidents: default: [] items: - $ref: '#/components/schemas/IncidentRead' + $ref: "#/components/schemas/IncidentRead" title: Incidents type: array links: @@ -4966,15 +4967,15 @@ components: type: string owner: allOf: - - $ref: '#/components/schemas/ServiceRead' + - $ref: "#/components/schemas/ServiceRead" nullable: true title: Owner project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" queries: default: [] items: - $ref: '#/components/schemas/QueryReadMinimal' + $ref: "#/components/schemas/QueryReadMinimal" title: Queries type: array retention: @@ -4994,27 +4995,27 @@ components: title: Size type: integer source_data_format: - $ref: '#/components/schemas/SourceDataFormatRead' + $ref: "#/components/schemas/SourceDataFormatRead" source_environment: - $ref: '#/components/schemas/SourceEnvironmentRead' + $ref: "#/components/schemas/SourceEnvironmentRead" source_schema: nullable: true title: Source Schema type: string source_status: - $ref: '#/components/schemas/SourceStatusRead' + $ref: "#/components/schemas/SourceStatusRead" source_transport: - $ref: '#/components/schemas/SourceTransportRead' + $ref: "#/components/schemas/SourceTransportRead" source_type: - $ref: '#/components/schemas/SourceTypeRead' + $ref: "#/components/schemas/SourceTypeRead" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array required: - - project + - project title: SourceCreate type: object SourceDataFormatCreate: @@ -5028,24 +5029,24 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - project + - project title: SourceDataFormatCreate type: object SourceDataFormatPagination: properties: items: items: - $ref: '#/components/schemas/SourceDataFormatRead' + $ref: "#/components/schemas/SourceDataFormatRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: SourceDataFormatPagination type: object SourceDataFormatRead: @@ -5064,10 +5065,10 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - id - - project + - id + - project title: SourceDataFormatRead type: object SourceDataFormatUpdate: @@ -5086,7 +5087,7 @@ components: title: Name type: string required: - - id + - id title: SourceDataFormatUpdate type: object SourceEnvironmentCreate: @@ -5100,24 +5101,24 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - project + - project title: SourceEnvironmentCreate type: object SourceEnvironmentPagination: properties: items: items: - $ref: '#/components/schemas/SourceEnvironmentRead' + $ref: "#/components/schemas/SourceEnvironmentRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: SourceEnvironmentPagination type: object SourceEnvironmentRead: @@ -5136,10 +5137,10 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - id - - project + - id + - project title: SourceEnvironmentRead type: object SourceEnvironmentUpdate: @@ -5158,22 +5159,22 @@ components: title: Name type: string required: - - id + - id title: SourceEnvironmentUpdate type: object SourcePagination: properties: items: items: - $ref: '#/components/schemas/SourceRead' + $ref: "#/components/schemas/SourceRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: SourcePagination type: object SourceRead: @@ -5186,7 +5187,7 @@ components: alerts: default: [] items: - $ref: '#/components/schemas/AlertRead' + $ref: "#/components/schemas/AlertRead" title: Alerts type: array cost: @@ -5221,7 +5222,7 @@ components: incidents: default: [] items: - $ref: '#/components/schemas/IncidentRead' + $ref: "#/components/schemas/IncidentRead" title: Incidents type: array links: @@ -5235,15 +5236,15 @@ components: type: string owner: allOf: - - $ref: '#/components/schemas/ServiceRead' + - $ref: "#/components/schemas/ServiceRead" nullable: true title: Owner project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" queries: default: [] items: - $ref: '#/components/schemas/QueryReadMinimal' + $ref: "#/components/schemas/QueryReadMinimal" title: Queries type: array retention: @@ -5263,28 +5264,28 @@ components: title: Size type: integer source_data_format: - $ref: '#/components/schemas/SourceDataFormatRead' + $ref: "#/components/schemas/SourceDataFormatRead" source_environment: - $ref: '#/components/schemas/SourceEnvironmentRead' + $ref: "#/components/schemas/SourceEnvironmentRead" source_schema: nullable: true title: Source Schema type: string source_status: - $ref: '#/components/schemas/SourceStatusRead' + $ref: "#/components/schemas/SourceStatusRead" source_transport: - $ref: '#/components/schemas/SourceTransportRead' + $ref: "#/components/schemas/SourceTransportRead" source_type: - $ref: '#/components/schemas/SourceTypeRead' + $ref: "#/components/schemas/SourceTypeRead" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array required: - - project - - id + - project + - id title: SourceRead type: object SourceStatusCreate: @@ -5298,24 +5299,24 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - project + - project title: SourceStatusCreate type: object SourceStatusPagination: properties: items: items: - $ref: '#/components/schemas/SourceStatusRead' + $ref: "#/components/schemas/SourceStatusRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: SourceStatusPagination type: object SourceStatusRead: @@ -5334,10 +5335,10 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - id - - project + - id + - project title: SourceStatusRead type: object SourceStatusUpdate: @@ -5356,7 +5357,7 @@ components: title: Name type: string required: - - id + - id title: SourceStatusUpdate type: object SourceTransportCreate: @@ -5370,24 +5371,24 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - project + - project title: SourceTransportCreate type: object SourceTransportPagination: properties: items: items: - $ref: '#/components/schemas/SourceTransportRead' + $ref: "#/components/schemas/SourceTransportRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: SourceTransportPagination type: object SourceTransportRead: @@ -5406,10 +5407,10 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - id - - project + - id + - project title: SourceTransportRead type: object SourceTransportUpdate: @@ -5428,7 +5429,7 @@ components: title: Name type: string required: - - id + - id title: SourceTransportUpdate type: object SourceTypeCreate: @@ -5442,24 +5443,24 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - project + - project title: SourceTypeCreate type: object SourceTypePagination: properties: items: items: - $ref: '#/components/schemas/SourceTypeRead' + $ref: "#/components/schemas/SourceTypeRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: SourceTypePagination type: object SourceTypeRead: @@ -5478,10 +5479,10 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - id - - project + - id + - project title: SourceTypeRead type: object SourceTypeUpdate: @@ -5500,7 +5501,7 @@ components: title: Name type: string required: - - id + - id title: SourceTypeUpdate type: object SourceUpdate: @@ -5513,7 +5514,7 @@ components: alerts: default: [] items: - $ref: '#/components/schemas/AlertRead' + $ref: "#/components/schemas/AlertRead" title: Alerts type: array cost: @@ -5548,7 +5549,7 @@ components: incidents: default: [] items: - $ref: '#/components/schemas/IncidentRead' + $ref: "#/components/schemas/IncidentRead" title: Incidents type: array links: @@ -5562,15 +5563,15 @@ components: type: string owner: allOf: - - $ref: '#/components/schemas/ServiceRead' + - $ref: "#/components/schemas/ServiceRead" nullable: true title: Owner project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" queries: default: [] items: - $ref: '#/components/schemas/QueryReadMinimal' + $ref: "#/components/schemas/QueryReadMinimal" title: Queries type: array retention: @@ -5590,27 +5591,27 @@ components: title: Size type: integer source_data_format: - $ref: '#/components/schemas/SourceDataFormatRead' + $ref: "#/components/schemas/SourceDataFormatRead" source_environment: - $ref: '#/components/schemas/SourceEnvironmentRead' + $ref: "#/components/schemas/SourceEnvironmentRead" source_schema: nullable: true title: Source Schema type: string source_status: - $ref: '#/components/schemas/SourceStatusRead' + $ref: "#/components/schemas/SourceStatusRead" source_transport: - $ref: '#/components/schemas/SourceTransportRead' + $ref: "#/components/schemas/SourceTransportRead" source_type: - $ref: '#/components/schemas/SourceTypeRead' + $ref: "#/components/schemas/SourceTypeRead" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array required: - - project + - project title: SourceUpdate type: object StorageRead: @@ -5645,9 +5646,9 @@ components: title: Needs type: string required: - - conditions - - actions - - needs + - conditions + - actions + - needs title: TacticalReportCreate type: object TagCreate: @@ -5674,35 +5675,35 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" source: nullable: true title: Source type: string tag_type: - $ref: '#/components/schemas/TagTypeCreate' + $ref: "#/components/schemas/TagTypeCreate" uri: nullable: true title: Uri type: string required: - - tag_type - - project + - tag_type + - project title: TagCreate type: object TagPagination: properties: items: items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: TagPagination type: object TagRead: @@ -5729,20 +5730,20 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" source: nullable: true title: Source type: string tag_type: - $ref: '#/components/schemas/TagTypeRead' + $ref: "#/components/schemas/TagTypeRead" uri: nullable: true title: Uri type: string required: - - id - - project + - id + - project title: TagRead type: object TagTypeCreate: @@ -5761,25 +5762,25 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - name - - project + - name + - project title: TagTypeCreate type: object TagTypePagination: properties: items: items: - $ref: '#/components/schemas/TagTypeRead' + $ref: "#/components/schemas/TagTypeRead" title: Items type: array total: title: Total type: integer required: - - items - - total + - items + - total title: TagTypePagination type: object TagTypeRead: @@ -5803,11 +5804,11 @@ components: title: Name type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - name - - id - - project + - name + - id + - project title: TagTypeRead type: object TagTypeUpdate: @@ -5831,7 +5832,7 @@ components: title: Name type: string required: - - name + - name title: TagTypeUpdate type: object TagUpdate: @@ -5862,7 +5863,7 @@ components: title: Source type: string tag_type: - $ref: '#/components/schemas/TagTypeUpdate' + $ref: "#/components/schemas/TagTypeUpdate" uri: nullable: true title: Uri @@ -5874,7 +5875,7 @@ components: assignees: default: [] items: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" title: Assignees type: array created_at: @@ -5882,15 +5883,15 @@ components: title: Created At type: string creator: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" description: nullable: true title: Description type: string incident: - $ref: '#/components/schemas/IncidentReadMinimal' + $ref: "#/components/schemas/IncidentReadMinimal" owner: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" priority: nullable: true title: Priority @@ -5916,7 +5917,7 @@ components: type: string status: allOf: - - $ref: '#/components/schemas/TaskStatus' + - $ref: "#/components/schemas/TaskStatus" default: Open updated_at: format: date-time @@ -5927,14 +5928,14 @@ components: title: Weblink type: string required: - - incident + - incident title: TaskCreate type: object TaskStatus: description: An enumeration. enum: - - Open - - Resolved + - Open + - Resolved title: TaskStatus type: string TaskUpdate: @@ -5942,7 +5943,7 @@ components: assignees: default: [] items: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" title: Assignees type: array created_at: @@ -5950,15 +5951,15 @@ components: title: Created At type: string creator: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" description: nullable: true title: Description type: string incident: - $ref: '#/components/schemas/IncidentReadMinimal' + $ref: "#/components/schemas/IncidentReadMinimal" owner: - $ref: '#/components/schemas/ParticipantUpdate' + $ref: "#/components/schemas/ParticipantUpdate" priority: nullable: true title: Priority @@ -5985,7 +5986,7 @@ components: type: string status: allOf: - - $ref: '#/components/schemas/TaskStatus' + - $ref: "#/components/schemas/TaskStatus" default: Open updated_at: format: date-time @@ -5996,7 +5997,7 @@ components: title: Weblink type: string required: - - incident + - incident title: TaskUpdate type: object TeamContactCreate: @@ -6033,7 +6034,7 @@ components: filters: default: [] items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array is_active: @@ -6058,11 +6059,11 @@ components: title: Owner type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" required: - - email - - name - - project + - email + - name + - project title: TeamContactCreate type: object TeamContactRead: @@ -6103,7 +6104,7 @@ components: filters: default: [] items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array id: @@ -6137,11 +6138,11 @@ components: title: Updated At type: string required: - - email - - name - - id - - created_at - - updated_at + - email + - name + - id + - created_at + - updated_at title: TeamContactRead type: object TeamContactUpdate: @@ -6178,7 +6179,7 @@ components: filters: default: [] items: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" title: Filters type: array is_active: @@ -6203,8 +6204,8 @@ components: title: Owner type: string required: - - email - - name + - email + - name title: TeamContactUpdate type: object TeamPagination: @@ -6212,14 +6213,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/TeamContactRead' + $ref: "#/components/schemas/TeamContactRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: TeamPagination type: object TermCreate: @@ -6227,7 +6228,7 @@ components: definitions: default: [] items: - $ref: '#/components/schemas/DefinitionRead' + $ref: "#/components/schemas/DefinitionRead" title: Definitions type: array discoverable: @@ -6240,13 +6241,13 @@ components: title: Id type: integer project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" text: nullable: true title: Text type: string required: - - project + - project title: TermCreate type: object TermPagination: @@ -6254,14 +6255,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/TermRead' + $ref: "#/components/schemas/TermRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: TermPagination type: object TermRead: @@ -6269,7 +6270,7 @@ components: definitions: default: [] items: - $ref: '#/components/schemas/DefinitionRead' + $ref: "#/components/schemas/DefinitionRead" title: Definitions type: array discoverable: @@ -6286,7 +6287,7 @@ components: title: Text type: string required: - - id + - id title: TermRead type: object TermUpdate: @@ -6294,7 +6295,7 @@ components: definitions: default: [] items: - $ref: '#/components/schemas/DefinitionRead' + $ref: "#/components/schemas/DefinitionRead" title: Definitions type: array discoverable: @@ -6341,7 +6342,7 @@ components: organizations: default: [] items: - $ref: '#/components/schemas/UserOrganization' + $ref: "#/components/schemas/UserOrganization" title: Organizations type: array password: @@ -6350,19 +6351,19 @@ components: projects: default: [] items: - $ref: '#/components/schemas/UserProject' + $ref: "#/components/schemas/UserProject" title: Projects type: array required: - - email - - password + - email + - password title: UserLogin type: object UserLoginResponse: properties: projects: items: - $ref: '#/components/schemas/UserProject' + $ref: "#/components/schemas/UserProject" title: Projects type: array token: @@ -6378,13 +6379,13 @@ components: title: Default type: boolean organization: - $ref: '#/components/schemas/OrganizationRead' + $ref: "#/components/schemas/OrganizationRead" role: nullable: true title: Role type: string required: - - organization + - organization title: UserOrganization type: object UserPagination: @@ -6392,14 +6393,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/UserRead' + $ref: "#/components/schemas/UserRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: UserPagination type: object UserProject: @@ -6409,13 +6410,13 @@ components: title: Default type: boolean project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" role: nullable: true title: Role type: string required: - - project + - project title: UserProject type: object UserRead: @@ -6432,13 +6433,13 @@ components: organizations: default: [] items: - $ref: '#/components/schemas/UserOrganization' + $ref: "#/components/schemas/UserOrganization" title: Organizations type: array projects: default: [] items: - $ref: '#/components/schemas/UserProject' + $ref: "#/components/schemas/UserProject" title: Projects type: array role: @@ -6446,8 +6447,8 @@ components: title: Role type: string required: - - email - - id + - email + - id title: UserRead type: object UserRegister: @@ -6459,7 +6460,7 @@ components: organizations: default: [] items: - $ref: '#/components/schemas/UserOrganization' + $ref: "#/components/schemas/UserOrganization" title: Organizations type: array password: @@ -6469,11 +6470,11 @@ components: projects: default: [] items: - $ref: '#/components/schemas/UserProject' + $ref: "#/components/schemas/UserProject" title: Projects type: array required: - - email + - email title: UserRegister type: object UserRegisterResponse: @@ -6493,7 +6494,7 @@ components: type: integer organizations: items: - $ref: '#/components/schemas/UserOrganization' + $ref: "#/components/schemas/UserOrganization" title: Organizations type: array password: @@ -6502,7 +6503,7 @@ components: type: string projects: items: - $ref: '#/components/schemas/UserProject' + $ref: "#/components/schemas/UserProject" title: Projects type: array role: @@ -6510,7 +6511,7 @@ components: title: Role type: string required: - - id + - id title: UserUpdate type: object ValidationError: @@ -6518,8 +6519,8 @@ components: loc: items: anyOf: - - type: string - - type: integer + - type: string + - type: integer title: Location type: array msg: @@ -6529,16 +6530,16 @@ components: title: Error Type type: string required: - - loc - - msg - - type + - loc + - msg + - type title: ValidationError type: object Visibility: description: An enumeration. enum: - - Open - - Restricted + - Open + - Restricted title: Visibility type: string WorkflowCase: @@ -6554,7 +6555,7 @@ components: title: Name type: string required: - - id + - id title: WorkflowCase type: object WorkflowCreate: @@ -6582,9 +6583,9 @@ components: title: Parameters type: array plugin_instance: - $ref: '#/components/schemas/PluginInstanceRead' + $ref: "#/components/schemas/PluginInstanceRead" project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" resource_id: title: Resource Id type: string @@ -6593,10 +6594,10 @@ components: title: Updated At type: string required: - - name - - resource_id - - plugin_instance - - project + - name + - resource_id + - plugin_instance + - project title: WorkflowCreate type: object WorkflowIncident: @@ -6612,7 +6613,7 @@ components: title: Name type: string required: - - id + - id title: WorkflowIncident type: object WorkflowInstanceCreate: @@ -6620,19 +6621,19 @@ components: artifacts: default: [] items: - $ref: '#/components/schemas/DocumentCreate' + $ref: "#/components/schemas/DocumentCreate" title: Artifacts type: array case: - $ref: '#/components/schemas/WorkflowCase' + $ref: "#/components/schemas/WorkflowCase" created_at: format: date-time title: Created At type: string creator: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" incident: - $ref: '#/components/schemas/WorkflowIncident' + $ref: "#/components/schemas/WorkflowIncident" parameters: default: [] items: @@ -6652,9 +6653,9 @@ components: title: Run Reason type: string signal: - $ref: '#/components/schemas/WorkflowSignal' + $ref: "#/components/schemas/WorkflowSignal" status: - $ref: '#/components/schemas/WorkflowInstanceStatus' + $ref: "#/components/schemas/WorkflowInstanceStatus" updated_at: format: date-time title: Updated At @@ -6670,24 +6671,24 @@ components: artifacts: default: [] items: - $ref: '#/components/schemas/DocumentCreate' + $ref: "#/components/schemas/DocumentCreate" title: Artifacts type: array case: - $ref: '#/components/schemas/WorkflowCase' + $ref: "#/components/schemas/WorkflowCase" created_at: format: date-time title: Created At type: string creator: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" id: exclusiveMaximum: 2147483647.0 exclusiveMinimum: 0.0 title: Id type: integer incident: - $ref: '#/components/schemas/WorkflowIncident' + $ref: "#/components/schemas/WorkflowIncident" parameters: default: [] items: @@ -6707,9 +6708,9 @@ components: title: Run Reason type: string signal: - $ref: '#/components/schemas/WorkflowSignal' + $ref: "#/components/schemas/WorkflowSignal" status: - $ref: '#/components/schemas/WorkflowInstanceStatus' + $ref: "#/components/schemas/WorkflowInstanceStatus" updated_at: format: date-time title: Updated At @@ -6719,20 +6720,20 @@ components: title: Weblink type: string workflow: - $ref: '#/components/schemas/WorkflowRead' + $ref: "#/components/schemas/WorkflowRead" required: - - id - - workflow + - id + - workflow title: WorkflowInstanceRead type: object WorkflowInstanceStatus: description: An enumeration. enum: - - Submitted - - Created - - Running - - Completed - - Failed + - Submitted + - Created + - Running + - Completed + - Failed title: WorkflowInstanceStatus type: string WorkflowPagination: @@ -6740,14 +6741,14 @@ components: items: default: [] items: - $ref: '#/components/schemas/WorkflowRead' + $ref: "#/components/schemas/WorkflowRead" title: Items type: array total: title: Total type: integer required: - - total + - total title: WorkflowPagination type: object WorkflowRead: @@ -6780,7 +6781,7 @@ components: title: Parameters type: array plugin_instance: - $ref: '#/components/schemas/PluginInstanceRead' + $ref: "#/components/schemas/PluginInstanceRead" resource_id: title: Resource Id type: string @@ -6789,10 +6790,10 @@ components: title: Updated At type: string required: - - name - - resource_id - - plugin_instance - - id + - name + - resource_id + - plugin_instance + - id title: WorkflowRead type: object WorkflowSignal: @@ -6808,7 +6809,7 @@ components: title: Name type: string required: - - id + - id title: WorkflowSignal type: object WorkflowUpdate: @@ -6841,7 +6842,7 @@ components: title: Parameters type: array plugin_instance: - $ref: '#/components/schemas/PluginInstanceRead' + $ref: "#/components/schemas/PluginInstanceRead" resource_id: title: Resource Id type: string @@ -6850,21 +6851,21 @@ components: title: Updated At type: string required: - - name - - resource_id - - plugin_instance + - name + - resource_id + - plugin_instance title: WorkflowUpdate type: object dispatch__case__models__CaseRead: properties: assignee: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" case_priority: - $ref: '#/components/schemas/CasePriorityRead' + $ref: "#/components/schemas/CasePriorityRead" case_severity: - $ref: '#/components/schemas/CaseSeverityRead' + $ref: "#/components/schemas/CaseSeverityRead" case_type: - $ref: '#/components/schemas/CaseTypeRead' + $ref: "#/components/schemas/CaseTypeRead" closed_at: format: date-time title: Closed At @@ -6879,13 +6880,13 @@ components: documents: default: [] items: - $ref: '#/components/schemas/DocumentRead' + $ref: "#/components/schemas/DocumentRead" title: Documents type: array duplicates: default: [] items: - $ref: '#/components/schemas/CaseReadMinimal' + $ref: "#/components/schemas/CaseReadMinimal" title: Duplicates type: array escalated_at: @@ -6895,13 +6896,13 @@ components: events: default: [] items: - $ref: '#/components/schemas/EventRead' + $ref: "#/components/schemas/EventRead" title: Events type: array groups: default: [] items: - $ref: '#/components/schemas/GroupRead' + $ref: "#/components/schemas/GroupRead" title: Groups type: array id: @@ -6912,7 +6913,7 @@ components: incidents: default: [] items: - $ref: '#/components/schemas/IncidentReadMinimal' + $ref: "#/components/schemas/IncidentReadMinimal" title: Incidents type: array name: @@ -6923,15 +6924,15 @@ components: participants: default: [] items: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" title: Participants type: array project: - $ref: '#/components/schemas/dispatch__case__models__ProjectRead' + $ref: "#/components/schemas/dispatch__case__models__ProjectRead" related: default: [] items: - $ref: '#/components/schemas/CaseReadMinimal' + $ref: "#/components/schemas/CaseReadMinimal" title: Related type: array reported_at: @@ -6942,25 +6943,25 @@ components: title: Resolution type: string resolution_reason: - $ref: '#/components/schemas/CaseResolutionReason' + $ref: "#/components/schemas/CaseResolutionReason" signal_instances: default: [] items: - $ref: '#/components/schemas/dispatch__case__models__SignalInstanceRead' + $ref: "#/components/schemas/dispatch__case__models__SignalInstanceRead" title: Signal Instances type: array status: - $ref: '#/components/schemas/CaseStatus' + $ref: "#/components/schemas/CaseStatus" storage: - $ref: '#/components/schemas/StorageRead' + $ref: "#/components/schemas/StorageRead" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array ticket: - $ref: '#/components/schemas/TicketRead' + $ref: "#/components/schemas/TicketRead" title: title: Title type: string @@ -6969,20 +6970,20 @@ components: title: Triage At type: string visibility: - $ref: '#/components/schemas/Visibility' + $ref: "#/components/schemas/Visibility" workflow_instances: default: [] items: - $ref: '#/components/schemas/WorkflowInstanceRead' + $ref: "#/components/schemas/WorkflowInstanceRead" title: Workflow Instances type: array required: - - title - - id - - case_priority - - case_severity - - case_type - - project + - title + - id + - case_priority + - case_severity + - case_type + - project title: CaseRead type: object dispatch__case__models__ProjectRead: @@ -7001,7 +7002,7 @@ components: title: Name type: string required: - - name + - name title: ProjectRead type: object dispatch__case__models__SignalInstanceRead: @@ -7013,7 +7014,7 @@ components: entities: default: [] items: - $ref: '#/components/schemas/EntityRead' + $ref: "#/components/schemas/EntityRead" title: Entities type: array fingerprint: @@ -7022,16 +7023,16 @@ components: raw: title: Raw signal: - $ref: '#/components/schemas/dispatch__case__models__SignalRead' + $ref: "#/components/schemas/dispatch__case__models__SignalRead" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array required: - - signal - - created_at + - signal + - created_at title: SignalInstanceRead type: object dispatch__case__models__SignalRead: @@ -7062,14 +7063,14 @@ components: workflow_instances: default: [] items: - $ref: '#/components/schemas/WorkflowInstanceRead' + $ref: "#/components/schemas/WorkflowInstanceRead" title: Workflow Instances type: array required: - - id - - name - - owner - - external_id + - id + - name + - owner + - external_id title: SignalRead type: object dispatch__case__type__models__Document: @@ -7100,9 +7101,9 @@ components: title: Weblink type: string required: - - id - - name - - weblink + - id + - name + - weblink title: Document type: object dispatch__case__type__models__Service: @@ -7132,9 +7133,9 @@ components: title: Type type: string required: - - id - - external_id - - name + - id + - external_id + - name title: Service type: object dispatch__incident__models__CaseRead: @@ -7150,7 +7151,7 @@ components: title: Name type: string required: - - id + - id title: CaseRead type: object dispatch__incident__models__ProjectRead: @@ -7169,7 +7170,7 @@ components: title: Name type: string required: - - name + - name title: ProjectRead type: object dispatch__incident__models__TaskRead: @@ -7177,7 +7178,7 @@ components: assignees: default: [] items: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" title: Assignees type: array created_at: @@ -7195,13 +7196,13 @@ components: type: integer status: allOf: - - $ref: '#/components/schemas/TaskStatus' + - $ref: "#/components/schemas/TaskStatus" default: Open weblink: title: Weblink type: string required: - - id + - id title: TaskRead type: object dispatch__incident__type__models__Document: @@ -7232,9 +7233,9 @@ components: title: Weblink type: string required: - - id - - name - - weblink + - id + - name + - weblink title: Document type: object dispatch__project__models__ProjectRead: @@ -7277,7 +7278,7 @@ components: title: Owner Email type: string required: - - name + - name title: ProjectRead type: object dispatch__signal__models__Service: @@ -7307,15 +7308,15 @@ components: title: Type type: string required: - - id - - external_id - - name + - id + - external_id + - name title: Service type: object dispatch__signal__models__SignalInstanceRead: properties: case: - $ref: '#/components/schemas/dispatch__case__models__CaseRead' + $ref: "#/components/schemas/dispatch__case__models__CaseRead" created_at: format: date-time title: Created At @@ -7323,11 +7324,11 @@ components: entities: default: [] items: - $ref: '#/components/schemas/EntityRead' + $ref: "#/components/schemas/EntityRead" title: Entities type: array filter_action: - $ref: '#/components/schemas/SignalFilterAction' + $ref: "#/components/schemas/SignalFilterAction" fingerprint: title: Fingerprint type: string @@ -7336,25 +7337,25 @@ components: title: Id type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" raw: title: Raw type: object signal: - $ref: '#/components/schemas/dispatch__signal__models__SignalRead' + $ref: "#/components/schemas/dispatch__signal__models__SignalRead" required: - - project - - raw - - id - - signal + - project + - raw + - id + - signal title: SignalInstanceRead type: object dispatch__signal__models__SignalRead: properties: case_priority: - $ref: '#/components/schemas/CasePriorityRead' + $ref: "#/components/schemas/CasePriorityRead" case_type: - $ref: '#/components/schemas/CaseTypeRead' + $ref: "#/components/schemas/CaseTypeRead" conversation_target: title: Conversation Target type: string @@ -7376,7 +7377,7 @@ components: entity_types: default: [] items: - $ref: '#/components/schemas/EntityTypeRead' + $ref: "#/components/schemas/EntityTypeRead" title: Entity Types type: array external_id: @@ -7388,7 +7389,7 @@ components: filters: default: [] items: - $ref: '#/components/schemas/SignalFilterRead' + $ref: "#/components/schemas/SignalFilterRead" title: Filters type: array id: @@ -7400,18 +7401,18 @@ components: title: Name type: string oncall_service: - $ref: '#/components/schemas/dispatch__signal__models__Service' + $ref: "#/components/schemas/dispatch__signal__models__Service" owner: title: Owner type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" source: - $ref: '#/components/schemas/SourceBase' + $ref: "#/components/schemas/SourceBase" tags: default: [] items: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" title: Tags type: array variant: @@ -7420,15 +7421,15 @@ components: workflows: default: [] items: - $ref: '#/components/schemas/WorkflowRead' + $ref: "#/components/schemas/WorkflowRead" title: Workflows type: array required: - - name - - owner - - external_id - - project - - id + - name + - owner + - external_id + - project + - id title: SignalRead type: object dispatch__task__models__TaskRead: @@ -7436,7 +7437,7 @@ components: assignees: default: [] items: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" title: Assignees type: array created_at: @@ -7444,7 +7445,7 @@ components: title: Created At type: string creator: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" description: nullable: true title: Description @@ -7455,15 +7456,15 @@ components: title: Id type: integer incident: - $ref: '#/components/schemas/IncidentReadMinimal' + $ref: "#/components/schemas/IncidentReadMinimal" owner: - $ref: '#/components/schemas/ParticipantRead' + $ref: "#/components/schemas/ParticipantRead" priority: nullable: true title: Priority type: string project: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" resolve_by: format: date-time title: Resolve By @@ -7486,7 +7487,7 @@ components: type: string status: allOf: - - $ref: '#/components/schemas/TaskStatus' + - $ref: "#/components/schemas/TaskStatus" default: Open updated_at: format: date-time @@ -7497,8 +7498,8 @@ components: title: Weblink type: string required: - - incident - - id + - incident + - id title: TaskRead type: object info: @@ -7513,104 +7514,104 @@ paths: description: Get all organizations. operationId: get_organizations_organizations_get parameters: - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OrganizationPagination' + $ref: "#/components/schemas/OrganizationPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Organizations tags: - - organizations + - organizations post: description: Create a new organization. operationId: create_organization_organizations_post @@ -7618,15622 +7619,15622 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OrganizationCreate' + $ref: "#/components/schemas/OrganizationCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OrganizationRead' + $ref: "#/components/schemas/OrganizationRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Organization tags: - - organizations + - organizations /organizations/{organization_id}: get: description: Get an organization. operationId: get_organization_organizations__organization_id__get parameters: - - in: path - name: organization_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Organization Id - type: integer + - in: path + name: organization_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Organization Id + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OrganizationRead' + $ref: "#/components/schemas/OrganizationRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Organization tags: - - organizations + - organizations put: description: Update an organization. operationId: update_organization_organizations__organization_id__put parameters: - - in: path - name: organization_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Organization Id - type: integer + - in: path + name: organization_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Organization Id + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/OrganizationUpdate' + $ref: "#/components/schemas/OrganizationUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OrganizationRead' + $ref: "#/components/schemas/OrganizationRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Organization tags: - - organizations + - organizations /{organization}/auth/login: post: operationId: login_user__organization__auth_login_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UserLogin' + $ref: "#/components/schemas/UserLogin" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserLoginResponse' + $ref: "#/components/schemas/UserLoginResponse" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Login User tags: - - auth + - auth /{organization}/auth/me: get: operationId: get_me__organization__auth_me_get responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserRead' + $ref: "#/components/schemas/UserRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Me tags: - - auth + - auth /{organization}/auth/register: post: operationId: register_user__organization__auth_register_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UserRegister' + $ref: "#/components/schemas/UserRegister" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserRegisterResponse' + $ref: "#/components/schemas/UserRegisterResponse" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Register User tags: - - auth + - auth /{organization}/case_priorities: get: description: Returns all case priorities. operationId: get_case_priorities__organization__case_priorities_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CasePriorityPagination' + $ref: "#/components/schemas/CasePriorityPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Case Priorities tags: - - case_priorities - - case_priorities + - case_priorities + - case_priorities post: description: Creates a new case priority. operationId: create_case_priority__organization__case_priorities_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CasePriorityCreate' + $ref: "#/components/schemas/CasePriorityCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CasePriorityRead' + $ref: "#/components/schemas/CasePriorityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Case Priority tags: - - case_priorities + - case_priorities /{organization}/case_priorities/{case_priority_id}: get: description: Gets a case priority. operationId: get_case_priority__organization__case_priorities__case_priority_id__get parameters: - - in: path - name: case_priority_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Case Priority Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: case_priority_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Case Priority Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CasePriorityRead' + $ref: "#/components/schemas/CasePriorityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Case Priority tags: - - case_priorities + - case_priorities put: description: Updates an existing case priority. operationId: update_case_priority__organization__case_priorities__case_priority_id__put parameters: - - in: path - name: case_priority_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Case Priority Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: case_priority_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Case Priority Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CasePriorityUpdate' + $ref: "#/components/schemas/CasePriorityUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CasePriorityRead' + $ref: "#/components/schemas/CasePriorityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Case Priority tags: - - case_priorities + - case_priorities /{organization}/case_severities: get: description: Returns all case severities. operationId: get_case_severities__organization__case_severities_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseSeverityPagination' + $ref: "#/components/schemas/CaseSeverityPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Case Severities tags: - - case_severities - - case_severities + - case_severities + - case_severities post: description: Creates a new case severity. operationId: create_case_severity__organization__case_severities_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseSeverityCreate' + $ref: "#/components/schemas/CaseSeverityCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseSeverityRead' + $ref: "#/components/schemas/CaseSeverityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Case Severity tags: - - case_severities + - case_severities /{organization}/case_severities/{case_severity_id}: get: description: Gets a case severity. operationId: get_case_severity__organization__case_severities__case_severity_id__get parameters: - - in: path - name: case_severity_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Case Severity Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: case_severity_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Case Severity Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseSeverityRead' + $ref: "#/components/schemas/CaseSeverityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Case Severity tags: - - case_severities + - case_severities put: description: Updates an existing case severity. operationId: update_case_severity__organization__case_severities__case_severity_id__put parameters: - - in: path - name: case_severity_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Case Severity Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: case_severity_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Case Severity Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseSeverityUpdate' + $ref: "#/components/schemas/CaseSeverityUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseSeverityRead' + $ref: "#/components/schemas/CaseSeverityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Case Severity tags: - - case_severities + - case_severities /{organization}/case_types: get: description: Returns all case types. operationId: get_case_types__organization__case_types_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseTypePagination' + $ref: "#/components/schemas/CaseTypePagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Case Types tags: - - case_types - - case_types + - case_types + - case_types post: description: Creates a new case type. operationId: create_case_type__organization__case_types_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseTypeCreate' + $ref: "#/components/schemas/CaseTypeCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseTypeRead' + $ref: "#/components/schemas/CaseTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Case Type tags: - - case_types + - case_types /{organization}/case_types/{case_type_id}: get: description: Gets a case type. operationId: get_case_type__organization__case_types__case_type_id__get parameters: - - in: path - name: case_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Case Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: case_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Case Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseTypeRead' + $ref: "#/components/schemas/CaseTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Case Type tags: - - case_types + - case_types put: description: Updates an existing case type. operationId: update_case_type__organization__case_types__case_type_id__put parameters: - - in: path - name: case_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Case Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: case_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Case Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseTypeUpdate' + $ref: "#/components/schemas/CaseTypeUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseTypeRead' + $ref: "#/components/schemas/CaseTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Case Type tags: - - case_types + - case_types /{organization}/cases: get: description: Retrieves all cases. operationId: get_cases__organization__cases_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: include[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Include[] - type: array - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: query + name: include[] + required: false + schema: + default: [] + items: + type: string + title: Include[] + type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Retrieves a list of cases. tags: - - cases + - cases post: description: Creates a new case. operationId: create_case__organization__cases_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseCreate' + $ref: "#/components/schemas/CaseCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__case__models__CaseRead' + $ref: "#/components/schemas/dispatch__case__models__CaseRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Creates a new case. tags: - - cases + - cases /{organization}/cases/{case_id}: delete: description: Deletes an existing case and its external resources. operationId: delete_case__organization__cases__case_id__delete parameters: - - in: path - name: case_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Case Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: case_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Case Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Deletes an existing case and its external resources. tags: - - cases + - cases get: description: Retrieves the details of a single case. operationId: get_case__organization__cases__case_id__get parameters: - - in: path - name: case_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Case Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: case_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Case Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__case__models__CaseRead' + $ref: "#/components/schemas/dispatch__case__models__CaseRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Retrieves a single case. tags: - - cases + - cases put: description: Updates an existing case. operationId: update_case__organization__cases__case_id__put parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: path - name: case_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Case Id - type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string + - in: path + name: case_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Case Id + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseUpdate' + $ref: "#/components/schemas/CaseUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__case__models__CaseRead' + $ref: "#/components/schemas/dispatch__case__models__CaseRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Updates an existing case. tags: - - cases + - cases /{organization}/cases/{case_id}/escalate: put: description: Escalates an existing case. operationId: escalate_case__organization__cases__case_id__escalate_put parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentCreate' + $ref: "#/components/schemas/IncidentCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentRead' + $ref: "#/components/schemas/IncidentRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Escalates an existing case. tags: - - cases + - cases /{organization}/data/alerts: post: description: Creates a new alert. operationId: create_alert__organization__data_alerts_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/AlertCreate' + $ref: "#/components/schemas/AlertCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AlertRead' + $ref: "#/components/schemas/AlertRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Alert tags: - - alerts + - alerts /{organization}/data/alerts/{alert_id}: delete: description: Deletes an alert, returning only an HTTP 200 OK if successful. operationId: delete_alert__organization__data_alerts__alert_id__delete parameters: - - in: path - name: alert_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Alert Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: alert_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Alert Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Alert tags: - - alerts + - alerts get: description: Given its unique id, retrieve details about a single alert. operationId: get_alert__organization__data_alerts__alert_id__get parameters: - - in: path - name: alert_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Alert Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: alert_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Alert Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AlertRead' + $ref: "#/components/schemas/AlertRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Alert tags: - - alerts + - alerts put: description: Updates an alert. operationId: update_alert__organization__data_alerts__alert_id__put parameters: - - in: path - name: alert_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Alert Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: alert_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Alert Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/AlertUpdate' + $ref: "#/components/schemas/AlertUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AlertRead' + $ref: "#/components/schemas/AlertRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Alert tags: - - alerts + - alerts /{organization}/data/queries: get: description: Get all queries, or only those matching a given search term. operationId: get_queries__organization__data_queries_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryPagination' + $ref: "#/components/schemas/QueryPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Queries tags: - - queries + - queries post: description: Creates a new data query. operationId: create_query__organization__data_queries_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryCreate' + $ref: "#/components/schemas/QueryCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryRead' + $ref: "#/components/schemas/QueryRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Query tags: - - queries + - queries /{organization}/data/queries/{query_id}: delete: description: Deletes a data query, returning only an HTTP 200 OK if successful. operationId: delete_query__organization__data_queries__query_id__delete parameters: - - in: path - name: query_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Query Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: query_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Query Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Query tags: - - queries + - queries get: description: Given its unique ID, retrieve details about a single query. operationId: get_query__organization__data_queries__query_id__get parameters: - - in: path - name: query_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Query Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: query_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Query Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryRead' + $ref: "#/components/schemas/QueryRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Query tags: - - queries + - queries put: description: Updates a data query. operationId: update_query__organization__data_queries__query_id__put parameters: - - in: path - name: query_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Query Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: query_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Query Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryUpdate' + $ref: "#/components/schemas/QueryUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryRead' + $ref: "#/components/schemas/QueryRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Query tags: - - queries + - queries /{organization}/data/sources: get: description: Get all sources, or only those matching a given search term. operationId: get_sources__organization__data_sources_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourcePagination' + $ref: "#/components/schemas/SourcePagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Sources tags: - - sources + - sources post: description: Creates a new source. operationId: create_source__organization__data_sources_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceCreate' + $ref: "#/components/schemas/SourceCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceRead' + $ref: "#/components/schemas/SourceRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Source tags: - - sources + - sources /{organization}/data/sources/dataFormats: get: description: Get all source data formats, or only those matching a given search term. operationId: get_source_data_formats__organization__data_sources_dataFormats_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceDataFormatPagination' + $ref: "#/components/schemas/SourceDataFormatPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Source Data Formats tags: - - source_data_formats + - source_data_formats post: description: Creates a new source data format. operationId: create_source_data_format__organization__data_sources_dataFormats_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceDataFormatCreate' + $ref: "#/components/schemas/SourceDataFormatCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceDataFormatRead' + $ref: "#/components/schemas/SourceDataFormatRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Source Data Format tags: - - source_data_formats + - source_data_formats /{organization}/data/sources/dataFormats/{source_data_format_id}: delete: description: Delete a source data format, returning only an HTTP 200 OK if successful. operationId: delete_source_data_format__organization__data_sources_dataFormats__source_data_format_id__delete parameters: - - in: path - name: source_data_format_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Data Format Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_data_format_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Data Format Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Source Data Format tags: - - source_data_formats + - source_data_formats get: description: Given its unique id, retrieve details about a source data format. operationId: get_source_data_format__organization__data_sources_dataFormats__source_data_format_id__get parameters: - - in: path - name: source_data_format_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Data Format Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_data_format_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Data Format Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceDataFormatRead' + $ref: "#/components/schemas/SourceDataFormatRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Source Data Format tags: - - source_data_formats + - source_data_formats put: description: Updates a source data format. operationId: update_source_data_format__organization__data_sources_dataFormats__source_data_format_id__put parameters: - - in: path - name: source_data_format_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Data Format Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_data_format_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Data Format Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceDataFormatUpdate' + $ref: "#/components/schemas/SourceDataFormatUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceDataFormatRead' + $ref: "#/components/schemas/SourceDataFormatRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Source Data Format tags: - - source_data_formats + - source_data_formats /{organization}/data/sources/environments: get: description: Get all source_environment environments, or only those matching a given search term. operationId: get_source_environments__organization__data_sources_environments_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceEnvironmentPagination' + $ref: "#/components/schemas/SourceEnvironmentPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Source Environments tags: - - source_environments + - source_environments post: description: Creates a new source environment. operationId: create_source_environment__organization__data_sources_environments_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceEnvironmentCreate' + $ref: "#/components/schemas/SourceEnvironmentCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceEnvironmentRead' + $ref: "#/components/schemas/SourceEnvironmentRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Source Environment tags: - - source_environments + - source_environments /{organization}/data/sources/environments/{source_environment_id}: delete: description: Delete a source environment, returning only an HTTP 200 OK if successful. operationId: delete_source_environment__organization__data_sources_environments__source_environment_id__delete parameters: - - in: path - name: source_environment_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Environment Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_environment_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Environment Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Source Environment tags: - - source_environments + - source_environments get: description: Given its unique id, retrieve details about a single source_environment environment. operationId: get_source_environment__organization__data_sources_environments__source_environment_id__get parameters: - - in: path - name: source_environment_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Environment Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_environment_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Environment Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceEnvironmentRead' + $ref: "#/components/schemas/SourceEnvironmentRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Source Environment tags: - - source_environments + - source_environments put: description: Updates a source environment. operationId: update_source_environment__organization__data_sources_environments__source_environment_id__put parameters: - - in: path - name: source_environment_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Environment Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_environment_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Environment Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceEnvironmentUpdate' + $ref: "#/components/schemas/SourceEnvironmentUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceEnvironmentRead' + $ref: "#/components/schemas/SourceEnvironmentRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Source Environment tags: - - source_environments + - source_environments /{organization}/data/sources/statuses: get: description: Get all source statuses, or only those matching a given search term. operationId: get_source_statuses__organization__data_sources_statuses_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceStatusPagination' + $ref: "#/components/schemas/SourceStatusPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Source Statuses tags: - - source_statuses + - source_statuses post: description: Creates a new source status. operationId: create_source_status__organization__data_sources_statuses_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceStatusCreate' + $ref: "#/components/schemas/SourceStatusCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceStatusRead' + $ref: "#/components/schemas/SourceStatusRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Source Status tags: - - source_statuses + - source_statuses /{organization}/data/sources/statuses/{source_status_id}: delete: description: Deletes a source status, returning only an HTTP 200 OK if successful. operationId: delete_source_status__organization__data_sources_statuses__source_status_id__delete parameters: - - in: path - name: source_status_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Status Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_status_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Status Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Source Status tags: - - source_statuses + - source_statuses get: description: Given its unique id, retrieve details about a single source status. operationId: get_source_status__organization__data_sources_statuses__source_status_id__get parameters: - - in: path - name: source_status_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Status Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_status_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Status Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceStatusRead' + $ref: "#/components/schemas/SourceStatusRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Source Status tags: - - source_statuses + - source_statuses put: description: Updates a source status. operationId: update_source_status__organization__data_sources_statuses__source_status_id__put parameters: - - in: path - name: source_status_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Status Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_status_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Status Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceStatusUpdate' + $ref: "#/components/schemas/SourceStatusUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceStatusRead' + $ref: "#/components/schemas/SourceStatusRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Source Status tags: - - source_statuses + - source_statuses /{organization}/data/sources/transports: get: description: Get all source transports, or only those matching a given search term. operationId: get_source_transports__organization__data_sources_transports_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceTransportPagination' + $ref: "#/components/schemas/SourceTransportPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Source Transports tags: - - source_transports + - source_transports post: description: Creates a new source transport. operationId: create_source_transport__organization__data_sources_transports_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceTransportCreate' + $ref: "#/components/schemas/SourceTransportCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceTransportRead' + $ref: "#/components/schemas/SourceTransportRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Source Transport tags: - - source_transports + - source_transports /{organization}/data/sources/transports/{source_transport_id}: delete: description: Deletes a source transport, returning only an HTTP 200 OK if successful. operationId: delete_source_transport__organization__data_sources_transports__source_transport_id__delete parameters: - - in: path - name: source_transport_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Transport Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_transport_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Transport Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Source Transport tags: - - source_transports + - source_transports get: description: Given its unique id, retrieve details about a single source transport. operationId: get_source_transport__organization__data_sources_transports__source_transport_id__get parameters: - - in: path - name: source_transport_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Transport Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_transport_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Transport Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceTransportRead' + $ref: "#/components/schemas/SourceTransportRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Source Transport tags: - - source_transports + - source_transports put: description: Updates a source transport. operationId: update_source_transport__organization__data_sources_transports__source_transport_id__put parameters: - - in: path - name: source_transport_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Transport Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_transport_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Transport Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceTransportUpdate' + $ref: "#/components/schemas/SourceTransportUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceTransportRead' + $ref: "#/components/schemas/SourceTransportRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Source Transport tags: - - source_transports + - source_transports /{organization}/data/sources/types: get: description: Get all source types, or only those matching a given search term. operationId: get_source_types__organization__data_sources_types_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceTypePagination' + $ref: "#/components/schemas/SourceTypePagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Source Types tags: - - source_types + - source_types post: description: Creates a new source type. operationId: create_source_type__organization__data_sources_types_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceTypeCreate' + $ref: "#/components/schemas/SourceTypeCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceTypeRead' + $ref: "#/components/schemas/SourceTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Source Type tags: - - source_types + - source_types /{organization}/data/sources/types/{source_type_id}: delete: description: Deletes a source type, returning only an HTTP 200 OK if successful. operationId: delete_source_type__organization__data_sources_types__source_type_id__delete parameters: - - in: path - name: source_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Source Type tags: - - source_types + - source_types get: description: Given its unique id, retrieve details about a single source type. operationId: get_source_type__organization__data_sources_types__source_type_id__get parameters: - - in: path - name: source_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceTypeRead' + $ref: "#/components/schemas/SourceTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Source Type tags: - - source_types + - source_types put: description: Updates a source type. operationId: update_source_type__organization__data_sources_types__source_type_id__put parameters: - - in: path - name: source_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceTypeUpdate' + $ref: "#/components/schemas/SourceTypeUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceTypeRead' + $ref: "#/components/schemas/SourceTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Source Type tags: - - source_types + - source_types /{organization}/data/sources/{source_id}: delete: description: Deletes a source, returning only an HTTP 200 OK if successful. operationId: delete_source__organization__data_sources__source_id__delete parameters: - - in: path - name: source_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Source tags: - - sources + - sources get: description: Given its unique id, retrieve details about a single source. operationId: get_source__organization__data_sources__source_id__get parameters: - - in: path - name: source_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceRead' + $ref: "#/components/schemas/SourceRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Source tags: - - sources + - sources put: description: Updates a source. operationId: update_source__organization__data_sources__source_id__put parameters: - - in: path - name: source_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Source Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: source_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Source Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SourceUpdate' + $ref: "#/components/schemas/SourceUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SourceRead' + $ref: "#/components/schemas/SourceRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Source tags: - - sources + - sources /{organization}/definitions: get: description: Get all definitions. operationId: get_definitions__organization__definitions_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DefinitionPagination' + $ref: "#/components/schemas/DefinitionPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Definitions tags: - - definitions + - definitions post: description: Create a new definition. operationId: create_definition__organization__definitions_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/DefinitionCreate' + $ref: "#/components/schemas/DefinitionCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DefinitionRead' + $ref: "#/components/schemas/DefinitionRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Definition tags: - - definitions + - definitions /{organization}/definitions/{definition_id}: delete: description: Delete a definition. operationId: delete_definition__organization__definitions__definition_id__delete parameters: - - in: path - name: definition_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Definition Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: definition_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Definition Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Definition tags: - - definitions + - definitions get: description: Update a definition. operationId: get_definition__organization__definitions__definition_id__get parameters: - - in: path - name: definition_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Definition Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: definition_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Definition Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DefinitionRead' + $ref: "#/components/schemas/DefinitionRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Definition tags: - - definitions + - definitions put: description: Update a definition. operationId: update_definition__organization__definitions__definition_id__put parameters: - - in: path - name: definition_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Definition Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: definition_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Definition Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/DefinitionUpdate' + $ref: "#/components/schemas/DefinitionUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DefinitionRead' + $ref: "#/components/schemas/DefinitionRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Definition tags: - - definitions + - definitions /{organization}/documents: get: description: Get all documents. operationId: get_documents__organization__documents_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DocumentPagination' + $ref: "#/components/schemas/DocumentPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Documents tags: - - documents + - documents post: description: Create a new document. operationId: create_document__organization__documents_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/DocumentCreate' + $ref: "#/components/schemas/DocumentCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DocumentRead' + $ref: "#/components/schemas/DocumentRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Document tags: - - documents + - documents /{organization}/documents/{document_id}: delete: description: Delete a document. operationId: delete_document__organization__documents__document_id__delete parameters: - - in: path - name: document_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Document Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: document_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Document Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Document tags: - - documents + - documents get: description: Update a document. operationId: get_document__organization__documents__document_id__get parameters: - - in: path - name: document_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Document Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: document_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Document Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DocumentRead' + $ref: "#/components/schemas/DocumentRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Document tags: - - documents + - documents put: description: Update a document. operationId: update_document__organization__documents__document_id__put parameters: - - in: path - name: document_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Document Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: document_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Document Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/DocumentUpdate' + $ref: "#/components/schemas/DocumentUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DocumentRead' + $ref: "#/components/schemas/DocumentRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Document tags: - - documents + - documents /{organization}/entity: get: description: Get all entities, or only those matching a given search term. operationId: get_entities__organization__entity_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EntityPagination' + $ref: "#/components/schemas/EntityPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Entities tags: - - entities + - entities post: description: Creates a new entity. operationId: create_entity__organization__entity_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/EntityCreate' + $ref: "#/components/schemas/EntityCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EntityRead' + $ref: "#/components/schemas/EntityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Entity tags: - - entities + - entities /{organization}/entity/{entity_id}: delete: description: Deletes a entity, returning only an HTTP 200 OK if successful. operationId: delete_entity__organization__entity__entity_id__delete parameters: - - in: path - name: entity_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Entity Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: entity_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Entity Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Entity tags: - - entities + - entities get: description: Given its unique id, retrieve details about a single entity. operationId: get_entity__organization__entity__entity_id__get parameters: - - in: path - name: entity_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Entity Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: entity_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Entity Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EntityRead' + $ref: "#/components/schemas/EntityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Entity tags: - - entities + - entities put: description: Updates an existing entity. operationId: update_entity__organization__entity__entity_id__put parameters: - - in: path - name: entity_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Entity Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: entity_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Entity Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/EntityUpdate' + $ref: "#/components/schemas/EntityUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EntityRead' + $ref: "#/components/schemas/EntityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Entity tags: - - entities + - entities /{organization}/entity/{entity_id}/cases/{days_back}: get: operationId: count_cases_with_entity__organization__entity__entity_id__cases__days_back__get parameters: - - in: path - name: days_back - required: true - schema: - title: Days Back - type: integer - - in: path - name: entity_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Entity Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: days_back + required: true + schema: + title: Days Back + type: integer + - in: path + name: entity_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Entity Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Count Cases With Entity tags: - - entities + - entities /{organization}/entity/{entity_id}/signal_instances/{days_back}: get: operationId: get_signal_instances_by_entity__organization__entity__entity_id__signal_instances__days_back__get parameters: - - in: path - name: days_back - required: true - schema: - title: Days Back - type: integer - - in: path - name: entity_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Entity Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: days_back + required: true + schema: + title: Days Back + type: integer + - in: path + name: entity_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Entity Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Signal Instances By Entity tags: - - entities + - entities /{organization}/entity_type: get: description: Get all entities, or only those matching a given search term. operationId: get_entity_types__organization__entity_type_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EntityTypePagination' + $ref: "#/components/schemas/EntityTypePagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Entity Types tags: - - entity_types + - entity_types post: description: Create a new entity. operationId: create_entity_type__organization__entity_type_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/EntityTypeCreate' + $ref: "#/components/schemas/EntityTypeCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EntityTypeRead' + $ref: "#/components/schemas/EntityTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Entity Type tags: - - entity_types + - entity_types /{organization}/entity_type/{entity_type_id}: delete: description: Delete an entity. operationId: delete_entity_type__organization__entity_type__entity_type_id__delete parameters: - - in: path - name: entity_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Entity Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: entity_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Entity Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Entity Type tags: - - entity_types + - entity_types get: description: Get a entity by its id. operationId: get_entity_type__organization__entity_type__entity_type_id__get parameters: - - in: path - name: entity_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Entity Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: entity_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Entity Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EntityTypeRead' + $ref: "#/components/schemas/EntityTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Entity Type tags: - - entity_types + - entity_types put: description: Update an entity. operationId: update_entity_type__organization__entity_type__entity_type_id__put parameters: - - in: path - name: entity_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Entity Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: entity_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Entity Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/EntityTypeUpdate' + $ref: "#/components/schemas/EntityTypeUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EntityTypeRead' + $ref: "#/components/schemas/EntityTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Entity Type tags: - - entity_types + - entity_types /{organization}/entity_type/{entity_type_id}/process: put: description: Process an entity type. operationId: process_entity_type__organization__entity_type__entity_type_id__process_put parameters: - - in: path - name: entity_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Entity Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: entity_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Entity Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/EntityTypeUpdate' + $ref: "#/components/schemas/EntityTypeUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EntityTypeRead' + $ref: "#/components/schemas/EntityTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Process Entity Type tags: - - entity_types + - entity_types /{organization}/events/slack/action: post: description: Handle all incoming Slack actions. operationId: slack_actions__organization__events_slack_action_post parameters: - - in: path - name: organization - required: true - schema: - title: Organization - type: string + - in: path + name: organization + required: true + schema: + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Slack Actions tags: - - events + - events /{organization}/events/slack/command: post: description: Handle all incoming Slack commands. operationId: slack_commands__organization__events_slack_command_post parameters: - - in: path - name: organization - required: true - schema: - title: Organization - type: string + - in: path + name: organization + required: true + schema: + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Slack Commands tags: - - events + - events /{organization}/events/slack/event: post: description: Handle all incoming Slack events. operationId: slack_events__organization__events_slack_event_post parameters: - - in: path - name: organization - required: true - schema: - title: Organization - type: string + - in: path + name: organization + required: true + schema: + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Slack Events tags: - - events + - events /{organization}/events/slack/menu: post: description: Handle all incoming Slack actions. operationId: slack_menus__organization__events_slack_menu_post parameters: - - in: path - name: organization - required: true - schema: - title: Organization - type: string + - in: path + name: organization + required: true + schema: + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Slack Menus tags: - - events + - events /{organization}/feedback: get: description: Get all feedback entries, or only those matching a given search term. operationId: get_feedback_entries__organization__feedback_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FeedbackPagination' + $ref: "#/components/schemas/FeedbackPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Feedback Entries tags: - - feedback + - feedback post: description: Create a new feedback entry. operationId: create_feedback__organization__feedback_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/FeedbackCreate' + $ref: "#/components/schemas/FeedbackCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FeedbackRead' + $ref: "#/components/schemas/FeedbackRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Feedback tags: - - feedback + - feedback /{organization}/feedback/{feedback_id}: delete: description: Delete a feedback entry, returning only an HTTP 200 OK if successful. operationId: delete_feedback__organization__feedback__feedback_id__delete parameters: - - in: path - name: feedback_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Feedback Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: feedback_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Feedback Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Feedback tags: - - feedback + - feedback get: description: Get a feedback entry by its id. operationId: get_feedback__organization__feedback__feedback_id__get parameters: - - in: path - name: feedback_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Feedback Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: feedback_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Feedback Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FeedbackRead' + $ref: "#/components/schemas/FeedbackRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Feedback tags: - - feedback + - feedback put: description: Updates a feedback entry by its id. operationId: update_feedback__organization__feedback__feedback_id__put parameters: - - in: path - name: feedback_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Feedback Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: feedback_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Feedback Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/FeedbackUpdate' + $ref: "#/components/schemas/FeedbackUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FeedbackRead' + $ref: "#/components/schemas/FeedbackRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Feedback tags: - - feedback + - feedback /{organization}/incident_cost_types: get: description: Get all incident cost types, or only those matching a given search term. operationId: get_incident_cost_types__organization__incident_cost_types_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentCostTypePagination' + $ref: "#/components/schemas/IncidentCostTypePagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Incident Cost Types tags: - - incident_cost_types + - incident_cost_types post: description: Create an incident cost type. operationId: create_incident_cost_type__organization__incident_cost_types_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentCostTypeCreate' + $ref: "#/components/schemas/IncidentCostTypeCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentCostTypeRead' + $ref: "#/components/schemas/IncidentCostTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Incident Cost Type tags: - - incident_cost_types + - incident_cost_types /{organization}/incident_cost_types/{incident_cost_type_id}: delete: description: Delete an incident cost type, returning only an HTTP 200 OK if successful. operationId: delete_incident_cost_type__organization__incident_cost_types__incident_cost_type_id__delete parameters: - - in: path - name: incident_cost_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Cost Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_cost_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Cost Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Incident Cost Type tags: - - incident_cost_types + - incident_cost_types get: description: Get an incident cost type by its id. operationId: get_incident_cost_type__organization__incident_cost_types__incident_cost_type_id__get parameters: - - in: path - name: incident_cost_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Cost Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_cost_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Cost Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentCostTypeRead' + $ref: "#/components/schemas/IncidentCostTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Incident Cost Type tags: - - incident_cost_types + - incident_cost_types put: description: Update an incident cost type by its id. operationId: update_incident_cost_type__organization__incident_cost_types__incident_cost_type_id__put parameters: - - in: path - name: incident_cost_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Cost Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_cost_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Cost Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentCostTypeUpdate' + $ref: "#/components/schemas/IncidentCostTypeUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentCostTypeRead' + $ref: "#/components/schemas/IncidentCostTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Incident Cost Type tags: - - incident_cost_types + - incident_cost_types /{organization}/incident_costs: get: description: Get all incident costs, or only those matching a given search term. operationId: get_incident_costs__organization__incident_costs_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentCostPagination' + $ref: "#/components/schemas/IncidentCostPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Incident Costs tags: - - incident_costs + - incident_costs post: description: Create an incident cost. operationId: create_incident_cost__organization__incident_costs_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentCostCreate' + $ref: "#/components/schemas/IncidentCostCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentCostRead' + $ref: "#/components/schemas/IncidentCostRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Incident Cost tags: - - incident_costs + - incident_costs /{organization}/incident_costs/{incident_cost_id}: delete: description: Delete an incident cost, returning only an HTTP 200 OK if successful. operationId: delete_incident_cost__organization__incident_costs__incident_cost_id__delete parameters: - - in: path - name: incident_cost_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Cost Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_cost_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Cost Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Incident Cost tags: - - incident_costs + - incident_costs get: description: Get an incident cost by its id. operationId: get_incident_cost__organization__incident_costs__incident_cost_id__get parameters: - - in: path - name: incident_cost_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Cost Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_cost_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Cost Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentCostRead' + $ref: "#/components/schemas/IncidentCostRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Incident Cost tags: - - incident_costs + - incident_costs put: description: Update an incident cost by its id. operationId: update_incident_cost__organization__incident_costs__incident_cost_id__put parameters: - - in: path - name: incident_cost_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Cost Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_cost_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Cost Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentCostUpdate' + $ref: "#/components/schemas/IncidentCostUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentCostRead' + $ref: "#/components/schemas/IncidentCostRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Incident Cost tags: - - incident_costs + - incident_costs /{organization}/incident_priorities: get: description: Returns all incident priorities. operationId: get_incident_priorities__organization__incident_priorities_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentPriorityPagination' + $ref: "#/components/schemas/IncidentPriorityPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Incident Priorities tags: - - incident_priorities - - incident_priorities + - incident_priorities + - incident_priorities post: description: Create a new incident priority. operationId: create_incident_priority__organization__incident_priorities_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentPriorityCreate' + $ref: "#/components/schemas/IncidentPriorityCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentPriorityRead' + $ref: "#/components/schemas/IncidentPriorityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Incident Priority tags: - - incident_priorities + - incident_priorities /{organization}/incident_priorities/{incident_priority_id}: get: description: Get an incident priority. operationId: get_incident_priority__organization__incident_priorities__incident_priority_id__get parameters: - - in: path - name: incident_priority_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Priority Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_priority_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Priority Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentPriorityRead' + $ref: "#/components/schemas/IncidentPriorityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Incident Priority tags: - - incident_priorities + - incident_priorities put: description: Update an existing incident priority. operationId: update_incident_priority__organization__incident_priorities__incident_priority_id__put parameters: - - in: path - name: incident_priority_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Priority Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_priority_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Priority Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentPriorityUpdate' + $ref: "#/components/schemas/IncidentPriorityUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentPriorityRead' + $ref: "#/components/schemas/IncidentPriorityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Incident Priority tags: - - incident_priorities + - incident_priorities /{organization}/incident_roles/{role}: get: description: Get all incident role mappings. operationId: get_incident_roles__organization__incident_roles__role__get parameters: - - in: path - name: role - required: true - schema: - $ref: '#/components/schemas/ParticipantRoleType' - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: projectName - required: true - schema: - title: Projectname - type: string + - in: path + name: role + required: true + schema: + $ref: "#/components/schemas/ParticipantRoleType" + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string + - in: query + name: projectName + required: true + schema: + title: Projectname + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentRoles' + $ref: "#/components/schemas/IncidentRoles" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Incident Roles tags: - - role + - role put: description: Update a incident role mapping by its id. operationId: update_incident_role__organization__incident_roles__role__put parameters: - - in: path - name: role - required: true - schema: - $ref: '#/components/schemas/ParticipantRoleType' - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: projectName - required: true - schema: - title: Projectname - type: string + - in: path + name: role + required: true + schema: + $ref: "#/components/schemas/ParticipantRoleType" + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string + - in: query + name: projectName + required: true + schema: + title: Projectname + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentRolesCreateUpdate' + $ref: "#/components/schemas/IncidentRolesCreateUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentRoles' + $ref: "#/components/schemas/IncidentRoles" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Incident Role tags: - - role + - role /{organization}/incident_severities: get: description: Returns all incident severities. operationId: get_incident_severities__organization__incident_severities_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentSeverityPagination' + $ref: "#/components/schemas/IncidentSeverityPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Incident Severities tags: - - incident_severities - - incident_severities + - incident_severities + - incident_severities post: description: Creates a new incident severity. operationId: create_incident_severity__organization__incident_severities_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentSeverityCreate' + $ref: "#/components/schemas/IncidentSeverityCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentSeverityRead' + $ref: "#/components/schemas/IncidentSeverityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Incident Severity tags: - - incident_severities + - incident_severities /{organization}/incident_severities/{incident_severity_id}: get: description: Gets an incident severity. operationId: get_incident_severity__organization__incident_severities__incident_severity_id__get parameters: - - in: path - name: incident_severity_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Severity Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_severity_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Severity Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentSeverityRead' + $ref: "#/components/schemas/IncidentSeverityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Incident Severity tags: - - incident_severities + - incident_severities put: description: Updates an existing incident severity. operationId: update_incident_severity__organization__incident_severities__incident_severity_id__put parameters: - - in: path - name: incident_severity_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Severity Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_severity_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Severity Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentSeverityUpdate' + $ref: "#/components/schemas/IncidentSeverityUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentSeverityRead' + $ref: "#/components/schemas/IncidentSeverityRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Incident Severity tags: - - incident_severities + - incident_severities /{organization}/incident_types: get: description: Returns all incident types. operationId: get_incident_types__organization__incident_types_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTypePagination' + $ref: "#/components/schemas/IncidentTypePagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Incident Types tags: - - incident_types - - incident_types + - incident_types + - incident_types post: description: Create a new incident type. operationId: create_incident_type__organization__incident_types_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentTypeCreate' + $ref: "#/components/schemas/IncidentTypeCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTypeRead' + $ref: "#/components/schemas/IncidentTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Incident Type tags: - - incident_types + - incident_types /{organization}/incident_types/{incident_type_id}: get: description: Get an incident type. operationId: get_incident_type__organization__incident_types__incident_type_id__get parameters: - - in: path - name: incident_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTypeRead' + $ref: "#/components/schemas/IncidentTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Incident Type tags: - - incident_types + - incident_types put: description: Update an existing incident type. operationId: update_incident_type__organization__incident_types__incident_type_id__put parameters: - - in: path - name: incident_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentTypeUpdate' + $ref: "#/components/schemas/IncidentTypeUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTypeRead' + $ref: "#/components/schemas/IncidentTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Incident Type tags: - - incident_types + - incident_types /{organization}/incidents: get: description: Retrieves a list of incidents. operationId: get_incidents__organization__incidents_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: include[] - required: false - schema: - default: [] - items: - type: string - title: Include[] - type: array - - in: query - name: expand - required: false - schema: - default: false - title: Expand - type: boolean - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: + - in: query + name: include[] + required: false + schema: + default: [] + items: + type: string + title: Include[] + type: array + - in: query + name: expand + required: false + schema: + default: false + title: Expand type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Retrieve a list of incidents. tags: - - incidents + - incidents post: description: Creates a new incident. operationId: create_incident__organization__incidents_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentCreate' + $ref: "#/components/schemas/IncidentCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentRead' + $ref: "#/components/schemas/IncidentRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Creates a new incident. tags: - - incidents + - incidents /{organization}/incidents/metric/forecast: get: description: Gets incident forecast data. operationId: get_incident_forecast__organization__incidents_metric_forecast_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Gets incident forecast data. tags: - - incidents + - incidents /{organization}/incidents/{incident_id}: delete: description: Deletes an incident and its external resources. operationId: delete_incident__organization__incidents__incident_id__delete parameters: - - in: path - name: incident_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Deletes an incident and its external resources. tags: - - incidents + - incidents get: description: Retrieves the details of a single incident. operationId: get_incident__organization__incidents__incident_id__get parameters: - - in: path - name: incident_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: incident_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentRead' + $ref: "#/components/schemas/IncidentRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Retrieves a single incident. tags: - - incidents + - incidents put: description: Updates an existing incident. operationId: update_incident__organization__incidents__incident_id__put parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: path - name: incident_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Id - type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string + - in: path + name: incident_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Id + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentUpdate' + $ref: "#/components/schemas/IncidentUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentRead' + $ref: "#/components/schemas/IncidentRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Updates an existing incident. tags: - - incidents + - incidents /{organization}/incidents/{incident_id}/join: post: description: Adds an individual to an incident. operationId: join_incident__organization__incidents__incident_id__join_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: path - name: incident_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Id - type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string + - in: path + name: incident_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Id + type: integer responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Adds an individual to an incident. tags: - - incidents + - incidents /{organization}/incidents/{incident_id}/report/executive: post: description: Creates an executive report. operationId: create_executive_report__organization__incidents__incident_id__report_executive_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: path - name: incident_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Id - type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string + - in: path + name: incident_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Id + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExecutiveReportCreate' + $ref: "#/components/schemas/ExecutiveReportCreate" required: true responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Creates an executive report. tags: - - incidents + - incidents /{organization}/incidents/{incident_id}/report/tactical: post: description: Creates a tactical report. operationId: create_tactical_report__organization__incidents__incident_id__report_tactical_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: path - name: incident_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Id - type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string + - in: path + name: incident_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Id + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/TacticalReportCreate' + $ref: "#/components/schemas/TacticalReportCreate" required: true responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Creates a tactical report. tags: - - incidents + - incidents /{organization}/incidents/{incident_id}/subscribe: post: description: Subscribes an individual to an incident. operationId: subscribe_to_incident__organization__incidents__incident_id__subscribe_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: path - name: incident_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Incident Id - type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string + - in: path + name: incident_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Incident Id + type: integer responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Subscribes an individual to an incident. tags: - - incidents + - incidents /{organization}/individuals: get: description: Retrieve individual contacts. operationId: get_individuals__organization__individuals_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IndividualContactPagination' + $ref: "#/components/schemas/IndividualContactPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Individuals tags: - - individuals + - individuals post: description: Creates a new individual contact. operationId: create_individual__organization__individuals_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IndividualContactCreate' + $ref: "#/components/schemas/IndividualContactCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IndividualContactRead' + $ref: "#/components/schemas/IndividualContactRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Individual tags: - - individuals + - individuals /{organization}/individuals/{individual_contact_id}: delete: description: Deletes an individual contact. operationId: delete_individual__organization__individuals__individual_contact_id__delete parameters: - - in: path - name: individual_contact_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Individual Contact Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: individual_contact_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Individual Contact Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Deletes an individual contact. tags: - - individuals + - individuals get: description: Gets an individual contact. operationId: get_individual__organization__individuals__individual_contact_id__get parameters: - - in: path - name: individual_contact_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Individual Contact Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: individual_contact_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Individual Contact Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IndividualContactRead' + $ref: "#/components/schemas/IndividualContactRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Individual tags: - - individuals + - individuals put: description: Updates an individual contact. operationId: update_individual__organization__individuals__individual_contact_id__put parameters: - - in: path - name: individual_contact_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Individual Contact Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: individual_contact_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Individual Contact Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IndividualContactUpdate' + $ref: "#/components/schemas/IndividualContactUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IndividualContactRead' + $ref: "#/components/schemas/IndividualContactRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Updates an individual's contact information. tags: - - individuals + - individuals /{organization}/notifications: get: description: Get all notifications, or only those matching a given search term. operationId: get_notifications__organization__notifications_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/NotificationPagination' + $ref: "#/components/schemas/NotificationPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Notifications tags: - - notifications + - notifications post: description: Create a notification. operationId: create_notification__organization__notifications_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/NotificationCreate' + $ref: "#/components/schemas/NotificationCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/NotificationRead' + $ref: "#/components/schemas/NotificationRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Notification tags: - - notifications + - notifications /{organization}/notifications/{notification_id}: delete: description: Delete a notification, returning only an HTTP 200 OK if successful. operationId: delete_notification__organization__notifications__notification_id__delete parameters: - - in: path - name: notification_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Notification Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: notification_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Notification Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Notification tags: - - notifications + - notifications get: description: Get a notification by its id. operationId: get_notification__organization__notifications__notification_id__get parameters: - - in: path - name: notification_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Notification Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: notification_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Notification Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/NotificationRead' + $ref: "#/components/schemas/NotificationRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Notification tags: - - notifications + - notifications put: description: Update a notification by its id. operationId: update_notification__organization__notifications__notification_id__put parameters: - - in: path - name: notification_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Notification Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: notification_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Notification Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/NotificationUpdate' + $ref: "#/components/schemas/NotificationUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/NotificationRead' + $ref: "#/components/schemas/NotificationRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Notification tags: - - notifications + - notifications /{organization}/plugins: get: description: Get all plugins. operationId: get_plugins__organization__plugins_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PluginPagination' + $ref: "#/components/schemas/PluginPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Plugins tags: - - plugins + - plugins /{organization}/plugins/instances: get: description: Get all plugin instances. operationId: get_plugin_instances__organization__plugins_instances_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PluginInstancePagination' + $ref: "#/components/schemas/PluginInstancePagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Plugin Instances tags: - - plugins + - plugins post: description: Create a new plugin instance. operationId: create_plugin_instance__organization__plugins_instances_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PluginInstanceCreate' + $ref: "#/components/schemas/PluginInstanceCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PluginInstanceRead' + $ref: "#/components/schemas/PluginInstanceRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Plugin Instance tags: - - plugins + - plugins /{organization}/plugins/instances/{plugin_instance_id}: delete: description: Deletes an existing plugin instance. operationId: delete_plugin_instances__organization__plugins_instances__plugin_instance_id__delete parameters: - - in: path - name: plugin_instance_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Plugin Instance Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: plugin_instance_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Plugin Instance Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Plugin Instances tags: - - plugins + - plugins get: description: Get a plugin instance. operationId: get_plugin_instance__organization__plugins_instances__plugin_instance_id__get parameters: - - in: path - name: plugin_instance_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Plugin Instance Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: plugin_instance_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Plugin Instance Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PluginInstanceRead' + $ref: "#/components/schemas/PluginInstanceRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Plugin Instance tags: - - plugins + - plugins put: description: Update a plugin instance. operationId: update_plugin_instance__organization__plugins_instances__plugin_instance_id__put parameters: - - in: path - name: plugin_instance_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Plugin Instance Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: plugin_instance_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Plugin Instance Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PluginInstanceUpdate' + $ref: "#/components/schemas/PluginInstanceUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PluginInstanceCreate' + $ref: "#/components/schemas/PluginInstanceCreate" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Plugin Instance tags: - - plugins + - plugins /{organization}/projects: get: description: Get all projects. operationId: get_projects__organization__projects_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProjectPagination' + $ref: "#/components/schemas/ProjectPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Projects tags: - - projects + - projects post: description: Create a new project. operationId: create_project__organization__projects_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProjectCreate' + $ref: "#/components/schemas/ProjectCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create a new project. tags: - - projects + - projects /{organization}/projects/{project_id}: delete: description: Delete a project. operationId: delete_project__organization__projects__project_id__delete parameters: - - in: path - name: project_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Project Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: project_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Project Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Project tags: - - projects + - projects get: description: Get a project. operationId: get_project__organization__projects__project_id__get parameters: - - in: path - name: project_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Project Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: project_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Project Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get a project. tags: - - projects + - projects put: description: Update a project. operationId: update_project__organization__projects__project_id__put parameters: - - in: path - name: project_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Project Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: project_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Project Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProjectUpdate' + $ref: "#/components/schemas/ProjectUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__project__models__ProjectRead' + $ref: "#/components/schemas/dispatch__project__models__ProjectRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Project tags: - - projects + - projects /{organization}/search: get: description: Perform a search. operationId: search__organization__search_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: type[] - required: true - schema: - items: - $ref: '#/components/schemas/SearchTypes' - type: array - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: type[] + required: true + schema: + items: + $ref: "#/components/schemas/SearchTypes" + type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Search tags: - - search + - search /{organization}/search/filters: get: description: Retrieve filters. operationId: get_filters__organization__search_filters_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SearchFilterPagination' + $ref: "#/components/schemas/SearchFilterPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Filters tags: - - search_filters + - search_filters post: description: Create a new filter. operationId: create_search_filter__organization__search_filters_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SearchFilterCreate' + $ref: "#/components/schemas/SearchFilterCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Search Filter tags: - - search_filters + - search_filters /{organization}/search/filters/{search_filter_id}: delete: description: Delete a search filter. operationId: delete_filter__organization__search_filters__search_filter_id__delete parameters: - - in: path - name: search_filter_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Search Filter Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: search_filter_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Search Filter Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Filter tags: - - search_filters + - search_filters put: description: Update a search filter. operationId: update_search_filter__organization__search_filters__search_filter_id__put parameters: - - in: path - name: search_filter_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Search Filter Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: search_filter_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Search Filter Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SearchFilterUpdate' + $ref: "#/components/schemas/SearchFilterUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SearchFilterRead' + $ref: "#/components/schemas/SearchFilterRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Search Filter tags: - - search_filters + - search_filters /{organization}/services: get: description: Retrieves all services. operationId: get_services__organization__services_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServicePagination' + $ref: "#/components/schemas/ServicePagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Services tags: - - services + - services post: description: Creates a new service. operationId: create_service__organization__services_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: example: - external_id: '234234' + external_id: "234234" is_active: true name: myService type: pagerduty schema: - $ref: '#/components/schemas/ServiceCreate' + $ref: "#/components/schemas/ServiceCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceRead' + $ref: "#/components/schemas/ServiceRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Service tags: - - services + - services /{organization}/services/{service_id}: delete: description: Deletes a service. operationId: delete_service__organization__services__service_id__delete parameters: - - in: path - name: service_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Service Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: service_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Service Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Service tags: - - services + - services get: description: Gets a service. operationId: get_service__organization__services__service_id__get parameters: - - in: path - name: service_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Service Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: service_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Service Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceRead' + $ref: "#/components/schemas/ServiceRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Service tags: - - services + - services put: description: Updates an existing service. operationId: update_service__organization__services__service_id__put parameters: - - in: path - name: service_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Service Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: service_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Service Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceUpdate' + $ref: "#/components/schemas/ServiceUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceRead' + $ref: "#/components/schemas/ServiceRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Service tags: - - services + - services /{organization}/signals: get: description: Get all signal definitions. operationId: get_signals__organization__signals_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SignalPagination' + $ref: "#/components/schemas/SignalPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Signals tags: - - signals + - signals post: description: Create a new signal. operationId: create_signal__organization__signals_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SignalCreate' + $ref: "#/components/schemas/SignalCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__signal__models__SignalRead' + $ref: "#/components/schemas/dispatch__signal__models__SignalRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Signal tags: - - signals + - signals /{organization}/signals/filters: get: description: Get all signal filters. operationId: get_signal_filters__organization__signals_filters_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SignalFilterPagination' + $ref: "#/components/schemas/SignalFilterPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Signal Filters tags: - - signals + - signals post: description: Create a new signal filter. operationId: create_filter__organization__signals_filters_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SignalFilterCreate' + $ref: "#/components/schemas/SignalFilterCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SignalFilterRead' + $ref: "#/components/schemas/SignalFilterRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Filter tags: - - signals + - signals /{organization}/signals/filters/{signal_filter_id}: delete: description: Deletes a signal filter. operationId: delete_filter__organization__signals_filters__signal_filter_id__delete parameters: - - in: path - name: signal_filter_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Signal Filter Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: signal_filter_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Signal Filter Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Filter tags: - - signals + - signals put: description: Updates an existing signal filter. operationId: update_filter__organization__signals_filters__signal_filter_id__put parameters: - - in: path - name: signal_filter_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Signal Filter Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: signal_filter_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Signal Filter Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SignalFilterUpdate' + $ref: "#/components/schemas/SignalFilterUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__signal__models__SignalRead' + $ref: "#/components/schemas/dispatch__signal__models__SignalRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Filter tags: - - signals + - signals /{organization}/signals/instances: get: description: Get all signal instances. operationId: get_signal_instances__organization__signals_instances_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SignalInstancePagination' + $ref: "#/components/schemas/SignalInstancePagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Signal Instances tags: - - signals + - signals post: description: Create a new signal instance. operationId: create_signal_instance__organization__signals_instances_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SignalInstanceCreate' + $ref: "#/components/schemas/SignalInstanceCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__signal__models__SignalInstanceRead' + $ref: "#/components/schemas/dispatch__signal__models__SignalInstanceRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Signal Instance tags: - - signals + - signals /{organization}/signals/{signal_id}: delete: description: Deletes a signal. operationId: delete_signal__organization__signals__signal_id__delete parameters: - - in: path - name: signal_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Signal Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: signal_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Signal Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Signal tags: - - signals + - signals get: description: Get a signal by it's ID. operationId: get_signal__organization__signals__signal_id__get parameters: - - in: path - name: signal_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Signal Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: signal_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Signal Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__signal__models__SignalRead' + $ref: "#/components/schemas/dispatch__signal__models__SignalRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Signal tags: - - signals + - signals put: description: Updates an existing signal. operationId: update_signal__organization__signals__signal_id__put parameters: - - in: path - name: signal_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Signal Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: signal_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Signal Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SignalUpdate' + $ref: "#/components/schemas/SignalUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__signal__models__SignalRead' + $ref: "#/components/schemas/dispatch__signal__models__SignalRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Signal tags: - - signals + - signals /{organization}/tag_types: get: description: Get all tag types, or only those matching a given search term. operationId: get_tag_types__organization__tag_types_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TagTypePagination' + $ref: "#/components/schemas/TagTypePagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Tag Types tags: - - tag_types + - tag_types post: description: Create a new tag type. operationId: create_tag_type__organization__tag_types_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TagTypeCreate' + $ref: "#/components/schemas/TagTypeCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TagTypeRead' + $ref: "#/components/schemas/TagTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Tag Type tags: - - tag_types + - tag_types /{organization}/tag_types/{tag_type_id}: delete: description: Delete a tag type. operationId: delete_tag_type__organization__tag_types__tag_type_id__delete parameters: - - in: path - name: tag_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Tag Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: tag_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Tag Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Tag Type tags: - - tag_types + - tag_types get: description: Get a tag type by its id. operationId: get_tag_type__organization__tag_types__tag_type_id__get parameters: - - in: path - name: tag_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Tag Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: tag_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Tag Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TagTypeRead' + $ref: "#/components/schemas/TagTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Tag Type tags: - - tag_types + - tag_types put: description: Update a tag type. operationId: update_tag_type__organization__tag_types__tag_type_id__put parameters: - - in: path - name: tag_type_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Tag Type Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: tag_type_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Tag Type Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TagTypeUpdate' + $ref: "#/components/schemas/TagTypeUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TagTypeRead' + $ref: "#/components/schemas/TagTypeRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Tag Type tags: - - tag_types + - tag_types /{organization}/tags: get: description: Get all tags, or only those matching a given search term. operationId: get_tags__organization__tags_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TagPagination' + $ref: "#/components/schemas/TagPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Tags tags: - - tags + - tags post: description: Creates a new tag. operationId: create_tag__organization__tags_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TagCreate' + $ref: "#/components/schemas/TagCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Tag tags: - - tags + - tags /{organization}/tags/recommendations/{model_name}/{id}: get: description: Retrieves a tag recommendation based on the model and model id. operationId: get_tag_recommendations__organization__tags_recommendations__model_name___id__get parameters: - - in: path - name: model_name - required: true - schema: - title: Model Name - type: string - - in: path - name: id - required: true - schema: - title: Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: model_name + required: true + schema: + title: Model Name + type: string + - in: path + name: id + required: true + schema: + title: Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TagPagination' + $ref: "#/components/schemas/TagPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Tag Recommendations tags: - - tags + - tags /{organization}/tags/{tag_id}: delete: description: Deletes a tag, returning only an HTTP 200 OK if successful. operationId: delete_tag__organization__tags__tag_id__delete parameters: - - in: path - name: tag_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Tag Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: tag_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Tag Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Tag tags: - - tags + - tags get: description: Given its unique id, retrieve details about a single tag. operationId: get_tag__organization__tags__tag_id__get parameters: - - in: path - name: tag_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Tag Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: tag_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Tag Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Tag tags: - - tags + - tags put: description: Updates an existing tag. operationId: update_tag__organization__tags__tag_id__put parameters: - - in: path - name: tag_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Tag Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: tag_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Tag Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TagUpdate' + $ref: "#/components/schemas/TagUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TagRead' + $ref: "#/components/schemas/TagRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Tag tags: - - tags - /{organization}/tasks: - get: - description: Retrieve all tasks. - operationId: get_tasks__organization__tasks_get - parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: include[] - required: false - schema: - default: [] - items: + - tags + /{organization}/tasks: + get: + description: Retrieve all tasks. + operationId: get_tasks__organization__tasks_get + parameters: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Include[] - type: array - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: query + name: include[] + required: false + schema: + default: [] + items: + type: string + title: Include[] + type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Retrieve a list of all tasks. tags: - - tasks + - tasks post: description: Creates a new task. operationId: create_task__organization__tasks_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TaskCreate' + $ref: "#/components/schemas/TaskCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__task__models__TaskRead' + $ref: "#/components/schemas/dispatch__task__models__TaskRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Task tags: - - tasks - - tasks + - tasks + - tasks /{organization}/tasks/{task_id}: delete: description: Deletes an existing task. operationId: delete_task__organization__tasks__task_id__delete parameters: - - in: path - name: task_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Task Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: task_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Task Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Task tags: - - tasks - - tasks + - tasks + - tasks put: description: Updates an existing task. operationId: update_task__organization__tasks__task_id__put parameters: - - in: path - name: task_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Task Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: task_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Task Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TaskUpdate' + $ref: "#/components/schemas/TaskUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/dispatch__task__models__TaskRead' + $ref: "#/components/schemas/dispatch__task__models__TaskRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Task tags: - - tasks - - tasks + - tasks + - tasks /{organization}/teams: get: description: Get all team contacts. operationId: get_teams__organization__teams_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamPagination' + $ref: "#/components/schemas/TeamPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Teams tags: - - teams + - teams post: description: Create a new team contact. operationId: create_team__organization__teams_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TeamContactCreate' + $ref: "#/components/schemas/TeamContactCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamContactRead' + $ref: "#/components/schemas/TeamContactRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Team tags: - - teams + - teams /{organization}/teams/{team_contact_id}: delete: description: Delete a team contact. operationId: delete_team__organization__teams__team_contact_id__delete parameters: - - in: path - name: team_contact_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Team Contact Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: team_contact_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Team Contact Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Team tags: - - teams + - teams get: description: Get a team contact. operationId: get_team__organization__teams__team_contact_id__get parameters: - - in: path - name: team_contact_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Team Contact Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: team_contact_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Team Contact Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamContactRead' + $ref: "#/components/schemas/TeamContactRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Team tags: - - teams + - teams put: description: Update a team contact. operationId: update_team__organization__teams__team_contact_id__put parameters: - - in: path - name: team_contact_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Team Contact Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: team_contact_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Team Contact Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TeamContactUpdate' + $ref: "#/components/schemas/TeamContactUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamContactRead' + $ref: "#/components/schemas/TeamContactRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Team tags: - - teams + - teams /{organization}/terms: get: description: Retrieve all terms. operationId: get_terms__organization__terms_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TermPagination' + $ref: "#/components/schemas/TermPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Terms tags: - - terms + - terms post: description: Create a new term. operationId: create_term__organization__terms_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TermCreate' + $ref: "#/components/schemas/TermCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TermRead' + $ref: "#/components/schemas/TermRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Term tags: - - terms + - terms /{organization}/terms/{term_id}: delete: description: Delete a term. operationId: delete_term__organization__terms__term_id__delete parameters: - - in: path - name: term_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Term Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: term_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Term Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Term tags: - - terms + - terms get: description: Get a term. operationId: get_term__organization__terms__term_id__get parameters: - - in: path - name: term_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Term Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: term_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Term Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TermRead' + $ref: "#/components/schemas/TermRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Term tags: - - terms + - terms put: description: Update a term. operationId: update_term__organization__terms__term_id__put parameters: - - in: path - name: term_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Term Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: term_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Term Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TermUpdate' + $ref: "#/components/schemas/TermUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TermRead' + $ref: "#/components/schemas/TermRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Term tags: - - terms + - terms /{organization}/users: get: description: Get all users. operationId: get_users__organization__users_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserPagination' + $ref: "#/components/schemas/UserPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Users tags: - - users + - users /{organization}/users/{user_id}: get: description: Get a user. operationId: get_user__organization__users__user_id__get parameters: - - in: path - name: user_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: User Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: user_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: User Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserRead' + $ref: "#/components/schemas/UserRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get User tags: - - users + - users put: description: Update a user. operationId: update_user__organization__users__user_id__put parameters: - - in: path - name: user_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: User Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: user_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: User Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UserUpdate' + $ref: "#/components/schemas/UserUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserRead' + $ref: "#/components/schemas/UserRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update User tags: - - users + - users /{organization}/workflows: get: description: Get all workflows. operationId: get_workflows__organization__workflows_get parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string - - in: query - name: page - required: false - schema: - default: 1 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Page - type: integer - - in: query - name: itemsPerPage - required: false - schema: - default: 5 - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: -2.0 - title: Itemsperpage - type: integer - - in: query - name: q - required: false - schema: - minLength: 1 - pattern: ^[ -~]+$ - title: Q - type: string - - in: query - name: filter - required: false - schema: - default: [] - format: json-string - title: Filter - type: string - - in: query - name: sortBy[] - required: false - schema: - default: [] - items: + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization type: string - title: Sortby[] - type: array - - in: query - name: descending[] - required: false - schema: - default: [] - items: - type: boolean - title: Descending[] - type: array + - in: query + name: page + required: false + schema: + default: 1 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Page + type: integer + - in: query + name: itemsPerPage + required: false + schema: + default: 5 + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: -2.0 + title: Itemsperpage + type: integer + - in: query + name: q + required: false + schema: + minLength: 1 + pattern: ^[ -~]+$ + title: Q + type: string + - in: query + name: filter + required: false + schema: + default: [] + format: json-string + title: Filter + type: string + - in: query + name: sortBy[] + required: false + schema: + default: [] + items: + type: string + title: Sortby[] + type: array + - in: query + name: descending[] + required: false + schema: + default: [] + items: + type: boolean + title: Descending[] + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WorkflowPagination' + $ref: "#/components/schemas/WorkflowPagination" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Workflows tags: - - workflows + - workflows post: description: Create a new workflow. operationId: create_workflow__organization__workflows_post parameters: - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WorkflowCreate' + $ref: "#/components/schemas/WorkflowCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WorkflowRead' + $ref: "#/components/schemas/WorkflowRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Create Workflow tags: - - workflows + - workflows /{organization}/workflows/instances/{workflow_instance_id}: get: description: Get a workflow instance. operationId: get_workflow_instance__organization__workflows_instances__workflow_instance_id__get parameters: - - in: path - name: workflow_instance_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Workflow Instance Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: workflow_instance_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Workflow Instance Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WorkflowInstanceRead' + $ref: "#/components/schemas/WorkflowInstanceRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Workflow Instance tags: - - workflows + - workflows /{organization}/workflows/{workflow_id}: delete: description: Delete a workflow. operationId: delete_workflow__organization__workflows__workflow_id__delete parameters: - - in: path - name: workflow_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Workflow Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: workflow_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Workflow Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: {} description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Delete Workflow tags: - - workflows + - workflows get: description: Get a workflow. operationId: get_workflow__organization__workflows__workflow_id__get parameters: - - in: path - name: workflow_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Workflow Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: workflow_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Workflow Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WorkflowRead' + $ref: "#/components/schemas/WorkflowRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Get Workflow tags: - - workflows + - workflows put: description: Update a workflow. operationId: update_workflow__organization__workflows__workflow_id__put parameters: - - in: path - name: workflow_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Workflow Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: workflow_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Workflow Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WorkflowUpdate' + $ref: "#/components/schemas/WorkflowUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WorkflowRead' + $ref: "#/components/schemas/WorkflowRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Update Workflow tags: - - workflows + - workflows /{organization}/workflows/{workflow_id}/run: post: description: Runs a workflow with a given set of parameters. operationId: run_workflow__organization__workflows__workflow_id__run_post parameters: - - in: path - name: workflow_id - required: true - schema: - exclusiveMaximum: 2147483647.0 - exclusiveMinimum: 0.0 - title: Workflow Id - type: integer - - in: path - name: organization - required: true - schema: - minLength: 3 - pattern: ^[\w]+(?:_[\w]+)*$ - title: Organization - type: string + - in: path + name: workflow_id + required: true + schema: + exclusiveMaximum: 2147483647.0 + exclusiveMinimum: 0.0 + title: Workflow Id + type: integer + - in: path + name: organization + required: true + schema: + minLength: 3 + pattern: ^[\w]+(?:_[\w]+)*$ + title: Organization + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WorkflowInstanceCreate' + $ref: "#/components/schemas/WorkflowInstanceCreate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WorkflowInstanceRead' + $ref: "#/components/schemas/WorkflowInstanceRead" description: Successful Response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/HTTPValidationError' + $ref: "#/components/schemas/HTTPValidationError" description: Validation Error - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: "#/components/schemas/ErrorResponse" description: Internal Server Error summary: Run Workflow tags: - - workflows + - workflows diff --git a/src/dispatch/case/enums.py b/src/dispatch/case/enums.py index de667c0ebdd8..3feaca214284 100644 --- a/src/dispatch/case/enums.py +++ b/src/dispatch/case/enums.py @@ -5,6 +5,7 @@ class CaseStatus(DispatchEnum): new = "New" triage = "Triage" escalated = "Escalated" + stable = "Stable" closed = "Closed" diff --git a/src/dispatch/case/flows.py b/src/dispatch/case/flows.py index 38381bd26e4c..75a9869d72e3 100644 --- a/src/dispatch/case/flows.py +++ b/src/dispatch/case/flows.py @@ -42,7 +42,7 @@ send_case_rating_feedback_message, send_case_update_notifications, send_event_paging_message, - send_event_update_prompt_reminder + send_event_update_prompt_reminder, ) from .models import Case from .service import get @@ -336,11 +336,32 @@ def case_triage_create_flow(*, case_id: int, organization_slug: OrganizationSlug case_triage_status_flow(case=case, db_session=db_session) +@background_task +def case_stable_create_flow(*, case_id: int, organization_slug: OrganizationSlug, db_session=None): + """Runs the case stable create flow.""" + # we run the case new creation flow + case_new_create_flow( + case_id=case_id, organization_slug=organization_slug, db_session=db_session + ) + + # we get the case + case = get(db_session=db_session, case_id=case_id) + + # we transition the case to the triage state + case_triage_status_flow(case=case, db_session=db_session) + + case = get(db_session=db_session, case_id=case_id) + case_stable_status_flow( + case=case, + db_session=db_session, + ) + + @background_task def case_escalated_create_flow( *, case_id: int, organization_slug: OrganizationSlug, db_session=None ): - """Runs the case escalated creation flow.""" + """Runs the case escalated create flow.""" # we run the case new creation flow case_new_create_flow( case_id=case_id, organization_slug=organization_slug, db_session=db_session @@ -352,9 +373,13 @@ def case_escalated_create_flow( # we transition the case to the triage state case_triage_status_flow(case=case, db_session=db_session) - # we transition the case to the escalated state + # then to the stable state + case_stable_status_flow(case=case, db_session=db_session) + case_escalated_status_flow( - case=case, organization_slug=organization_slug, db_session=db_session + case=case, + organization_slug=organization_slug, + db_session=db_session, ) @@ -516,12 +541,19 @@ def case_escalated_status_flow( incident_type: IncidentType | None, incident_description: str | None, ): - """Runs the case escalated transition flow.""" - # we set the escalated_at time + """Runs the case escalated status flow.""" + # we set the escalated at time case.escalated_at = datetime.utcnow() db_session.add(case) db_session.commit() + event_service.log_case_event( + db_session=db_session, + source="Dispatch Core App", + description="Case escalated", + case_id=case.id, + ) + case_to_incident_escalate_flow( case=case, organization_slug=organization_slug, @@ -533,6 +565,21 @@ def case_escalated_status_flow( ) +def case_stable_status_flow(case: Case, db_session=None): + """Runs the case stable status flow.""" + # we set the stable at time + case.stable_at = datetime.utcnow() + db_session.add(case) + db_session.commit() + + event_service.log_case_event( + db_session=db_session, + source="Dispatch Core App", + description="Case marked as stable", + case_id=case.id, + ) + + def case_closed_status_flow(case: Case, db_session=None): """Runs the case closed transition flow.""" # we set the closed_at time @@ -723,6 +770,46 @@ def case_status_transition_flow_dispatcher( db_session=db_session, ) + case (CaseStatus.escalated, CaseStatus.stable): + # Escalated -> Stable + case_stable_status_flow( + case=case, + db_session=db_session, + ) + + case (CaseStatus.triage, CaseStatus.stable): + # Triage -> Stable + case_stable_status_flow( + case=case, + db_session=db_session, + ) + + case (CaseStatus.new, CaseStatus.stable): + # New -> Stable + case_triage_status_flow( + case=case, + db_session=db_session, + ) + case_stable_status_flow( + case=case, + db_session=db_session, + ) + + case (CaseStatus.stable, CaseStatus.closed): + # Stable -> Closed + case_closed_status_flow( + case=case, + db_session=db_session, + ) + + case (CaseStatus.closed, CaseStatus.stable): + # Closed -> Stable + case_active_status_flow(case, db_session) + case_stable_status_flow( + case=case, + db_session=db_session, + ) + case (_, _): pass diff --git a/src/dispatch/case/models.py b/src/dispatch/case/models.py index 0254f17a0b46..7b71aea85a3c 100644 --- a/src/dispatch/case/models.py +++ b/src/dispatch/case/models.py @@ -99,6 +99,7 @@ class Case(Base, TimeStampMixin, ProjectMixin): dedicated_channel = Column(Boolean, default=False) genai_analysis = Column(JSONB, default={}, nullable=False, server_default="{}") event = Column(Boolean, default=False) + stable_at = Column(DateTime) search_vector = Column( TSVectorType( @@ -328,6 +329,7 @@ class CaseReadMinimal(CaseBase): status: CaseStatus | None = None # Used in table and for action disabling closed_at: datetime | None = None reported_at: datetime | None = None + stable_at: datetime | None = None dedicated_channel: bool | None = None # Used by CaseStatus component case_type: CaseTypeRead case_severity: CaseSeverityRead @@ -336,6 +338,7 @@ class CaseReadMinimal(CaseBase): assignee: ParticipantReadMinimal | None = None case_costs: list[CaseCostReadMinimal] = [] + class CaseReadMinimalWithExtras(CaseBase): """Pydantic model for reading minimal case data.""" @@ -349,6 +352,7 @@ class CaseReadMinimalWithExtras(CaseBase): status: CaseStatus | None = None # Used in table and for action disabling reported_at: datetime | None = None triage_at: datetime | None = None + stable_at: datetime | None = None escalated_at: datetime | None = None closed_at: datetime | None = None dedicated_channel: bool | None = None # Used by CaseStatus component @@ -379,6 +383,7 @@ class CaseRead(CaseBase): closed_at: datetime | None = None conversation: ConversationRead | None = None created_at: datetime | None = None + stable_at: datetime | None = None documents: list[DocumentRead] | None = [] duplicates: list[CaseReadBasic] | None = [] escalated_at: datetime | None = None @@ -413,6 +418,7 @@ class CaseUpdate(CaseBase): case_severity: CaseSeverityBase | None = None case_type: CaseTypeBase | None = None closed_at: datetime | None = None + stable_at: datetime | None = None duplicates: list[CaseReadBasic] | None = [] related: list[CaseRead] | None = [] reporter: ParticipantUpdate | None = None @@ -451,11 +457,13 @@ class CasePagination(Pagination): items: list[CaseReadMinimal] = [] + class CasePaginationMinimalWithExtras(Pagination): """Pydantic model for paginated minimal case results.""" items: list[CaseReadMinimalWithExtras] = [] + class CaseExpandedPagination(Pagination): """Pydantic model for paginated expanded case results.""" diff --git a/src/dispatch/case/scheduled.py b/src/dispatch/case/scheduled.py index 0b88cdba3837..e0685297da02 100644 --- a/src/dispatch/case/scheduled.py +++ b/src/dispatch/case/scheduled.py @@ -63,3 +63,25 @@ def case_triage_reminder(db_session: Session, project: Project): if q >= 1: # we only send one reminder per case per day send_case_triage_reminder(case, db_session) + + +@scheduler.add(every(1).day.at("18:00"), name="case-stable-reminder") +@timer +@scheduled_project_task +def case_stable_reminder(db_session: Session, project: Project): + """Sends a reminder to the case assignee to close their stable case.""" + cases = get_all_by_status( + db_session=db_session, project_id=project.id, statuses=[CaseStatus.stable] + ) + + for case in cases: + try: + span = datetime.utcnow() - case.stable_at + q, r = divmod(span.days, 7) + if q >= 1 and date.today().isoweekday() == 1: + # we only send the reminder for cases that have been stable + # longer than a week and only on Mondays + send_case_close_reminder(case, db_session) + except Exception as e: + # if one fails we don't want all to fail + log.exception(e) diff --git a/src/dispatch/case/service.py b/src/dispatch/case/service.py index e2ce5ca40ed9..5ed9a7bf9651 100644 --- a/src/dispatch/case/service.py +++ b/src/dispatch/case/service.py @@ -93,8 +93,10 @@ def get_all_by_status( Case.created_at, Case.updated_at, Case.triage_at, + Case.escalated_at, + Case.stable_at, Case.closed_at, - ) + ), ) .filter(Case.project_id == project_id) .filter(Case.status.in_(statuses)) @@ -141,6 +143,15 @@ def get_all_last_x_hours_by_status( .all() ) + if status == CaseStatus.stable: + return ( + db_session.query(Case) + .filter(Case.project_id == project_id) + .filter(Case.status == CaseStatus.stable) + .filter(Case.stable_at >= now - timedelta(hours=hours)) + .all() + ) + if status == CaseStatus.closed: return ( db_session.query(Case) @@ -152,13 +163,16 @@ def get_all_last_x_hours_by_status( def create(*, db_session, case_in: CaseCreate, current_user: DispatchUser = None) -> Case: - """Creates a new case. + """ + Creates a new case. Returns: The created case. Raises: - ValidationError: If the case type does not have a conversation target and the case is not being created with a dedicated channel, the case will not be created. + ValidationError: If the case type does not have a conversation target and + the case is not being created with a dedicated channel, the case will not + be created. """ project = project_service.get_by_name_or_default( db_session=db_session, project_in=case_in.project @@ -177,7 +191,9 @@ def create(*, db_session, case_in: CaseCreate, current_user: DispatchUser = None if not case_in.dedicated_channel: if not case_type or not case_type.conversation_target: raise ValueError( - f"Cases without dedicated channels require a conversation target. Case type with name {case_in.case_type.name} does not have a conversation target. The case will not be created." + f"Cases without dedicated channels require a conversation target. " + f"Case type with name {case_in.case_type.name} does not have a " + f"conversation target. The case will not be created." ) case = Case( diff --git a/src/dispatch/case/views.py b/src/dispatch/case/views.py index 7b57456de8cb..39f1d7575789 100644 --- a/src/dispatch/case/views.py +++ b/src/dispatch/case/views.py @@ -34,12 +34,21 @@ case_delete_flow, case_escalated_create_flow, case_new_create_flow, + case_stable_create_flow, case_to_incident_endpoint_escalate_flow, case_triage_create_flow, case_update_flow, get_case_participants_flow, ) -from .models import Case, CaseCreate, CaseExpandedPagination, CasePagination, CasePaginationMinimalWithExtras, CaseRead, CaseUpdate +from .models import ( + Case, + CaseCreate, + CaseExpandedPagination, + CasePagination, + CasePaginationMinimalWithExtras, + CaseRead, + CaseUpdate, +) from .service import create, delete, get, get_participants, update log = logging.getLogger(__name__) @@ -144,6 +153,7 @@ def get_cases_minimal( return json.loads(CasePaginationMinimalWithExtras(**pagination).json()) + @router.post("", response_model=CaseRead, summary="Creates a new case.") def create_case( db_session: DbSession, @@ -201,6 +211,12 @@ def create_case( case_id=case.id, organization_slug=organization, ) + elif case.status == CaseStatus.stable: + background_tasks.add_task( + case_stable_create_flow, + case_id=case.id, + organization_slug=organization, + ) else: background_tasks.add_task( case_new_create_flow, diff --git a/src/dispatch/case_cost/scheduled.py b/src/dispatch/case_cost/scheduled.py index d38f89370ac2..0d769b5e0ac2 100644 --- a/src/dispatch/case_cost/scheduled.py +++ b/src/dispatch/case_cost/scheduled.py @@ -25,7 +25,9 @@ def calculate_cases_response_cost(db_session: Session, project: Project): """Calculates and saves the response cost for all cases.""" cases = case_service.get_all_by_status( - db_session=db_session, project_id=project.id, statuses=[CaseStatus.new, CaseStatus.triage] + db_session=db_session, + project_id=project.id, + statuses=[CaseStatus.new, CaseStatus.triage, CaseStatus.stable], ) for case in cases: @@ -38,16 +40,24 @@ def calculate_cases_response_cost(db_session: Session, project: Project): case=case, db_session=db_session, model_type=CostModelType.new ) - # we don't need to update the cost of closed cases if they already have a response cost and this was updated after the case was closed + # we don't need to update the cost of closed cases if they already have a response + # cost and this was updated after the case was closed if case.status == CaseStatus.closed: if case_response_cost_classic: if case_response_cost_classic.updated_at > case.closed_at: continue - # we don't need to update the cost of escalated cases if they already have a response cost and this was updated after the case was escalated + # we don't need to update the cost of escalated cases if they already have a response + # cost and this was updated after the case was escalated if case.status == CaseStatus.escalated: if case_response_cost_classic: if case_response_cost_classic.updated_at > case.escalated_at: continue + # we don't need to update the cost of stable cases if they already have a response + # cost and this was updated after the case was marked as stable + if case.status == CaseStatus.stable: + if case_response_cost_classic: + if case.stable_at and case_response_cost_classic.updated_at > case.stable_at: + continue # we calculate the response cost amount results = update_case_response_cost(case, db_session) diff --git a/src/dispatch/case_cost/service.py b/src/dispatch/case_cost/service.py index 552f2545ea97..442b31393df5 100644 --- a/src/dispatch/case_cost/service.py +++ b/src/dispatch/case_cost/service.py @@ -141,8 +141,9 @@ def get_or_create_case_response_cost_by_model_type( if not response_cost_type: log.warning( - f"A default cost type for model type {model_type} doesn't exist and could not be created in the {case.project.name} project. " - f"Response costs for case {case.name} won't be calculated for this model." + f"A default cost type for model type {model_type} doesn't exist and could not be " + f"created in the {case.project.name} project. Response costs for case {case.name} " + "won't be calculated for this model." ) return None @@ -169,12 +170,14 @@ def fetch_case_events( Args: case: The case to fetch events for. - activity: The activity to fetch events for. This defines the plugin event to fetch and how much response effort each event requires. + activity: The activity to fetch events for. This defines the plugin event to fetch and + how much response effort each event requires. oldest: The timestamp to start fetching events from. db_session: The database session. Returns: - list[tuple[datetime.timestamp, str | None]]: A list of tuples containing the timestamp and user_id of each event. + list[tuple[datetime.timestamp, str | None]]: A list of tuples containing the timestamp and + user_id of each event. """ plugin_instance = plugin_service.get_active_instance_by_slug( @@ -184,7 +187,8 @@ def fetch_case_events( ) if not plugin_instance: log.warning( - f"Cannot fetch cost model activity. Its associated plugin {activity.plugin_event.plugin.title} is not enabled." + f"Cannot fetch cost model activity. Its associated plugin " + f"{activity.plugin_event.plugin.title} is not enabled." ) return [] @@ -238,7 +242,8 @@ def update_case_participant_activities( ) if not case_response_cost: log.warning( - f"Cannot calculate case response cost for case {case.name}. No default case response cost type created or found." + f"Cannot calculate case response cost for case {case.name}. No default case response " + "cost type created or found." ) return @@ -314,56 +319,51 @@ def calculate_case_response_cost(case: Case, db_session: Session) -> int: return results -def get_participant_role_time_seconds(case: Case, participant_role: ParticipantRole) -> float: - """Calculates the time spent by a participant in a case role starting from a given time. - - The participant's time spent in the case role is adjusted based on the role's engagement multiplier. - - Args: - case: The case the participant is part of. - participant_role: The role of the participant. - start_at: Only time spent after this will be considered. - - Returns: - float: The time spent by the participant in the case role in seconds. - """ +def get_participant_role_time_seconds(case: Case, participant_role: ParticipantRole) -> int: + """Returns the time a participant has spent in a given role in seconds.""" + # Skip calculating cost for participants with the observer role if participant_role.role == ParticipantRoleType.observer: - # skip calculating cost for participants with the observer role return 0 - # we set the renounced_at default time to the current time - participant_role_renounced_at = datetime.now(tz=timezone.utc).replace(tzinfo=None) + # we get the time the participant has spent in the role so far + participant_role_renounced_at = datetime.now(tz=timezone.utc) + + if case.status not in [CaseStatus.new, CaseStatus.triage]: + # we set the renounced_at default time to the stable_at time if the stable_at time exists + if case.stable_at: + # Ensure stable_at is timezone-aware + stable_at = case.stable_at + if not stable_at.tzinfo: + stable_at = stable_at.replace(tzinfo=timezone.utc) + participant_role_renounced_at = stable_at + if participant_role.renounced_at: - participant_role_renounced_at = participant_role.renounced_at - elif case.status == CaseStatus.closed: - if case.closed_at: - participant_role_renounced_at = case.closed_at - elif case.status == CaseStatus.escalated: - if case.escalated_at: - participant_role_renounced_at = case.escalated_at - - # the time the participant has spent in the case role since the last case cost update - participant_role_time = participant_role_renounced_at - participant_role.assumed_at + # the participant left the conversation or got assigned another role + # Ensure renounced_at is timezone-aware for comparison + renounced_at = participant_role.renounced_at + if not renounced_at.tzinfo: + renounced_at = renounced_at.replace(tzinfo=timezone.utc) + + if renounced_at < participant_role_renounced_at: + # we use the role's renounced_at time if it happened before the + # case was marked as stable or closed + participant_role_renounced_at = renounced_at + + # Ensure assumed_at is timezone-aware + assumed_at = participant_role.assumed_at + if not assumed_at.tzinfo: + assumed_at = assumed_at.replace(tzinfo=timezone.utc) + + # we calculate the time the participant has spent in the role + participant_role_time = participant_role_renounced_at - assumed_at if participant_role_time.total_seconds() < 0: - # the participant was added after the case was closed/escalated return 0 - # we calculate the number of hours the participant has spent in the case role - participant_role_time_hours = participant_role_time.total_seconds() / SECONDS_IN_HOUR + # Apply engagement multiplier based on role + engagement_multiplier = get_engagement_multiplier(participant_role.role) + adjusted_time_seconds = int(participant_role_time.total_seconds() * engagement_multiplier) - # we make the assumption that participants only spend 8 hours a day working on the case, - # if the case goes past 24hrs - if participant_role_time_hours > HOURS_IN_DAY: - days, hours = divmod(participant_role_time_hours, HOURS_IN_DAY) - participant_role_time_hours = ((days * HOURS_IN_DAY) / 3) + hours - - # we make the assumption that participants spend more or less time based on their role - # and we adjust the time spent based on that - return ( - participant_role_time_hours - * SECONDS_IN_HOUR - * get_engagement_multiplier(participant_role.role) - ) + return adjusted_time_seconds def get_total_participant_roles_time_seconds(case: Case) -> int: diff --git a/src/dispatch/database/revisions/tenant/versions/2025-06-20_5ed5defd1a55.py b/src/dispatch/database/revisions/tenant/versions/2025-06-20_5ed5defd1a55.py new file mode 100644 index 000000000000..635c55e28005 --- /dev/null +++ b/src/dispatch/database/revisions/tenant/versions/2025-06-20_5ed5defd1a55.py @@ -0,0 +1,28 @@ +"""Add stable_at column to case table +Revision ID: 5ed5defd1a55 +Revises: 7fc3888c7b9a +Create Date: 2025-06-20 11:59:13.546032 + +""" + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = "5ed5defd1a55" +down_revision = "7fc3888c7b9a" +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column("case", sa.Column("stable_at", sa.DateTime(), nullable=True)) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_column("case", "stable_at") + # ### end Alembic commands ### diff --git a/src/dispatch/messaging/strings.py b/src/dispatch/messaging/strings.py index a791e7e2c3c4..b7e9e38a3895 100644 --- a/src/dispatch/messaging/strings.py +++ b/src/dispatch/messaging/strings.py @@ -57,6 +57,10 @@ class MessageType(DispatchEnum): CaseStatus.new: "This case is new and needs triaging.", CaseStatus.triage: "This case is being triaged.", CaseStatus.escalated: "This case has been escalated.", + CaseStatus.stable: ( + "This case is stable, the bulk of the investigation has been completed " + "or most of the risk has been mitigated." + ), CaseStatus.closed: "This case has been closed.", } diff --git a/src/dispatch/static/dispatch/src/case/CaseStatus.vue b/src/dispatch/static/dispatch/src/case/CaseStatus.vue index d4dd84d67bef..31a2095ec111 100644 --- a/src/dispatch/static/dispatch/src/case/CaseStatus.vue +++ b/src/dispatch/static/dispatch/src/case/CaseStatus.vue @@ -52,6 +52,7 @@ export default { New: "red", Triage: "orange", Escalated: "yellow", + Stable: "blue", Closed: "success", }[this.status] || "error" ) diff --git a/src/dispatch/static/dispatch/src/case/CaseStatusSelectGroup.vue b/src/dispatch/static/dispatch/src/case/CaseStatusSelectGroup.vue index dd26008c21d3..70d956cb3c92 100644 --- a/src/dispatch/static/dispatch/src/case/CaseStatusSelectGroup.vue +++ b/src/dispatch/static/dispatch/src/case/CaseStatusSelectGroup.vue @@ -53,7 +53,7 @@
- + + + +
+ {{ + status.label + }} +
+ +
+ {{ status.label }} +
+ {{ formatToUTC(status.tooltip) }} + {{ `Not yet ${status.label.toLowerCase()}` }} + +
@@ -127,7 +153,7 @@ const statuses = computed(() => [ name: "New", label: "Created", color: "red", - hoverClass: "hover-card-three", + hoverClass: "hover-card-four", sheetClass: "rounded-s-xl arrow", tooltip: props.modelValue.created_at, }, @@ -135,10 +161,18 @@ const statuses = computed(() => [ name: "Triage", label: "Triaged", color: "red", - hoverClass: "hover-card-two", + hoverClass: "hover-card-three", sheetClass: "arrow", tooltip: props.modelValue.triage_at, }, + { + name: "Stable", + label: "Stable", + color: "blue", + hoverClass: "hover-card-two", + sheetClass: "arrow", + tooltip: props.modelValue.stable_at, + }, { name: "Closed", label: "Closed", @@ -264,6 +298,10 @@ const isActiveStatus = (status) => { position: relative; z-index: 3; } +.hover-card-four { + position: relative; + z-index: 4; +} .dispatch-font { color: rgb(107, 111, 118) !important; diff --git a/src/dispatch/static/dispatch/src/case/DetailsTab.vue b/src/dispatch/static/dispatch/src/case/DetailsTab.vue index e5d8e2ee9919..b41e03fd2c48 100644 --- a/src/dispatch/static/dispatch/src/case/DetailsTab.vue +++ b/src/dispatch/static/dispatch/src/case/DetailsTab.vue @@ -129,9 +129,16 @@ + + + + + + + @@ -199,6 +206,7 @@ export default { statuses: [ { title: "New", value: "New" }, { title: "Triage", value: "Triage" }, + { title: "Stable", value: "Stable" }, { title: "Escalated", value: "Escalated" }, { title: "Closed", value: "Closed" }, ], @@ -233,6 +241,7 @@ export default { "selected.resolution_reason", "selected.resolution", "selected.signals", + "selected.stable_at", "selected.status", "selected.tags", "selected.title", diff --git a/src/dispatch/static/dispatch/src/case/Page.vue b/src/dispatch/static/dispatch/src/case/Page.vue index 3503582f3a1d..f8c6c3143907 100644 --- a/src/dispatch/static/dispatch/src/case/Page.vue +++ b/src/dispatch/static/dispatch/src/case/Page.vue @@ -97,6 +97,7 @@ const caseDefaults = { ticket: null, title: "", triage_at: null, + stable_at: null, updated_at: null, visibility: "", workflow_instances: null, diff --git a/src/dispatch/static/dispatch/src/case/TableExportDialog.vue b/src/dispatch/static/dispatch/src/case/TableExportDialog.vue index 512950ed8de1..dc18d54517b2 100644 --- a/src/dispatch/static/dispatch/src/case/TableExportDialog.vue +++ b/src/dispatch/static/dispatch/src/case/TableExportDialog.vue @@ -164,6 +164,7 @@ export default { allFields: [ { text: "Reported At", value: "reported_at", sortable: false }, { text: "Triage At", value: "triage_at", sortable: false }, + { text: "Stable At", value: "stable_at", sortable: false }, { text: "Escalated At", value: "escalated_at", sortable: false }, { text: "Closed At", value: "closed_at", sortable: false }, { text: "Name", value: "name", sortable: false }, diff --git a/src/dispatch/static/dispatch/src/dashboard/case/CaseDialogFilter.vue b/src/dispatch/static/dispatch/src/dashboard/case/CaseDialogFilter.vue index 43b850af4d47..9ccfe70e8afc 100644 --- a/src/dispatch/static/dispatch/src/dashboard/case/CaseDialogFilter.vue +++ b/src/dispatch/static/dispatch/src/dashboard/case/CaseDialogFilter.vue @@ -183,6 +183,7 @@ export default { "name", "project", "reported_at", + "stable_at", "status", "tags", "title", diff --git a/src/dispatch/static/dispatch/src/dashboard/case/CaseOverview.vue b/src/dispatch/static/dispatch/src/dashboard/case/CaseOverview.vue index 644d2c91e1a7..005c83157e27 100644 --- a/src/dispatch/static/dispatch/src/dashboard/case/CaseOverview.vue +++ b/src/dispatch/static/dispatch/src/dashboard/case/CaseOverview.vue @@ -31,6 +31,13 @@ sup-title="Cases Escalated" /> + + + 0 assert cost == expected_cost # Should be exactly the hourly rate for 1 hour at full engagement @@ -351,3 +350,71 @@ def test_update_case_response_cost( results = update_case_response_cost(case=case, db_session=session) assert results[CostModelType.new] > 0 assert results[CostModelType.classic] >= 0 + + +def test_case_cost_stops_at_stable_time( + case, session, participant, participant_role, case_cost_type +): + """Tests that case cost calculations stop at the stable_at time.""" + from datetime import datetime, timedelta, timezone + from dispatch.case_cost.service import ( + calculate_case_response_cost_classic, + get_participant_role_time_seconds, + ) + from dispatch.participant_role.models import ParticipantRoleType + from dispatch.case.enums import CostModelType, CaseStatus + + # Set up timestamps with exact timing + now = datetime.now(timezone.utc) + two_hours_ago = now - timedelta(hours=2) + one_hour_ago = now - timedelta(hours=1) + stable_time = one_hour_ago # Case was marked stable 1 hour ago + + # Set up participant role with exact timing + participant_role.role = ParticipantRoleType.assignee # Full engagement multiplier + participant_role.assumed_at = two_hours_ago.replace(tzinfo=None) + participant_role.renounced_at = now.replace(tzinfo=None) # Still active + + # Set up participant + participant.participant_roles = [participant_role] + case.participants = [participant] + + # Set up cost type for classic model + case_cost_type.model_type = CostModelType.classic + case_cost_type.project = case.project + + # Test 1: Case is active (no stable_at set) + case.status = CaseStatus.triage + case.stable_at = None + active_cost = calculate_case_response_cost_classic(case=case, db_session=session) + active_time = get_participant_role_time_seconds(case=case, participant_role=participant_role) + + assert active_cost > 0 + assert active_time > 0 + + # Test 2: Case is stable (stable_at set to 1 hour ago) + case.status = CaseStatus.stable + case.stable_at = stable_time + stable_cost = calculate_case_response_cost_classic(case=case, db_session=session) + stable_time_seconds = get_participant_role_time_seconds( + case=case, participant_role=participant_role + ) + + assert stable_cost > 0 + assert stable_time_seconds > 0 + assert stable_cost < active_cost # Cost should be less since it stopped at stable_at + assert stable_time_seconds < active_time # Time should be less since it stopped at stable_at + + # Test 3: Verify the time difference matches expected stable time + expected_stable_time = int((stable_time - two_hours_ago).total_seconds()) + assert stable_time_seconds == expected_stable_time + + # Test 4: Case was stable before participant joined (should be 0) + case.stable_at = two_hours_ago - timedelta(hours=1) # Stable before participant joined + early_stable_cost = calculate_case_response_cost_classic(case=case, db_session=session) + early_stable_time = get_participant_role_time_seconds( + case=case, participant_role=participant_role + ) + + assert early_stable_cost == 0 + assert early_stable_time == 0 diff --git a/tests/factories.py b/tests/factories.py index ebbe9447f82c..0033e649cd08 100644 --- a/tests/factories.py +++ b/tests/factories.py @@ -770,7 +770,7 @@ class CaseFactory(BaseFactory): description = FuzzyText() resolution = FuzzyText() resolution_reason = FuzzyChoice(["False Positive", "User Acknowledged"]) - status = FuzzyChoice(["New", "Triage", "Escalated", "Closed"]) + status = FuzzyChoice(["New", "Triage", "Escalated", "Stable", "Closed"]) project = SubFactory(ProjectFactory) case_priority = SubFactory(CasePriorityFactory) case_severity = SubFactory(CaseSeverityFactory) From 09f18b110268ea8211beea318753d74356650147 Mon Sep 17 00:00:00 2001 From: David Whittaker Date: Fri, 20 Jun 2025 15:42:09 -0700 Subject: [PATCH 2/3] ensure stable added to get_all_by_status --- src/dispatch/case/flows.py | 6 +----- src/dispatch/case_cost/service.py | 22 +++++++++++++++++----- tests/case/test_case_messaging.py | 4 +++- 3 files changed, 21 insertions(+), 11 deletions(-) diff --git a/src/dispatch/case/flows.py b/src/dispatch/case/flows.py index 75a9869d72e3..92dfddb6436a 100644 --- a/src/dispatch/case/flows.py +++ b/src/dispatch/case/flows.py @@ -350,11 +350,7 @@ def case_stable_create_flow(*, case_id: int, organization_slug: OrganizationSlug # we transition the case to the triage state case_triage_status_flow(case=case, db_session=db_session) - case = get(db_session=db_session, case_id=case_id) - case_stable_status_flow( - case=case, - db_session=db_session, - ) + case_stable_status_flow(case=case, db_session=db_session) @background_task diff --git a/src/dispatch/case_cost/service.py b/src/dispatch/case_cost/service.py index 442b31393df5..fb31499c1c4c 100644 --- a/src/dispatch/case_cost/service.py +++ b/src/dispatch/case_cost/service.py @@ -359,11 +359,23 @@ def get_participant_role_time_seconds(case: Case, participant_role: ParticipantR if participant_role_time.total_seconds() < 0: return 0 - # Apply engagement multiplier based on role - engagement_multiplier = get_engagement_multiplier(participant_role.role) - adjusted_time_seconds = int(participant_role_time.total_seconds() * engagement_multiplier) - - return adjusted_time_seconds + # we calculate the number of hours the participant has spent in the incident role + participant_role_time_hours = participant_role_time.total_seconds() / SECONDS_IN_HOUR + + # we make the assumption that participants only spend 8 hours a day working on the incident, + # if the incident goes past 24hrs + # TODO(mvilanova): adjust based on incident priority + if participant_role_time_hours > HOURS_IN_DAY: + days, hours = divmod(participant_role_time_hours, HOURS_IN_DAY) + participant_role_time_hours = ((days * HOURS_IN_DAY) / 3) + hours + + # we make the assumption that participants spend more or less time based on their role + # and we adjust the time spent based on that + return ( + participant_role_time_hours + * SECONDS_IN_HOUR + * get_engagement_multiplier(participant_role.role) + ) def get_total_participant_roles_time_seconds(case: Case) -> int: diff --git a/tests/case/test_case_messaging.py b/tests/case/test_case_messaging.py index be095a9fe515..9cd4286a69be 100644 --- a/tests/case/test_case_messaging.py +++ b/tests/case/test_case_messaging.py @@ -5,7 +5,9 @@ def test_case_messaging(session, case): case.status = CaseStatus.triage t_case = case_service.get_all_by_status( - db_session=session, project_id=case.project.id, statuses=[CaseStatus.new, CaseStatus.triage] + db_session=session, + project_id=case.project.id, + statuses=[CaseStatus.new, CaseStatus.triage, CaseStatus.stable], ) send_case_close_reminder(case=t_case[0], db_session=session) pass From 5280db8e192cffd7a56015471198d509f1ac857a Mon Sep 17 00:00:00 2001 From: David Whittaker <84562015+whitdog47@users.noreply.github.com> Date: Fri, 20 Jun 2025 15:56:11 -0700 Subject: [PATCH 3/3] Update src/dispatch/case_cost/service.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: David Whittaker <84562015+whitdog47@users.noreply.github.com> --- src/dispatch/case_cost/service.py | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/src/dispatch/case_cost/service.py b/src/dispatch/case_cost/service.py index fb31499c1c4c..e9dd6a087436 100644 --- a/src/dispatch/case_cost/service.py +++ b/src/dispatch/case_cost/service.py @@ -329,13 +329,28 @@ def get_participant_role_time_seconds(case: Case, participant_role: ParticipantR participant_role_renounced_at = datetime.now(tz=timezone.utc) if case.status not in [CaseStatus.new, CaseStatus.triage]: - # we set the renounced_at default time to the stable_at time if the stable_at time exists + # Determine the earliest relevant timestamp for cost calculation cut-off + timestamps = [] if case.stable_at: # Ensure stable_at is timezone-aware stable_at = case.stable_at if not stable_at.tzinfo: stable_at = stable_at.replace(tzinfo=timezone.utc) - participant_role_renounced_at = stable_at + timestamps.append(stable_at) + if case.escalated_at: + # Ensure escalated_at is timezone-aware + escalated_at = case.escalated_at + if not escalated_at.tzinfo: + escalated_at = escalated_at.replace(tzinfo=timezone.utc) + timestamps.append(escalated_at) + if case.closed_at: + # Ensure closed_at is timezone-aware + closed_at = case.closed_at + if not closed_at.tzinfo: + closed_at = closed_at.replace(tzinfo=timezone.utc) + timestamps.append(closed_at) + if timestamps: + participant_role_renounced_at = min(timestamps) if participant_role.renounced_at: # the participant left the conversation or got assigned another role