Skip to content

Commit

Permalink
First draft of openapi spec for islandora events
Browse files Browse the repository at this point in the history
  • Loading branch information
joecorall committed Apr 25, 2024
1 parent 6567072 commit c8628c1
Showing 1 changed file with 109 additions and 0 deletions.
109 changes: 109 additions & 0 deletions client.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
openapi: 3.0.0
info:
title: scyllaridae Service
description: Microservice to process events for Islandora.
version: "1.0.0"
servers:
- url: 'http://scyllaridae:8080'
paths:
/:
put:
summary: Runs a command based on the mimetype in the event
description: Receives media and other related information, performs processing based on MIME type and provided arguments and streams output to the destination location.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessEvent'
responses:
'204':
description: Processing successful.
'400':
description: Bad request, possibly due to unsupported MIME type or malformed data.
'415':
description: Unsupported Media Type
'500':
description: Internal server error
components:
schemas:
ProcessEvent:
type: object
properties:
actor:
$ref: '#/components/schemas/Actor'
object:
$ref: '#/components/schemas/MediaObject'
attachment:
$ref: '#/components/schemas/Attachment'
type:
type: string
example: "Activity"
summary:
type: string
example: "Generate Derivative"
Actor:
type: object
properties:
id:
type: string
format: uri
MediaObject:
type: object
properties:
id:
type: string
format: uri
url:
type: array
items:
$ref: '#/components/schemas/Link'
isNewVersion:
type: boolean
Link:
type: object
properties:
name:
type: string
type:
type: string
enum: [Link]
href:
type: string
format: uri
mediaType:
type: string
rel:
type: string
Attachment:
type: object
properties:
type:
type: string
content:
$ref: '#/components/schemas/AttachmentContent'
mediaType:
type: string
AttachmentContent:
type: object
properties:
mimetype:
type: string
args:
type: string
source_uri:
type: string
format: uri
destination_uri:
type: string
format: uri
file_upload_uri:
type: string
format: uri
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: API-Key
security:
- ApiKeyAuth: []

0 comments on commit c8628c1

Please sign in to comment.