Merge pull request #3736 from guusdk/api-documentation

Improving the generated REST API documentation
2017-02-20 15:30:32 +01:00
commit faf0e98665
@@ -42,6 +42,7 @@ import java.util.Map;
 /**
 * Base resource class for the admin REST api of one realm
 *
+ * @resource Attack Detection
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -73,6 +73,7 @@ import java.util.Map;
 import static javax.ws.rs.core.Response.Status.NOT_FOUND;

 /**
+ * @resource Authentication Management
 * @author Bill Burke
 */
 public class AuthenticationManagementResource {
@@ -62,6 +62,7 @@ import java.util.List;
 import java.util.Map;

 /**
+ * @resource Client Attribute Certificate
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -43,6 +43,7 @@ import java.util.LinkedList;
 import java.util.List;

 /**
+ * @resource Client Initial Access
 * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
 */
 public class ClientInitialAccessResource {
@@ -39,6 +39,7 @@ import org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy;
 import org.keycloak.services.clientregistration.policy.ClientRegistrationPolicyFactory;

 /**
+ * @resource Client Registration Policy
 * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>
 */
 public class ClientRegistrationPolicyResource {
@@ -82,6 +82,7 @@ import static java.lang.Boolean.TRUE;
 /**
 * Base resource class for managing one particular client of a realm.
 *
+ * @resource Clients
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -49,6 +49,7 @@ import java.util.Properties;
 import java.util.Set;

 /**
+ * @resource Client Role Mappings
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -47,6 +47,7 @@ import javax.ws.rs.core.UriInfo;
 /**
 * Base resource class for managing one particular client of a realm.
 *
+ * @resource Client Templates
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -46,6 +46,7 @@ import java.util.List;
 /**
 * Base resource class for managing a realm's client templates.
 *
+ * @resource Client Templates
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -58,6 +58,7 @@ import java.util.Properties;
 /**
 * Base resource class for managing a realm's clients.
 *
+ * @resource Clients
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -65,6 +65,7 @@ import java.util.Properties;
 import java.util.stream.Collectors;

 /**
+ * @resource Component
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -51,6 +51,7 @@ import java.util.Set;
 import org.keycloak.services.ErrorResponse;

 /**
+ * @resource Groups
 * @author Bill Burke
 */
 public class GroupResource {
@@ -42,6 +42,7 @@ import java.util.List;
 import org.keycloak.services.ErrorResponse;

 /**
+ * @resource Groups
 * @author Bill Burke
 */
 public class GroupsResource {
@@ -65,6 +65,7 @@ import java.util.List;
 import java.util.Map;

 /**
+ * @resource Identity Providers
 * @author Pedro Igor
 */
 public class IdentityProviderResource {
@@ -58,6 +58,7 @@ import java.util.Map;
 import static javax.ws.rs.core.Response.Status.BAD_REQUEST;

 /**
+ * @resource Identity Providers
 * @author Pedro Igor
 */
 public class IdentityProvidersResource {
@@ -36,6 +36,7 @@ import java.util.List;
 import java.util.Map;

 /**
+ * @resource Key
 * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
 */
 public class KeyResource {
@@ -55,6 +55,7 @@ import java.util.Properties;
 /**
 * Base resource for managing users
 *
+ * @resource Protocol Mappers
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -102,6 +102,7 @@ import java.util.regex.PatternSyntaxException;
 /**
 * Base resource class for the admin REST api of one realm
 *
+ * @resource Realms Admin
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -54,6 +54,7 @@ import java.util.List;
 /**
 * Top level resource for Admin REST API
 *
+ * @resource Realms Admin
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -45,6 +45,7 @@ import java.util.Set;
 /**
 * Sometimes its easier to just interact with roles by their ID instead of container/role-name
 *
+ * @resource Roles (by ID)
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -48,6 +48,7 @@ import java.util.List;
 import java.util.Set;

 /**
+ * @resource Roles
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -59,6 +59,7 @@ import java.util.Set;
 /**
 * Base resource for managing users
 *
+ * @resource Role Mapper
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -33,6 +33,7 @@ import java.util.List;
 import java.util.Set;

 /**
+ * @resource Roles
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -43,6 +43,7 @@ import java.util.List;
 import java.util.Set;

 /**
+ * @resource Scope Mappings
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -50,6 +50,7 @@ import java.util.Set;
 /**
 * Base class for managing the scope mappings of a specific client.
 *
+ * @resource Scope Mappings
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -46,6 +46,7 @@ import java.util.HashMap;
 import java.util.Map;

 /**
+ * @resource User Storage Provider
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */
@@ -107,6 +107,7 @@ import java.util.concurrent.TimeUnit;
 /**
 * Base resource for managing users
 *
+ * @resource Users
 * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
 * @version $Revision: 1 $
 */