Fixes app management related swaggers

temp
inoshperera 2 years ago
parent c14047f913
commit 7235f84c3a

@ -88,7 +88,7 @@ public interface ArtifactDownloadAPI {
required = true) required = true)
@PathParam("tenantId") int tenantId, @PathParam("tenantId") int tenantId,
@ApiParam( @ApiParam(
name = "hash-value", name = "appHashValue",
value = "Hash value of the application release.", value = "Hash value of the application release.",
required = true) required = true)
@PathParam("appHashValue") String uuid, @PathParam("appHashValue") String uuid,

@ -41,8 +41,8 @@
<property name="host" value="localhost:9443"/> <property name="host" value="localhost:9443"/>
<property name="schemes" value="https" /> <property name="schemes" value="https" />
<property name="basePath" value="/api/application-mgt-publisher/v1.0"/> <property name="basePath" value="/api/application-mgt-publisher/v1.0"/>
<property name="title" value="Application Management Admin Service API Definitions"/> <property name="title" value="Application Artifact Management APIs"/>
<property name="contact" value="dev@wso2.org"/> <property name="contact" value="bizdev-group@entgra.io"/>
<property name="license" value="Apache 2.0"/> <property name="license" value="Apache 2.0"/>
<property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/> <property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/>
<property name="scan" value="true"/> <property name="scan" value="true"/>

@ -429,7 +429,8 @@ public interface ApplicationManagementPublisherAPI {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:update") @ExtensionProperty(name = SCOPE, value = "perm:app:publisher:update")
}) })
} },
nickname = "createCustomAppByAppWrapper"
) )
@ApiResponses( @ApiResponses(
value = { value = {
@ -679,7 +680,7 @@ public interface ApplicationManagementPublisherAPI {
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@ApiOperation( @ApiOperation(
consumes = MediaType.MULTIPART_FORM_DATA, consumes = MediaType.APPLICATION_JSON,
produces = MediaType.APPLICATION_JSON, produces = MediaType.APPLICATION_JSON,
httpMethod = "POST", httpMethod = "POST",
value = "Upload artifacts", value = "Upload artifacts",
@ -769,11 +770,11 @@ public interface ApplicationManagementPublisherAPI {
); );
@PUT @PUT
@Path("/ent-app-artifacts/{deviceType}/{appId}/{uuid}") @Path("/ent-app-artifact/{deviceType}/{uuid}")
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@ApiOperation( @ApiOperation(
consumes = MediaType.MULTIPART_FORM_DATA, consumes = MediaType.APPLICATION_JSON,
produces = MediaType.APPLICATION_JSON, produces = MediaType.APPLICATION_JSON,
httpMethod = "POST", httpMethod = "POST",
value = "Upload artifacts", value = "Upload artifacts",
@ -783,7 +784,8 @@ public interface ApplicationManagementPublisherAPI {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:update") @ExtensionProperty(name = SCOPE, value = "perm:app:publisher:update")
}) })
} },
nickname = "updateApplicationArtifactByDeviceTypeAndUUID"
) )
@ApiResponses( @ApiResponses(
value = { value = {
@ -851,7 +853,7 @@ public interface ApplicationManagementPublisherAPI {
}) })
Response updateEntAppRelease( Response updateEntAppRelease(
@ApiParam( @ApiParam(
name = "UUID", name = "uuid",
value = "Unique identifier of the ApplicationDTO Release", value = "Unique identifier of the ApplicationDTO Release",
required = true) required = true)
@PathParam("uuid") String applicationUUID, @PathParam("uuid") String applicationUUID,
@ -895,7 +897,7 @@ public interface ApplicationManagementPublisherAPI {
}) })
Response updatePubAppRelease( Response updatePubAppRelease(
@ApiParam( @ApiParam(
name = "UUID", name = "uuid",
value = "Unique identifier of the ApplicationDTO Release", value = "Unique identifier of the ApplicationDTO Release",
required = true) required = true)
@PathParam("uuid") String applicationUUID, @PathParam("uuid") String applicationUUID,
@ -939,7 +941,7 @@ public interface ApplicationManagementPublisherAPI {
}) })
Response updateWebAppRelease( Response updateWebAppRelease(
@ApiParam( @ApiParam(
name = "UUID", name = "uuid",
value = "Unique identifier of the ApplicationDTO Release", value = "Unique identifier of the ApplicationDTO Release",
required = true) required = true)
@PathParam("uuid") String applicationUUID, @PathParam("uuid") String applicationUUID,
@ -984,7 +986,7 @@ public interface ApplicationManagementPublisherAPI {
}) })
Response updateCustomAppRelease( Response updateCustomAppRelease(
@ApiParam( @ApiParam(
name = "UUID", name = "uuid",
value = "Unique identifier of the ApplicationDTO Release", value = "Unique identifier of the ApplicationDTO Release",
required = true) required = true)
@PathParam("uuid") String applicationUUID, @PathParam("uuid") String applicationUUID,
@ -1349,7 +1351,7 @@ public interface ApplicationManagementPublisherAPI {
}) })
Response addApplicationTags( Response addApplicationTags(
@ApiParam( @ApiParam(
name = "oldTagName", name = "appId",
value = "Existing Tag Name", value = "Existing Tag Name",
required = true) required = true)
@PathParam("appId") int appId, @PathParam("appId") int appId,

@ -309,7 +309,8 @@ public interface SPApplicationService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:service-provider:create") @ExtensionProperty(name = SCOPE, value = "perm:app:publisher:service-provider:create")
}) })
} },
nickname = "createEntAppForSP"
) )
Response createEntApp(@PathParam("identity-server-id") int identityServerId, Response createEntApp(@PathParam("identity-server-id") int identityServerId,
@PathParam("service-provider-id") String serviceProviderId, ApplicationWrapper app, @PathParam("service-provider-id") String serviceProviderId, ApplicationWrapper app,
@ -335,7 +336,8 @@ public interface SPApplicationService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:service-provider:create") @ExtensionProperty(name = SCOPE, value = "perm:app:publisher:service-provider:create")
}) })
} },
nickname = "createPubAppForSP"
) )
Response createPubApp(@PathParam("identity-server-id") int identityServerId, Response createPubApp(@PathParam("identity-server-id") int identityServerId,
@PathParam("service-provider-id") String serviceProviderId, PublicAppWrapper app, @PathParam("service-provider-id") String serviceProviderId, PublicAppWrapper app,
@ -358,7 +360,8 @@ public interface SPApplicationService {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = SCOPE, value = "perm:app:publisher:service-provider:create") @ExtensionProperty(name = SCOPE, value = "perm:app:publisher:service-provider:create")
}) })
} },
nickname = "createWebAppForSP"
) )
Response createWebApp(@PathParam("identity-server-id") int identityServerId, Response createWebApp(@PathParam("identity-server-id") int identityServerId,
@PathParam("service-provider-id") String serviceProviderId, WebAppWrapper app, @PathParam("service-provider-id") String serviceProviderId, WebAppWrapper app,

@ -44,8 +44,8 @@
<property name="host" value="localhost:9443"/> <property name="host" value="localhost:9443"/>
<property name="schemes" value="https" /> <property name="schemes" value="https" />
<property name="basePath" value="/api/application-mgt-publisher/v1.0"/> <property name="basePath" value="/api/application-mgt-publisher/v1.0"/>
<property name="title" value="Application Management Admin Service API Definitions"/> <property name="title" value="Application Management Publisher API Definitions"/>
<property name="contact" value="dev@wso2.org"/> <property name="contact" value="bizdev-group@entgra.io"/>
<property name="license" value="Apache 2.0"/> <property name="license" value="Apache 2.0"/>
<property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/> <property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/>
<property name="scan" value="true"/> <property name="scan" value="true"/>

@ -360,7 +360,8 @@ public interface ReviewManagementAPI {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = SCOPE, value = "perm:app:review:update") @ExtensionProperty(name = SCOPE, value = "perm:app:review:update")
}) })
} },
nickname = "deleteReviewComment"
) )
@ApiResponses( @ApiResponses(

@ -112,7 +112,7 @@ public interface SubscriptionManagementAPI {
}) })
Response performAppOperationForDevices( Response performAppOperationForDevices(
@ApiParam( @ApiParam(
name = "installationDetails", name = "uuid",
value = "The application ID and list of devices/users/roles", value = "The application ID and list of devices/users/roles",
required = true required = true
) )
@ -124,8 +124,8 @@ public interface SubscriptionManagementAPI {
) )
@PathParam("action") String action, @PathParam("action") String action,
@ApiParam( @ApiParam(
name = "installationDetails", name = "deviceIdentifiers",
value = "The application ID and list of devices/users/roles", value = "The list of device identifiers",
required = true required = true
) )
@Valid List<DeviceIdentifier> deviceIdentifiers, @Valid List<DeviceIdentifier> deviceIdentifiers,
@ -227,7 +227,7 @@ public interface SubscriptionManagementAPI {
}) })
Response performEntAppSubscriptionOnDevices( Response performEntAppSubscriptionOnDevices(
@ApiParam( @ApiParam(
name = "UUID", name = "uuid",
value = "The application UUID", value = "The application UUID",
required = true required = true
) )
@ -239,7 +239,7 @@ public interface SubscriptionManagementAPI {
) )
@PathParam("action") String action, @PathParam("action") String action,
@ApiParam( @ApiParam(
name = "installationDetails", name = "deviceIdentifiers",
value = "The list of device identifiers", value = "The list of device identifiers",
required = true required = true
) )
@ -329,7 +329,8 @@ public interface SubscriptionManagementAPI {
@Extension(properties = { @Extension(properties = {
@ExtensionProperty(name = SCOPE, value = "perm:app:subscription:uninstall") @ExtensionProperty(name = SCOPE, value = "perm:app:subscription:uninstall")
}) })
} },
nickname = "getAppInstalledDevicesByUUID"
) )
@ApiResponses( @ApiResponses(
value = { value = {

@ -45,7 +45,7 @@
<property name="schemes" value="https" /> <property name="schemes" value="https" />
<property name="basePath" value="/api/application-mgt-store/v1.0"/> <property name="basePath" value="/api/application-mgt-store/v1.0"/>
<property name="title" value="App Store Management Service API Definitions"/> <property name="title" value="App Store Management Service API Definitions"/>
<property name="contact" value="dev@wso2.org"/> <property name="contact" value="bizdev-group@entgra.io"/>
<property name="license" value="Apache 2.0"/> <property name="license" value="Apache 2.0"/>
<property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/> <property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/>
<property name="scan" value="true"/> <property name="scan" value="true"/>

Loading…
Cancel
Save