Details
Description
The OpenApi spec is currently missing any required and read-only information about payload properties.
For example, the POST /users endpoint reports the following sample value:
{ "creator": "string", "creationDate": "2018-02-11T14:19:38.905Z", "lastModifier": "string", "lastChangeDate": "2018-02-11T14:19:38.905Z", "key": "string", "type": "string", "realm": "string", "status": "string", "password": "string", "token": "string", "tokenExpireTime": "2018-02-11T14:19:38.905Z", "username": "string", "lastLoginDate": "2018-02-11T14:19:38.905Z", "changePwdDate": "2018-02-11T14:19:38.905Z", "failedLogins": 0, "securityQuestion": "string", "securityAnswer": "string", "suspended": true, "mustChangePassword": true }
which should be better instead
{ "realm": "string", "@class": "org.apache.syncope.common.lib.to.UserTO", "password": "string", "username": "string", "securityQuestion": "string", "securityAnswer": "string" }
(also note the Jackson's @class management).
Similar for models (see attachments as samples).