Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 76 additions & 1 deletion spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,13 @@ paths:
post:
summary: Send a notification to a trusted service
description: Should be used to be 'polite', e.g. to let the provider know that a user has removed the share.
parameters:
- name: notification
in: body
description: The JSON object to send a notification.
required: true
schema:
$ref: "#/definitions/NewNotification"
responses:
201:
description: Receiver succesfully received the notification and responds with the created unique identifier and datetime of the processed notification.
Expand Down Expand Up @@ -355,6 +362,42 @@ paths:
type: string
schema:
$ref: "#/definitions/Error"
/invitation/forward:
post:
summary: Forward information from invitation to the cloud provider.
description: Foo
parameters:
- name: invitation
in: body
description: The JSON object to send to the cloud provider with the invitaiton information.
required: true
schema:
$ref: "#/definitions/Invitation"
responses:
200:
description: Ok!
400:
description: Invalid token?
schema:
$ref: "#/definitions/Error"
/invitation/accept:
post:
summary: Accept an invitation to a shared document
description: Foo
parameters:
- name: invitation
in: body
description: The JSON object to notify OCM that an invitation has been accepted.
required: true
schema:
$ref: "#/definitions/AcceptInvitation"
responses:
200:
description: Auth ok!
400:
description: Invalid token?
schema:
$ref: "#/definitions/Error"
definitions:
400:
type: object
Expand Down Expand Up @@ -505,4 +548,36 @@ definitions:
href:
type: string
description: Link to this specific notification.
example: /notifications/9303
example: /notifications/9303
AcceptInvitation:
type: object
allOf:
- properties:
userId:
type: string # probably uuid?
description: Unique ID to identify the person accepting the invitation.
example: 9303
provider:
type: string # probably uuid?
description: Id to identify the provider
example: abc
token:
type: string # probably some other kind of token
description: Token received in the invitation
example: abc-123
senderProvider:
type: string # probably uuid?
description: Id to identify the provider of the sender
example: ddd
Invitation:
type: object
allOf:
- properties:
token:
type: string # probably some other kind of token
description: Token received in the invitation
example: abc-123
senderProvider:
type: string # probably uuid?
description: Id to identify the provider of the sender
example: ddd