vmario
/
docs
mirror of https://github.com/sismics/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add mention in the API doc that document endpoint returns the document's metadata (#695)

This commit is contained in:
Julien Kirch 2023-06-04 21:49:36 +02:00 committed by GitHub
parent 39f96cbd28
commit 3fd5470eae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs-web/src/main/java/com/sismics/docs/rest/resource/DocumentResource.java
View File

@ -143,6 +143,11 @@ public class DocumentResource extends BaseResource {
* @apiSuccess {String} files.version Zero-based version number
* @apiSuccess {String} files.mimetype MIME type
* @apiSuccess {String} files.create_date Create date (timestamp)
* @apiSuccess {Object[]} metadata List of metadata
* @apiSuccess {String} metadata.id ID
* @apiSuccess {String} metadata.name Name
* @apiSuccess {String="STRING","INTEGER","FLOAT","DATE","BOOLEAN"} metadata.type Type
* @apiSuccess {Object} metadata.value Value
* @apiError (client) NotFound Document not found
* @apiPermission none
* @apiVersion 1.5.0