Skip to content
Snippets Groups Projects
Verified Commit 52dfc920 authored by Christoph Metzger's avatar Christoph Metzger
Browse files

feat: Remove cases state handling from /cases endpoints (planning#511, planning#512)

parent 5aa0df45
No related branches found
No related tags found
1 merge request!169Remove bidirectional flag and case state from api (planning#506, planning#511)
Showing
with 15 additions and 175 deletions
'https://example.org/callback':
post:
summary: Callback für die Ankündigung des Schließens eines Vorgangs (case-closure-announcement)
description: >
Bevor ein Vorgang durch den Zustelldienst geschlossen wird, sendet dieser einen Callback an das sendende und empfangende System.
operationId: callback-case-closure-announcement
parameters:
- $ref: '../headers/hmac-cb-authentication.yaml'
- $ref: '../headers/hmac-cb-timestamp.yaml'
requestBody:
required: true
content:
application/json:
schema:
$ref: '../schemas/callbacks/callback-case-closure-announcement.yaml'
responses:
'200':
description: OK
get:
operationId: get-active-cases
summary: Aktive Vorgänge auflisten
operationId: get-cases
summary: Vorgänge auflisten
description: >
Mit diesem Request werden alle aktiven Vorgänge aufgelistet.
Mit diesem Request werden alle Vorgänge aufgelistet.
Bei Autorisierung als Onlinedienst (`sender`) werden alle Vorgänge gelistet, die vom API-Client auf Basis der OAuth Client-ID initiiert wurden.
Bei Autorisierung als Fachverfahren (`subscriber`) werden alle Vorgänge gelistet, die an dessen Destination-ID gesendet wurden.
tags:
......@@ -24,10 +24,10 @@ get:
content:
application/json:
schema:
$ref: '../../schemas/case/list-active-cases.yaml'
$ref: '../../schemas/case/list-cases.yaml'
examples:
Beispiel:
$ref: '../../examples/case/list-active-cases.yaml'
$ref: '../../examples/case/list-cases.yaml'
'401':
description: Unauthorized
content:
......
parameters:
- $ref: '../../parameters/caseId.yaml'
patch:
operationId: patch-case
summary: Vorgang partiell aktualisieren
description: Über diesen Endpunkt kann ein Vorgang partiell aktualisiert werden.
tags:
- Vorgangsverwaltung
security:
- OAuth2:
- 'subscribe:destination:<id>'
- 'send:region:DE<region-id>+send:service:<service-uri>'
- 'send:region:DE<region-id>'
requestBody:
required: true
content:
application/json:
schema:
$ref: '../../schemas/case/patch-case.yaml'
examples:
Vorgang offen halten:
$ref: '../../examples/case/patch-case-active.yaml'
Vorgang schließen:
$ref: '../../examples/case/patch-case-closed.yaml'
responses:
'202':
description: Accepted
content:
application/json:
schema:
$ref: '../../schemas/case/case.yaml'
examples:
Offener Vorgang:
$ref: '../../examples/case/case-active.yaml'
Geschlossener Vorgang:
$ref: '../../examples/case/case-closed.yaml'
'400':
description: Bad Request
content:
application/problem+json:
schema:
$ref: ../../schemas/error.yaml
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: ../../schemas/error.yaml
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: ../../schemas/error.yaml
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: ../../schemas/error.yaml
get:
summary: Vorgang abrufen
operationId: get-case
......@@ -80,10 +21,8 @@ get:
schema:
$ref: '../../schemas/case/case.yaml'
examples:
Offener Vorgang:
$ref: '../../examples/case/case-active.yaml'
Geschlossener Vorgang:
$ref: '../../examples/case/case-closed.yaml'
Vorgang:
$ref: '../../examples/case/case.yaml'
'400':
description: Bad Request
content:
......
......@@ -69,8 +69,6 @@ post:
$ref: '../../callbacks/new-events.yaml'
NewSubmissions:
$ref: '../../callbacks/new-submissions.yaml'
CaseClosureAnnouncement:
$ref: '../../callbacks/case-closure-announcement.yaml'
responses:
'201':
description: Created
......
......@@ -79,8 +79,6 @@ put:
$ref: '../../callbacks/new-events.yaml'
NewSubmissions:
$ref: '../../callbacks/new-submissions.yaml'
CaseClosureAnnouncement:
$ref: '../../callbacks/case-closure-announcement.yaml'
responses:
'200':
description: OK
......@@ -146,8 +144,6 @@ patch:
$ref: '../../callbacks/new-events.yaml'
NewSubmissions:
$ref: '../../callbacks/new-submissions.yaml'
CaseClosureAnnouncement:
$ref: '../../callbacks/case-closure-announcement.yaml'
responses:
'200':
description: OK
......
......@@ -72,8 +72,6 @@ post:
$ref: '../../callbacks/new-events.yaml'
NewReplies:
$ref: '../../callbacks/new-replies.yaml'
CaseClosureAnnouncement:
$ref: '../../callbacks/case-closure-announcement.yaml'
responses:
'201':
description: Created
......
value:
caseId: e89e107e-ed79-40e6-ad34-4e770f9df263
destinationId: 879ee109-a690-4db8-ab32-424284184d7d
caseState: closed
closeTime: '2022-07-07T14:33:44.000Z'
caseMessages:
- submissionId: ce75a6b8-d72f-4b94-b09e-af6be35bc2ae
value:
caseId: e89e107e-ed79-40e6-ad34-4e770f9df263
destinationId: 879ee109-a690-4db8-ab32-424284184d7d
caseState: active
closeTime: '2022-06-30T12:42:23.000Z'
caseMessages:
- submissionId: ce75a6b8-d72f-4b94-b09e-af6be35bc2ae
value:
caseState: active
value:
caseState: closed
title: Callback for the upcoming closure of a case
description: Callback, das über das bevorstehende Schließen eines Vorgangs informiert.
type: object
required:
- type
- cases
properties:
type:
title: Art des Callbacks
type: string
enum:
- https://schema.fitko.de/fit-connect/submission-api/callbacks/case-closure-announcement
cases:
title: Liste der zugehörigen Vorgänge
description: Liste der Vorgänge, die bald geschlossen werden.
type: array
minItems: 1
items:
$ref: '../case/case-for-closure.yaml'
title: Referenz auf Vorgang, der bald geschlossen wird
properties:
caseId:
$ref: "../../parameters/caseId.yaml#/schema"
required:
- caseId
title: Vorgangsstatus
type: string
description: >
Typischerweise ist ein Vorgang im Status `active`.
Neue Einreichungen und Antworten können an diesen angefügt werden.
Der Status `closed` weist auf einen geschlossenen Vorgang hin, an den z.B. keine Antworten mehr angefügt werden können.
enum:
- active
- closed
......@@ -7,12 +7,6 @@ properties:
$ref: "../../parameters/caseId.yaml#/schema"
destinationId:
$ref: "../../parameters/destinationId.yaml#/schema"
caseState:
$ref: "./case-state.yaml"
closeTime:
type: string
format: date-time
description: "Zeitpunkt, zu dem der Vorgang final geschlossen wird."
caseMessages:
type: array
items:
......@@ -20,6 +14,4 @@ properties:
required:
- caseId
- destinationId
- caseState
- closeTime
- caseMessages
title: Aktive Vorgänge
description: Aktive Vorgänge eines API-Clients oder Zustellpunktes
title: Vorgänge
description: Vorgänge eines API-Clients oder Zustellpunktes
type: object
required:
- cases
......@@ -7,18 +7,18 @@ properties:
count:
type: integer
format: int32
description: Anzahl zurückgegebener aktiver Vorgänge
description: Anzahl zurückgegebener Vorgänge
maximum: 500
minimum: 0
offset:
type: integer
format: int32
description: Offset in die Gesamtanzahl aktiver Vorgänge
description: Offset in die Gesamtanzahl Vorgänge
minimum: 0
totalCount:
type: integer
format: int32
description: Gesamtanzahl aktiver Vorgänge
description: Gesamtanzahl Vorgänge
minimum: 0
cases:
type: array
......
title: Partielle Aktualisierung eines Vorgangs
description: >
Wird `caseState` auf `true` gesetzt so wird der Vorgang offen gehalten.
Wird `caseState` auf `false` gesetzt so wird der Vorgang geschlossen.
type: object
required:
- caseState
properties:
caseState:
$ref: './case-state.yaml'
......@@ -174,8 +174,6 @@ components:
$ref: './schemas/callbacks/callback-new-events.yaml'
PatchDestination:
$ref: './schemas/patch-destination.yaml'
PatchCase:
$ref: './schemas/case/patch-case.yaml'
ServiceRegion:
$ref: './schemas/service-region.yaml'
SubmissionForPickup:
......@@ -222,8 +220,6 @@ components:
$ref: './schemas/replies/reply-for-pickup.yaml'
Case:
$ref: './schemas/case/case.yaml'
CaseForClosure:
$ref: './schemas/case/case-for-closure.yaml'
EventPayloadProblems:
$ref: './schemas/event-payload-problems.yaml'
EventPayloadAuthenticationTags:
......@@ -235,7 +231,7 @@ components:
EventPayloadAccept:
$ref: './schemas/event-payload-reject.yaml'
ActiveCases:
$ref: './schemas/case/list-active-cases.yaml'
$ref: './schemas/case/list-cases.yaml'
CaseMessages:
$ref: './schemas/case/case-message.yaml'
MinimalCase:
......@@ -246,10 +242,8 @@ components:
$ref: './examples/submission.yaml'
SubmissionCreated:
$ref: './examples/submission-created.yaml'
CaseActive:
$ref: './examples/case/case-active.yaml'
CaseClosed:
$ref: './examples/case/case-closed.yaml'
Case:
$ref: './examples/case/case.yaml'
CreateSubmission:
$ref: './examples/create-submission.yaml'
CreateDestination:
......@@ -292,8 +286,6 @@ components:
$ref: './examples/submit-submission.yaml'
callbacks:
CaseClosureAnnouncement:
$ref: './callbacks/case-closure-announcement.yaml'
NewEvents:
$ref: './callbacks/new-events.yaml'
NewSubmissions:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment