Commit f23722f3 authored by Patrick Barroca's avatar Patrick Barroca 😁
Browse files

more documentation

parent 54c44a8a
Pipeline #11903 passed with stage
in 47 seconds
...@@ -7,6 +7,52 @@ info: ...@@ -7,6 +7,52 @@ info:
servers: servers:
- url: /1.0 - url: /1.0
components:
schemas:
Media:
type: object
properties:
fullsize:
type: string
description: URL of fullsize media
format: uri
created_at:
type: string
description: Date of creation (2020-12-07 18:18:28)
format: date-time-mysql
updated_at:
type: string
description: Date of modification (2020-12-07 18:18:28)
format: date-time-mysql
type:
type: string
description: Type of media (only cover supported)
url:
type: string
description: Source URL from which pellicule downloaded this media (may require auth)
format: uri
provider:
type: string
description: Media provider name
MediaArray:
type: object
properties:
media:
type: array
description: List of media
items:
$ref: '#/components/schemas/Media'
responses:
MediaSuccess:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MediaArray'
paths: paths:
/media/isbn/{isbn}: /media/isbn/{isbn}:
get: get:
...@@ -17,6 +63,10 @@ paths: ...@@ -17,6 +63,10 @@ paths:
schema: schema:
type: string type: string
required: true required: true
responses:
'200':
$ref: '#/components/responses/MediaSuccess'
/media/ean/{ean}: /media/ean/{ean}:
get: get:
summary: Returns a list of media for an EAN summary: Returns a list of media for an EAN
...@@ -26,6 +76,10 @@ paths: ...@@ -26,6 +76,10 @@ paths:
schema: schema:
type: string type: string
required: true required: true
responses:
'200':
$ref: '#/components/responses/MediaSuccess'
/media/ark:/{naan}/{name}: /media/ark:/{naan}/{name}:
get: get:
summary: Returns a list of media for an ark url summary: Returns a list of media for an ark url
...@@ -40,5 +94,6 @@ paths: ...@@ -40,5 +94,6 @@ paths:
schema: schema:
type: string type: string
required: true required: true
responses:
'200':
$ref: '#/components/responses/MediaSuccess'
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment