Commit 5bcfd265 authored by Brian Long's avatar Brian Long
Browse files

Merge branch 'develop-acs6' into stable-acs6

parents 0e8d5227 0724ee4d
Loading
Loading
Loading
Loading
+2 −1
Original line number Diff line number Diff line
@@ -11,4 +11,5 @@ target
.factorypath

# Swagger Codegen
.swagger-Codegen
.swagger-codegen
.swagger-codegen-ignore
+0 −59
Original line number Diff line number Diff line
package com.inteligr8.alfresco.acs.api;

import com.inteligr8.alfresco.acs.model.AspectEntry;
import com.inteligr8.alfresco.acs.model.AspectPaging;
import com.inteligr8.alfresco.acs.model.Error;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import java.util.List;
import javax.ws.rs.*;

/**
 * Alfresco Content Services REST API
 *
 * <p>**Model API**  Provides access to the model features of Alfresco Content Services. 
 *
 */
@Path("/api/-default-/public/alfresco/versions/1")
@Api(value = "/api/-default-/public/alfresco/versions/1", description = "")
public interface AspectsApi  {

    /**
     * Get an aspect
     *
     * **Note:** This is available in Alfresco 7.0.0 and newer versions. Get information for aspect **aspectId**. 
     *
     */
    @GET
    @Path("/aspects/{aspectId}")
    @Consumes({ "application/json" })
    @Produces({ "application/json" })
    @ApiOperation(value = "Get an aspect", tags={  })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Successful response", response = AspectEntry.class),
        @ApiResponse(code = 400, message = "Invalid parameter: unknown aspectId scheme specified "),
        @ApiResponse(code = 401, message = "Authentication failed"),
        @ApiResponse(code = 404, message = "**aspectId** does not exist "),
        @ApiResponse(code = 200, message = "Unexpected error", response = Error.class) })
    public AspectEntry getAspect(@PathParam("aspectId") String aspectId);

    /**
     * List aspects
     *
     * **Note:** This is available in Alfresco 7.0.0 and newer versions.  Gets a list of aspects from the data dictionary. The System aspects will be ignored by default. &#x60;&#x60;&#x60;JSON {   \&quot;list\&quot;: {     \&quot;pagination\&quot;: {       \&quot;count\&quot;: 0,       \&quot;hasMoreItems\&quot;: true,       \&quot;totalItems\&quot;: 0,       \&quot;skipCount\&quot;: 0,       \&quot;maxItems\&quot;: 0     },     \&quot;entries\&quot;: [       {         \&quot;entry\&quot;: {           \&quot;associations\&quot;: [],           \&quot;mandatoryAspects\&quot;: [],           \&quot;includedInSupertypeQuery\&quot;: true,           \&quot;description\&quot;: \&quot;Titled\&quot;,           \&quot;isContainer\&quot;: false,           \&quot;model\&quot;: {               \&quot;id\&quot;: \&quot;cm:contentmodel\&quot;,               \&quot;author\&quot;: \&quot;Alfresco\&quot;,               \&quot;description\&quot;: \&quot;Alfresco Content Domain Model\&quot;,               \&quot;namespaceUri\&quot;: \&quot;http://www.alfresco.org/model/content/1.0\&quot;,               \&quot;namespacePrefix\&quot;: \&quot;cm\&quot;           },           \&quot;id\&quot;: \&quot;cm:titled\&quot;,           \&quot;title\&quot;: \&quot;Titled\&quot;,           \&quot;properties\&quot;: [             {               \&quot;id\&quot;: \&quot;cm:title\&quot;,               \&quot;title\&quot;: \&quot;Title\&quot;,               \&quot;description\&quot;: \&quot;Content Title\&quot;,               \&quot;dataType\&quot;: \&quot;d:mltext\&quot;,               \&quot;isMultiValued\&quot;: false,               \&quot;isMandatory\&quot;: false,               \&quot;isMandatoryEnforced\&quot;: false,               \&quot;isProtected\&quot;: false             },             {               ...             }           ]         }       },       {         \&quot;entry\&quot;: {           ...         }       },       {         \&quot;entry\&quot;: {           ...         }       },     ]   } } &#x60;&#x60;&#x60; 
     *
     */
    @GET
    @Path("/aspects")
    @Consumes({ "application/json" })
    @Produces({ "application/json" })
    @ApiOperation(value = "List aspects", tags={  })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Successful response", response = AspectPaging.class),
        @ApiResponse(code = 401, message = "Authentication failed"),
        @ApiResponse(code = 200, message = "Unexpected error", response = Error.class) })
    public AspectPaging listAspects(@QueryParam("where")String where, @QueryParam("skipCount")@DefaultValue("0") Integer skipCount, @QueryParam("maxItems")@DefaultValue("100") Integer maxItems, @QueryParam("include")List<String> include);
}
+13 −13
Original line number Diff line number Diff line
@@ -146,7 +146,7 @@ public interface AuditApi {
        @ApiResponse(code = 404, message = "**applicationId** does not exist           "),
        @ApiResponse(code = 501, message = "Audit is disabled for the system"),
        @ApiResponse(code = 200, message = "Unexpected error", response = Error.class) })
    public AuditEntryPaging listAuditEntriesForAuditApp(@PathParam("auditApplicationId") String auditApplicationId, @QueryParam("skipCount")@DefaultValue("0") Integer skipCount, @QueryParam("omitTotalItems")@DefaultValue("false") Boolean omitTotalItems, @QueryParam("orderBy")List<String> orderBy, @QueryParam("maxItems")@DefaultValue("100") Integer maxItems, @QueryParam("where")String where, @QueryParam("include")List<String> include, @QueryParam("fields")List<String> fields);
    public AuditEntryPaging listAuditEntriesForAuditApp(@PathParam("auditApplicationId") String auditApplicationId, @QueryParam("skipCount")@DefaultValue("0") Integer skipCount, @QueryParam("orderBy")List<String> orderBy, @QueryParam("maxItems")@DefaultValue("100") Integer maxItems, @QueryParam("where")String where, @QueryParam("include")List<String> include, @QueryParam("fields")List<String> fields);

    /**
     * List audit entries for a node
+4 −4
Original line number Diff line number Diff line
@@ -170,7 +170,7 @@ public interface GroupsApi {
    /**
     * List groups
     *
     * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Gets a list of groups.  You can use the **include** parameter to return additional information.  You can use the **where** parameter to filter the returned groups by **isRoot**. For example, the following **where** clause will return just the root groups:  &#x60;&#x60;&#x60; (isRoot&#x3D;true) &#x60;&#x60;&#x60;  The **where** parameter can also be used to filter by ***zone*** and ***displayName***. They may be combined with isRoot to narrow a result set even further.  For example, the following where clause will only return groups belonging to the &#x60;MY.ZONE&#x60; zone.  &#x60;&#x60;&#x60; where&#x3D;(zones in (&#39;MY.ZONE&#39;)) &#x60;&#x60;&#x60;  This may be combined with the isRoot filter, as shown below:  &#x60;&#x60;&#x60; where&#x3D;(isRoot&#x3D;false AND zones in (&#39;MY.ZONE&#39;)) &#x60;&#x60;&#x60; The following where clause will only return groups with displayName &#x60;MY.GROUP.NAME&#x60;.   &#x60;&#x60;&#x60; where&#x3D;(displayName in (&#39;MY.GROUP.NAME&#39;)) &#x60;&#x60;&#x60; This may be combined with the isRoot and zones filter, as shown below:  &#x60;&#x60;&#x60; where&#x3D;(isRoot&#x3D;false AND displayName in (&#39;MY.GROUP.NAME&#39;)) &#x60;&#x60;&#x60;  &#x60;&#x60;&#x60; where&#x3D;(zones in (&#39;MY.ZONE&#39;) AND displayName in (&#39;MY.GROUP.NAME&#39;)) &#x60;&#x60;&#x60;  &#x60;&#x60;&#x60; where&#x3D;(isRoot&#x3D;false AND zones in (&#39;MY.ZONE&#39;) AND displayName in (&#39;MY.GROUP.NAME&#39;)) &#x60;&#x60;&#x60;  ***Note:*** restrictions include * &#x60;AND&#x60; is the only supported operator when combining &#x60;isRoot&#x60;, &#x60;zones&#x60; and &#x60;displayName&#x60; filters * Only one zone is supported by the filter * Only one displayName is supported by the filter * The quoted zone name and displayName must be placed in parenthesis — a 400 error will result if these are omitted.  The default sort order for the returned list is for groups to be sorted by ascending displayName. You can override the default by using the **orderBy** parameter. You can specify one of the following fields in the **orderBy** parameter: * id * displayName 
     * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Gets a list of groups.   You can use the **include** parameter to return additional information.  You can use the **where** parameter to filter the returned groups by **isRoot**. For example, the following **where**  clause will return just the root groups:    &#x60;&#x60;&#x60; (isRoot&#x3D;true) &#x60;&#x60;&#x60;  The **where** parameter can also be used to filter by ***zone***. This may be combined with isRoot to narrow a result set even further. For example, the following where clause will only return groups belonging to the &#x60;MY.ZONE&#x60; zone.  &#x60;&#x60;&#x60; where&#x3D;(zones in (&#39;MY.ZONE&#39;)) &#x60;&#x60;&#x60;  This may be combined with the isRoot filter, as shown below:  &#x60;&#x60;&#x60; where&#x3D;(isRoot&#x3D;false AND zones in (&#39;MY.ZONE&#39;)) &#x60;&#x60;&#x60;  ***Note:*** restrictions include * &#x60;AND&#x60; is the only supported operator when combining &#x60;isRoot&#x60; and &#x60;zones&#x60; filters * Only one zone is supported by the filter * The quoted zone name must be placed in parenthesis — a 400 error will result if these are omitted.  The default sort order for the returned list is for groups to be sorted by ascending displayName. You can override the default by using the **orderBy** parameter. You can specify one of the following fields in the **orderBy** parameter: * id * displayName 
     *
     */
    @GET
+10 −10

File changed.

Preview size limit exceeded, changes collapsed.

Loading