Re: In-depth REST documentation

That's fantastic! Has that been done for all the endpoints? -- Sent from: http://syncope-user.1051894.n5.nabble.com/

Re: In-depth REST documentation

The latest 2.0.8-SNAPSHOT now features the improvement required: see it in action at http://syncope-vm.apache.org:9080/syncope/swagger under Users > POST /users: -- Sent from:

Re: In-depth REST documentation

Hi, I see what you mean: the current Swagger spec does not include information about read-only and required properties; moreover, the class inheritance (enforced by Jackson as the "@class" property) is not clearly documented. I have opened https://issues.apache.org/jira/browse/SYNCOPE-1274 to

Re: In-depth REST documentation

It is a useful tool, but I have found that none of the sample calls ever work. For instance, to create a new user, the sample JSON does not have the @class property, which is required. -- Sent from: http://syncope-user.1051894.n5.nabble.com/

Re: In-depth REST documentation

I think that swagger is the best choice to find out the correct JSON request body. For example, to make user self operations, use [1]. Click on your preferred operation (UserSelf) and then click on top right "Try it out" button. You'll find some sample well-formed JSON values. You should

Re: In-depth REST documentation

I am aware of those resources. Of note is that documentation: - does not describe what fields are required and which are optional - does not mention requied fields such as "@class" - does not list values for certain constrained fields (such as "type") I am guessing that this list is my best hope

Re: In-depth REST documentation

Hi, please take a look at [1] and especially to swagger extension [2]. You can also be interested in Syncope playground environment at [3] and [4]. HTH, Andrea [1] https://syncope.apache.org/docs/index.html [2] https://syncope.apache.org/docs/reference-guide.html#swagger [3]

In-depth REST documentation

Hello, I wonder if there is some in-depth documentation for using the REST API for Syncope somewhere. It took me forever to realize that I needed to add an "@class" attribute to my JSON for self registration, and that it needed to have the value "org.apache.syncope.common.lib.to.UserTO". Is there