Skip to content

Instantly share code, notes, and snippets.

@ioggstream

ioggstream/domibus-oas3.yaml

Last active April 19, 2019 10:31
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ioggstream/c27501238a732ff42ea3187139218009 to your computer and use it in GitHub Desktop.
Save ioggstream/c27501238a732ff42ea3187139218009 to your computer and use it in GitHub Desktop.
Download ZIP
edelivery domibus api
Raw
domibus-oas3.yaml
openapi: 3.0.0
servers:
- url: 'http://gist.githubusercontent.com/domibus'
- url: 'https://gist.githubusercontent.com/domibus'
info:
description: Domibus REST API documentation
version: v1
title: Domibus REST API documentation
license:
name: EUPL 1.2
url: 'https://joinup.ec.europa.eu/page/eupl-text-11-12'
tags:
- name: acknowledgement
- name: monitoring
- name: usermessage
paths:
/ext/messages/acknowledgments/delivered:
post:
tags:
- acknowledgement
summary: Create a message delivered acknowledgement
description: Acknowledges that a message has been delivered to the backend
operationId: acknowledgeMessageDelivered
responses:
'200':
description: successful operation
content:
'*/*':
schema:
$ref: '#/components/schemas/MessageAcknowledgementDTO'
security:
- basicAuth: []
requestBody:
$ref: '#/components/requestBodies/MessageAcknowledgementRequestDTO'
/ext/messages/acknowledgments/processed:
post:
tags:
- acknowledgement
summary: Create a message processed acknowledgement
description: Acknowledges that a message has been processed by the backend
operationId: acknowledgeMessageProcessed
responses:
'200':
description: successful operation
content:
'*/*':
schema:
$ref: '#/components/schemas/MessageAcknowledgementDTO'
security:
- basicAuth: []
requestBody:
$ref: '#/components/requestBodies/MessageAcknowledgementRequestDTO'
'/ext/messages/acknowledgments/{messageId}':
get:
tags:
- acknowledgement
summary: Get acknowledgements
description: Gets all acknowledgments associated to a message id
operationId: getAcknowledgedMessages
parameters:
- name: messageId
in: path
required: true
schema:
type: string
pattern: .+
responses:
'200':
description: successful operation
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/MessageAcknowledgementDTO'
security:
- basicAuth: []
'/ext/messages/usermessages/{messageId}':
get:
tags:
- usermessage
summary: Get user message
description: Retrieve the user message with the specified message id
operationId: getUserMessage
parameters:
- name: messageId
in: path
required: true
schema:
type: string
pattern: .+
responses:
'200':
description: successful operation
content:
'*/*':
schema:
$ref: '#/components/schemas/UserMessageDTO'
security:
- basicAuth: []
'/ext/monitoring/messages/enqueued/{messageId}/send':
put:
tags:
- monitoring
summary: Send enqueued message
description: Send a message which has a SEND_ENQUEUED status
operationId: sendEnqueuedMessage
parameters:
- name: messageId
in: path
required: true
schema:
type: string
pattern: .+
responses:
default:
description: successful operation
security:
- basicAuth: []
/ext/monitoring/messages/failed:
get:
tags:
- monitoring
summary: Get failed messages
description: Retrieve all the messages with the specified finalRecipient(if provided) that are currently in a SEND_FAILURE status
operationId: getFailedMessages
parameters:
- name: finalRecipient
in: query
required: false
schema:
type: string
responses:
'200':
description: successful operation
content:
'*/*':
schema:
type: array
items:
type: string
security:
- basicAuth: []
/ext/monitoring/messages/failed/restore:
post:
tags:
- monitoring
summary: Resend all messages with SEND_FAILURE status within a certain time interval
description: Resend all messages with SEND_FAILURE status within a certain time interval
operationId: restoreFailedMessages
responses:
'200':
description: successful operation
content:
'*/*':
schema:
type: array
items:
type: string
security:
- basicAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FailedMessagesCriteriaRO'
'/ext/monitoring/messages/failed/{messageId}':
delete:
tags:
- monitoring
summary: Delete failed message payload
description: Delete the payload of a message which has a SEND_FAILURE status
operationId: deleteFailedMessage
parameters:
- name: messageId
in: path
required: true
schema:
type: string
pattern: .+
responses:
default:
description: successful operation
security:
- basicAuth: []
'/ext/monitoring/messages/failed/{messageId}/elapsedtime':
get:
tags:
- monitoring
summary: Get failed message elapsed time
description: Retrieve the time that a message has been in a SEND_FAILURE status
operationId: getFailedMessageInterval
parameters:
- name: messageId
in: path
required: true
schema:
type: string
pattern: .+
responses:
'200':
description: successful operation
content:
'*/*':
schema:
type: integer
format: int64
security:
- basicAuth: []
'/ext/monitoring/messages/failed/{messageId}/restore':
put:
tags:
- monitoring
summary: Resend failed message
description: Resend a message which has a SEND_FAILURE status
operationId: restoreFailedMessage
parameters:
- name: messageId
in: path
required: true
schema:
type: string
pattern: .+
responses:
default:
description: successful operation
security:
- basicAuth: []
'/ext/monitoring/messages/{messageId}/attempts':
get:
tags:
- monitoring
summary: Get message attempts
description: Retrieve the history of the delivery attempts for a certain message
operationId: getMessageAttempts
parameters:
- name: messageId
in: path
required: true
schema:
type: string
pattern: .+
responses:
'200':
description: successful operation
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/MessageAttemptDTO'
security:
- basicAuth: []
components:
schemas:
AgreementRefDTO:
type: object
properties:
value:
type: string
type:
type: string
pmode:
type: string
CollaborationInfoDTO:
type: object
properties:
conversationId:
type: string
action:
type: string
agreementRef:
$ref: '#/components/schemas/AgreementRefDTO'
service:
$ref: '#/components/schemas/ServiceDTO'
DescriptionDTO:
type: object
properties:
value:
type: string
lang:
type: string
FailedMessagesCriteriaRO:
type: object
properties:
fromDate:
type: string
format: date-time
toDate:
type: string
format: date-time
FromDTO:
type: object
properties:
partyId:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/PartyIdDTO'
role:
type: string
MessageAcknowledgementDTO:
type: object
properties:
id:
type: integer
format: int32
messageId:
type: string
from:
type: string
to:
type: string
properties:
type: object
additionalProperties:
type: string
acknowledgeDate:
type: string
format: date-time
createDate:
type: string
format: date-time
createUser:
type: string
MessageAcknowledgementRequestDTO:
type: object
properties:
messageId:
type: string
acknowledgeDate:
type: string
format: date-time
properties:
type: object
additionalProperties:
type: string
MessageAttemptDTO:
type: object
properties:
messageId:
type: string
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
status:
type: string
enum:
- SUCCESS
- ABORT
- ERROR
error:
type: string
MessageInfoDTO:
type: object
properties:
timestamp:
type: string
format: date-time
messageId:
type: string
refToMessageId:
type: string
MessagePropertiesDTO:
type: object
properties:
property:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/PropertyDTO'
PartInfoDTO:
type: object
properties:
schema:
$ref: '#/components/schemas/SchemaDTO'
description:
$ref: '#/components/schemas/DescriptionDTO'
partProperties:
$ref: '#/components/schemas/PartPropertiesDTO'
href:
type: string
inBody:
type: boolean
mime:
type: string
PartPropertiesDTO:
type: object
properties:
property:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/PropertyDTO'
PartyIdDTO:
type: object
properties:
value:
type: string
type:
type: string
PartyInfoDTO:
type: object
properties:
from:
$ref: '#/components/schemas/FromDTO'
to:
$ref: '#/components/schemas/ToDTO'
PayloadInfoDTO:
type: object
properties:
partInfo:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/PartInfoDTO'
PropertyDTO:
type: object
properties:
value:
type: string
name:
type: string
type:
type: string
SchemaDTO:
type: object
properties:
location:
type: string
version:
type: string
namespace:
type: string
ServiceDTO:
type: object
properties:
value:
type: string
type:
type: string
ToDTO:
type: object
properties:
partyId:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/PartyIdDTO'
role:
type: string
UserMessageDTO:
type: object
properties:
messageInfo:
$ref: '#/components/schemas/MessageInfoDTO'
partyInfo:
$ref: '#/components/schemas/PartyInfoDTO'
collaborationInfo:
$ref: '#/components/schemas/CollaborationInfoDTO'
messageProperties:
$ref: '#/components/schemas/MessagePropertiesDTO'
payloadInfo:
$ref: '#/components/schemas/PayloadInfoDTO'
mpc:
type: string
requestBodies:
MessageAcknowledgementRequestDTO:
content:
application/json:
schema:
$ref: '#/components/schemas/MessageAcknowledgementRequestDTO'
securitySchemes:
basicAuth:
type: http
scheme: basic
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment