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

Update config.properties (#693 )
fix db version to reflect the most recent
2023-06-04 21:49:36 +02:00 · 2023-06-04 21:48:55 +02:00
2 changed files with 6 additions and 1 deletions
--- a/docs-web/src/main/java/com/sismics/docs/rest/resource/DocumentResource.java
+++ b/docs-web/src/main/java/com/sismics/docs/rest/resource/DocumentResource.java
@ -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
--- a/docs-web/src/prod/resources/config.properties
+++ b/docs-web/src/prod/resources/config.properties
@ -1,3 +1,3 @@
 api.current_version=${project.version}
 api.min_version=1.0
-db.version=27
+db.version=28
Author	SHA1	Message	Date
Julien Kirch	3fd5470eae	Add mention in the API doc that document endpoint returns the document's metadata (#695 )	2023-06-04 21:49:36 +02:00
Mario Voigt	39f96cbd28	Update config.properties (#693 ) fix db version to reflect the most recent	2023-06-04 21:48:55 +02:00