{"openapi":"3.0.0","info":{"title":"","description":"","version":"0.0.0"},"servers":[{"url":"\/","description":""}],"paths":{"\/authentication_token":{"ref":"JWT Token","post":{"operationId":"postCredentialsItem","tags":["Token"],"responses":{"200":{"description":"Get JWT token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Token"}}}}},"summary":"Get JWT token to login.","description":"Generate new JWT Token","parameters":[],"requestBody":{"description":"Generate new JWT Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Credentials"}}},"required":false},"deprecated":false},"parameters":[]},"\/documents":{"get":{"operationId":"getDocumentCollection","tags":["Document"],"responses":{"200":{"description":"Document collection","content":{"application\/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/Document.jsonld"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","hydra:first":"string","hydra:last":"string","hydra:previous":"string","hydra:next":"string"}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Document"}}},"text\/html":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Document"}}}}}},"summary":"Retrieves the collection of Document resources.","description":"Retrieves the collection of Document resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"integer","default":1},"style":"form","explode":false,"allowReserved":false},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"integer","default":30,"minimum":0},"style":"form","explode":false,"allowReserved":false},{"name":"sword","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false}],"deprecated":false},"parameters":[]},"\/documents\/{id}":{"get":{"operationId":"getDocumentItem","tags":["Document"],"responses":{"200":{"description":"Document resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Document.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Document"}},"text\/html":{"schema":{"$ref":"#\/components\/schemas\/Document"}}}},"404":{"description":"Resource not found"}},"summary":"Retrieves a Document resource.","description":"Retrieves a Document resource.","parameters":[{"name":"id","in":"path","description":"Resource identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false},"put":{"operationId":"putDocumentItem","tags":["Document"],"responses":{"200":{"description":"Document resource updated","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Document.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Document"}},"text\/html":{"schema":{"$ref":"#\/components\/schemas\/Document"}}},"links":{"GetDocumentItem":{"operationId":"getDocumentItem","parameters":{"id":"$response.body#\/id"},"description":"The `id` value returned in the response can be used as the `id` parameter in `GET \/documents\/{id}`."}}},"400":{"description":"Invalid input"},"422":{"description":"Unprocessable entity"},"404":{"description":"Resource not found"}},"summary":"Replaces the Document resource.","description":"Replaces the Document resource.","parameters":[{"name":"id","in":"path","description":"Resource identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"requestBody":{"description":"The updated Document resource","content":{"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Document.jsonld"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Document"}},"text\/html":{"schema":{"$ref":"#\/components\/schemas\/Document"}}},"required":true},"deprecated":false},"parameters":[]}},"components":{"schemas":{"Document":{"type":"object","description":"Class Document","additionalProperties":false,"properties":{"id":{"type":"string"},"filename":{"type":"string"},"title":{"type":"string"},"ean":{"type":"string"},"content":{"type":"string"},"highlights":{"readOnly":true,"type":"array","items":{"type":"string"}}}},"Document.jsonld":{"type":"object","description":"Class Document","additionalProperties":false,"properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"type":"string"},"filename":{"type":"string"},"title":{"type":"string"},"ean":{"type":"string"},"content":{"type":"string"},"highlights":{"readOnly":true,"type":"array","items":{"type":"string"}}}},"Token":{"type":"object","properties":{"token":{"type":"string","readOnly":true}}},"Credentials":{"type":"object","properties":{"username":{"type":"string","example":"admin"},"password":{"type":"string","example":"admin"}}}},"responses":{},"parameters":{},"examples":{},"requestBodies":{},"headers":{},"securitySchemes":{"apiKey":{"type":"apiKey","description":"Value for the Authorization header parameter.","name":"Authorization","in":"header"}}},"security":[{"apiKey":[]}],"tags":[]}