diff --git a/openapi/components/responses/ServerError.yaml b/openapi/components/responses/ServerError.yaml index c239080..81b5b3d 100644 --- a/openapi/components/responses/ServerError.yaml +++ b/openapi/components/responses/ServerError.yaml @@ -4,4 +4,4 @@ content: schema: $ref: '../schemas/Error.yaml' example: - message: "An unexpected error occured." \ No newline at end of file + message: "An unexpected error occurred." \ No newline at end of file diff --git a/openapi/components/schemas/ApplicationUpdateRequest.yaml b/openapi/components/schemas/ApplicationUpdateRequest.yaml index a90511a..c762237 100644 --- a/openapi/components/schemas/ApplicationUpdateRequest.yaml +++ b/openapi/components/schemas/ApplicationUpdateRequest.yaml @@ -21,9 +21,17 @@ properties: theme id for the application type: string + layoutId: + description: | + ![edition](https://img.shields.io/badge/edition-entreprise-blue) + + layout id for the application + type: string example: version: "1.0" profileId: "2" token: "myapp" displayName: "My app" - description: "My application description" \ No newline at end of file + description: "My application description" + themeId: "2" + layoutId: "17" \ No newline at end of file diff --git a/openapi/components/schemas/ProfileEntry.yaml b/openapi/components/schemas/ProfileEntry.yaml deleted file mode 100644 index 74538cd..0000000 --- a/openapi/components/schemas/ProfileEntry.yaml +++ /dev/null @@ -1,33 +0,0 @@ -type: object -description: "Profile entry" -properties: - id: - description: "profileEntry id" - type: string - icon: - description: "icon used in the portal to represent a profileEntry" - type: string - index: - description: "position in a menu" - type: string - profile_id: - description: "id of the profile that contains this profileEntry" - type: string - page: - description: "pageToken (menu name or menu item name) used in a portal menu to identify the page associated with the profileEntry" - type: string - description: - description: "description" - type: string - name: - description: "name of the profileEntry" - type: string - type: - description: "link (if menu item) | folder (if menu)" - type: string - isCustom: - description: " true | false " - type: boolean - parent_id: - description: "id or parent profileEntry if in a folder" - type: string \ No newline at end of file diff --git a/openapi/components/schemas/ProfileEntryCreateRequest.yaml b/openapi/components/schemas/ProfileEntryCreateRequest.yaml deleted file mode 100644 index 9143f2a..0000000 --- a/openapi/components/schemas/ProfileEntryCreateRequest.yaml +++ /dev/null @@ -1,30 +0,0 @@ -type: object -properties: - profile_id: - description: "id of the profile that contains this profileEntry" - type: string - page: - description: "pageToken (menu name or menu item name) used in a portal menu to identify the page associated with the profileEntry" - type: string - description: - description: "description" - type: string - name: - description: "name of the profileEntry" - type: string - type: - description: "link (if menu item) | folder (if menu)" - type: string - isCustom: - description: " true | false " - type: boolean - parent_id: - description: "id or parent profileEntry if in a folder" - type: string -example: - page: "tasklistingadmin" - parent_id: "0" - name: "Test menu" - profile_id: "102" - type: "link" - isCustom: false \ No newline at end of file diff --git a/openapi/components/schemas/ProfileEntryUpdateRequest.yaml b/openapi/components/schemas/ProfileEntryUpdateRequest.yaml deleted file mode 100644 index 9143f2a..0000000 --- a/openapi/components/schemas/ProfileEntryUpdateRequest.yaml +++ /dev/null @@ -1,30 +0,0 @@ -type: object -properties: - profile_id: - description: "id of the profile that contains this profileEntry" - type: string - page: - description: "pageToken (menu name or menu item name) used in a portal menu to identify the page associated with the profileEntry" - type: string - description: - description: "description" - type: string - name: - description: "name of the profileEntry" - type: string - type: - description: "link (if menu item) | folder (if menu)" - type: string - isCustom: - description: " true | false " - type: boolean - parent_id: - description: "id or parent profileEntry if in a folder" - type: string -example: - page: "tasklistingadmin" - parent_id: "0" - name: "Test menu" - profile_id: "102" - type: "link" - isCustom: false \ No newline at end of file diff --git a/openapi/components/schemas/SystemTenant.yaml b/openapi/components/schemas/SystemTenant.yaml index 709e63b..736f942 100644 --- a/openapi/components/schemas/SystemTenant.yaml +++ b/openapi/components/schemas/SystemTenant.yaml @@ -1,12 +1,8 @@ type: object -description: "" +description: "The current tenant state" properties: - id: - description: "system tenant id" - type: string paused: - description: "wether the system tenant is paused or not" + description: "whether the system tenant is paused or not" type: boolean example: - id: 1 paused: false \ No newline at end of file diff --git a/openapi/components/schemas/Tenant.yaml b/openapi/components/schemas/Tenant.yaml deleted file mode 100644 index cd0d889..0000000 --- a/openapi/components/schemas/Tenant.yaml +++ /dev/null @@ -1,38 +0,0 @@ -type: object -description: "" -properties: - id: - description: "id of the tenant" - type: string - creation: - description: "the creation date" - type: string - icon: - description: "the path of the icon" - type: string - name: - description: "the name of the tenant" - type: string - description: - description: "the description" - type: string - username: - description: "the username" - type: string - password: - description: "the password" - type: string - format: password - state: - description: "the tenant state" - type: string - enum: [ ACTIVATED, DEACTIVATED ] -example: - id: 1 - creation: "2014-12-04 15:46:46.256" - icon: "/default.png" - username: "" - description: "Default tenant" - name: "default" - state: "ACTIVATED" - password: "" \ No newline at end of file diff --git a/openapi/components/schemas/TenantCreateRequest.yaml b/openapi/components/schemas/TenantCreateRequest.yaml deleted file mode 100644 index 9ad4d2a..0000000 --- a/openapi/components/schemas/TenantCreateRequest.yaml +++ /dev/null @@ -1,20 +0,0 @@ -type: object -properties: - name: - description: "the name of the tenant" - type: string - description: - description: "the description" - type: string - username: - description: "the username" - type: string - password: - description: "the password" - type: string - format: password -example: - name: "MyTenant" - description: "My tenant" - username: "john" - password: "bpm" \ No newline at end of file diff --git a/openapi/components/schemas/TenantPauseRequest.yaml b/openapi/components/schemas/TenantPauseRequest.yaml index b65d69f..9058d78 100644 --- a/openapi/components/schemas/TenantPauseRequest.yaml +++ b/openapi/components/schemas/TenantPauseRequest.yaml @@ -1,7 +1,7 @@ type: object properties: paused: - description: "wether the system tenant should be paused or not" + description: "whether the system tenant should be paused or not" type: string example: paused: true \ No newline at end of file diff --git a/openapi/components/schemas/TenantUpdateRequest.yaml b/openapi/components/schemas/TenantUpdateRequest.yaml deleted file mode 100644 index 9ad4d2a..0000000 --- a/openapi/components/schemas/TenantUpdateRequest.yaml +++ /dev/null @@ -1,20 +0,0 @@ -type: object -properties: - name: - description: "the name of the tenant" - type: string - description: - description: "the description" - type: string - username: - description: "the username" - type: string - password: - description: "the password" - type: string - format: password -example: - name: "MyTenant" - description: "My tenant" - username: "john" - password: "bpm" \ No newline at end of file diff --git a/openapi/components/schemas/ThemeCreateRequest.yaml b/openapi/components/schemas/ThemeCreateRequest.yaml deleted file mode 100644 index e524245..0000000 --- a/openapi/components/schemas/ThemeCreateRequest.yaml +++ /dev/null @@ -1,12 +0,0 @@ -type: object -properties: - type: - description: theme type - type: string - enum: [portal, mobile] - zipFilePathportal: - description: tmp zip file Path as uploaded to portal - type: string -example: - type: "portal" - zipFilePathportal: "tmp_1939634566964075173.zip" \ No newline at end of file diff --git a/openapi/components/schemas/ThemeRestoreRequest.yaml b/openapi/components/schemas/ThemeRestoreRequest.yaml deleted file mode 100644 index f773a15..0000000 --- a/openapi/components/schemas/ThemeRestoreRequest.yaml +++ /dev/null @@ -1,8 +0,0 @@ -type: object -properties: - type: - description: theme type - type: string - enum: [ portal, mobile ] -example: - type: "portal" \ No newline at end of file diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml index c806b70..aa66e5d 100644 --- a/openapi/openapi.yaml +++ b/openapi/openapi.yaml @@ -3,7 +3,7 @@ info: license: name: GPL-v2.0 url: 'http://www.gnu.org/licenses/gpl-2.0.txt' - version: 0.0.9 + version: 0.0.11 title: Bonita HTTP API description: # Ignore IDE warnings @@ -95,17 +95,13 @@ x-tagGroups: tags: - PlatformAuthentication - Platform - - PlatformTenant - - Tenant - License - name: Portal tags: - Page - Profile - - ProfileEntry - ProfileMember - - Theme - Upload - name: System @@ -289,9 +285,6 @@ tags: - name: Platform x-displayName: Platform description: The Platform API resources require a platform session. In order to get one, log in as the platform administrator using the platform login service. - - name: PlatformTenant - x-displayName: PlatformTenant - description: PlatformTenant - name: Process x-displayName: Process description: Deploy and manage process definitions. In addition, you can instantiate a process, which will create a new process instance (case). @@ -313,9 +306,6 @@ tags: - name: Profile x-displayName: Profile description: Profile - - name: ProfileEntry - x-displayName: ProfileEntry - description: ProfileEntry - name: ProfileMember x-displayName: ProfileMember description: ProfileMember @@ -331,12 +321,6 @@ tags: - name: Task x-displayName: Task description: Task - - name: Tenant - x-displayName: Tenant - description: Handle the tenants (**Enterprise editions only**). This requires a platform session. Log in using the platform login service. - - name: Theme - x-displayName: Theme - description: Theme - name: TimerEventTrigger x-displayName: TimerEventTrigger description: TimerEventTrigger @@ -600,10 +584,6 @@ paths: $ref: './paths/platformlogoutservice.yaml' /API/platform/platform/unusedid: $ref: './paths/platform@platform@unusedid.yaml' - /API/platform/tenant: - $ref: './paths/API@platform@tenant.yaml' - /API/platform/tenant/{id}: - $ref: './paths/API@platform@tenant@{id}.yaml' /API/platform/license: $ref: './paths/API@platform@license.yaml' @@ -624,18 +604,10 @@ paths: $ref: './paths/API@portal@profile.yaml' /API/portal/profile/{id}: $ref: './paths/API@portal@profile@{id}.yaml' - /API/portal/profileEntry: - $ref: './paths/API@portal@profileEntry.yaml' - /API/portal/profileEntry/{id}: - $ref: './paths/API@portal@profileEntry@{id}.yaml' /API/portal/profileMember: $ref: './paths/API@portal@profileMember.yaml' /API/portal/profileMember/{id}: $ref: './paths/API@portal@profileMember@{id}.yaml' - /API/portal/theme: - $ref: './paths/API@portal@theme.yaml' - /API/portal/theme/unusedId: - $ref: './paths/API@portal@theme@unusedId.yaml' # ======================= # SYSTEM API # ======================= @@ -645,8 +617,8 @@ paths: $ref: './paths/API@system@i18ntranslation.yaml' /API/system/session/unusedId: $ref: "./paths/API@system@session@unusedId.yaml" - /API/system/tenant/{id}: - $ref: "./paths/API@system@tenant@{id}.yaml" + /API/system/tenant/unusedId: + $ref: "./paths/API@system@tenant@unusedId.yaml" /API/system/license/unusedid: $ref: "./paths/API@system@license@unusedid.yaml" /APIv2/service/install: diff --git a/openapi/paths/API@platform@tenant.yaml b/openapi/paths/API@platform@tenant.yaml deleted file mode 100644 index 176e44d..0000000 --- a/openapi/paths/API@platform@tenant.yaml +++ /dev/null @@ -1,75 +0,0 @@ -get: - tags: - - Tenant - summary: Finds Tenants - description: | - ![edition](https://img.shields.io/badge/edition-entreprise-blue) - - Finds Tenants with pagination params and filters - - - can order on `id` - - can search on `displayName` - - can filter on `displayName` - - operationId: searchTenants - parameters: - - $ref: '../components/parameters/pageIndex.yaml' - - $ref: '../components/parameters/pageCount.yaml' - - $ref: '../components/parameters/pageFilter.yaml' - - $ref: '../components/parameters/pageOrder.yaml' - - $ref: '../components/parameters/pageSearch.yaml' - responses: - '200': - description: "Success " - headers: - Content-Range: - schema: - type: integer - format: int64 - description: The total number of matching items - content: - application/json: - schema: - type: array - items: - $ref: '../components/schemas/Tenant.yaml' - '401': - $ref: '../components/responses/Unauthorized.yaml' - '403': - $ref: '../components/responses/Forbidden.yaml' - '400': - $ref: '../components/responses/BadRequest.yaml' - '5XX': - $ref: '../components/responses/ServerError.yaml' -post: - tags: - - Tenant - summary: Create the Tenant - description: | - ![edition](https://img.shields.io/badge/edition-entreprise-blue) - - Create the Tenant - operationId: createTenant - requestBody: - content: - application/json: - schema: - $ref: '../components/schemas/TenantCreateRequest.yaml' - description: Partial Tenant description - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '../components/schemas/Tenant.yaml' - description: "Success " - '401': - $ref: '../components/responses/Unauthorized.yaml' - '403': - $ref: '../components/responses/Forbidden.yaml' - '400': - $ref: '../components/responses/BadRequest.yaml' - '5XX': - $ref: '../components/responses/ServerError.yaml' - x-codegen-request-body-name: body diff --git a/openapi/paths/API@platform@tenant@{id}.yaml b/openapi/paths/API@platform@tenant@{id}.yaml deleted file mode 100644 index e32fcfe..0000000 --- a/openapi/paths/API@platform@tenant@{id}.yaml +++ /dev/null @@ -1,98 +0,0 @@ -get: - tags: - - Tenant - summary: Finds the Tenant by ID - description: | - ![edition](https://img.shields.io/badge/edition-entreprise-blue) - - Returns the single Tenant for the given ID - operationId: getTenantById - parameters: - - description: ID of the Tenant to return - in: path - name: id - required: true - schema: - type: string - responses: - '200': - description: "Success " - content: - application/json: - schema: - $ref: '../components/schemas/Tenant.yaml' - '401': - $ref: '../components/responses/Unauthorized.yaml' - '403': - $ref: '../components/responses/Forbidden.yaml' - '400': - $ref: '../components/responses/BadRequest.yaml' - '404': - $ref: '../components/responses/NotFound.yaml' - '5XX': - $ref: '../components/responses/ServerError.yaml' -put: - tags: - - Tenant - summary: Update the Tenant by ID - description: | - ![edition](https://img.shields.io/badge/edition-entreprise-blue) - - Update the Tenant for the given ID - operationId: updateTenantById - parameters: - - description: ID of the Tenant to return - in: path - name: id - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '../components/schemas/TenantUpdateRequest.yaml' - description: Partial Tenant description - required: true - responses: - '200': - $ref: '../components/responses/OK.yaml' - '401': - $ref: '../components/responses/Unauthorized.yaml' - '403': - $ref: '../components/responses/Forbidden.yaml' - '400': - $ref: '../components/responses/BadRequest.yaml' - '404': - $ref: '../components/responses/NotFound.yaml' - '5XX': - $ref: '../components/responses/ServerError.yaml' -delete: - tags: - - Tenant - summary: Delete the Tenant by ID - description: | - ![edition](https://img.shields.io/badge/edition-entreprise-blue) - - Delete the single Tenant for the given ID - operationId: deleteTenantById - parameters: - - description: ID of the Tenant to delete - in: path - name: id - required: true - schema: - type: string - responses: - '200': - $ref: '../components/responses/OK.yaml' - '401': - $ref: '../components/responses/Unauthorized.yaml' - '403': - $ref: '../components/responses/Forbidden.yaml' - '400': - $ref: '../components/responses/BadRequest.yaml' - '404': - $ref: '../components/responses/NotFound.yaml' - '5XX': - $ref: '../components/responses/ServerError.yaml' diff --git a/openapi/paths/API@portal@profileEntry.yaml b/openapi/paths/API@portal@profileEntry.yaml deleted file mode 100644 index 469aa83..0000000 --- a/openapi/paths/API@portal@profileEntry.yaml +++ /dev/null @@ -1,69 +0,0 @@ -get: - tags: - - ProfileEntry - summary: Finds ProfileEntries - description: | - Finds ProfileEntries with pagination params and filters - - - can search on `name` - - can filter on `page`,`name` and `parent_id` - - operationId: searchProfileEntries - parameters: - - $ref: '../components/parameters/pageIndex.yaml' - - $ref: '../components/parameters/pageCount.yaml' - - $ref: '../components/parameters/pageFilter.yaml' - - $ref: '../components/parameters/pageSearch.yaml' - responses: - '200': - description: "Success " - headers: - Content-Range: - schema: - type: integer - format: int64 - description: The total number of matching items - content: - application/json: - schema: - type: array - items: - $ref: '../components/schemas/ProfileEntry.yaml' - '401': - $ref: '../components/responses/Unauthorized.yaml' - '403': - $ref: '../components/responses/Forbidden.yaml' - '400': - $ref: '../components/responses/BadRequest.yaml' - '5XX': - $ref: '../components/responses/ServerError.yaml' -post: - tags: - - ProfileEntry - summary: Create the ProfileEntry - description: | - Create the ProfileEntry - operationId: createProfileEntry - requestBody: - content: - application/json: - schema: - $ref: '../components/schemas/ProfileEntryCreateRequest.yaml' - description: Partial ProfileEntry description - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '../components/schemas/ProfileEntry.yaml' - description: "Success " - '401': - $ref: '../components/responses/Unauthorized.yaml' - '403': - $ref: '../components/responses/Forbidden.yaml' - '400': - $ref: '../components/responses/BadRequest.yaml' - '5XX': - $ref: '../components/responses/ServerError.yaml' - x-codegen-request-body-name: body diff --git a/openapi/paths/API@portal@profileEntry@{id}.yaml b/openapi/paths/API@portal@profileEntry@{id}.yaml deleted file mode 100644 index 140def8..0000000 --- a/openapi/paths/API@portal@profileEntry@{id}.yaml +++ /dev/null @@ -1,92 +0,0 @@ -get: - tags: - - ProfileEntry - summary: Finds the ProfileEntry by ID - description: | - Returns the single ProfileEntry for the given ID - operationId: getProfileEntryById - parameters: - - description: ID of the ProfileEntry to return - in: path - name: id - required: true - schema: - type: string - responses: - '200': - description: "Success " - content: - application/json: - schema: - $ref: '../components/schemas/ProfileEntry.yaml' - '401': - $ref: '../components/responses/Unauthorized.yaml' - '403': - $ref: '../components/responses/Forbidden.yaml' - '400': - $ref: '../components/responses/BadRequest.yaml' - '404': - $ref: '../components/responses/NotFound.yaml' - '5XX': - $ref: '../components/responses/ServerError.yaml' -put: - tags: - - ProfileEntry - summary: Update the ProfileEntry by ID - description: | - Update the ProfileEntry for the given ID - operationId: updateProfileEntryById - parameters: - - description: ID of the ProfileEntry to return - in: path - name: id - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '../components/schemas/ProfileEntryUpdateRequest.yaml' - description: Partial ProfileEntry description - required: true - responses: - '200': - $ref: '../components/responses/OK.yaml' - '401': - $ref: '../components/responses/Unauthorized.yaml' - '403': - $ref: '../components/responses/Forbidden.yaml' - '400': - $ref: '../components/responses/BadRequest.yaml' - '404': - $ref: '../components/responses/NotFound.yaml' - '5XX': - $ref: '../components/responses/ServerError.yaml' -delete: - tags: - - ProfileEntry - summary: Delete the ProfileEntry by ID - description: | - Delete the single ProfileEntry for the given ID - operationId: deleteProfileEntryById - parameters: - - description: ID of the ProfileEntry to delete - in: path - name: id - required: true - schema: - type: string - responses: - '200': - $ref: '../components/responses/OK.yaml' - '401': - $ref: '../components/responses/Unauthorized.yaml' - '403': - $ref: '../components/responses/Forbidden.yaml' - '400': - $ref: '../components/responses/BadRequest.yaml' - '404': - $ref: '../components/responses/NotFound.yaml' - '5XX': - $ref: '../components/responses/ServerError.yaml' diff --git a/openapi/paths/API@portal@theme.yaml b/openapi/paths/API@portal@theme.yaml deleted file mode 100644 index f1ffce6..0000000 --- a/openapi/paths/API@portal@theme.yaml +++ /dev/null @@ -1,26 +0,0 @@ -post: - tags: - - Theme - summary: Create the Theme - description: | - Create the Theme - operationId: createTheme - requestBody: - content: - application/json: - schema: - $ref: '../components/schemas/ThemeCreateRequest.yaml' - description: Partial Theme description - required: true - responses: - '200': - $ref: '../components/responses/OK.yaml' - '401': - $ref: '../components/responses/Unauthorized.yaml' - '403': - $ref: '../components/responses/Forbidden.yaml' - '400': - $ref: '../components/responses/BadRequest.yaml' - '5XX': - $ref: '../components/responses/ServerError.yaml' - x-codegen-request-body-name: body diff --git a/openapi/paths/API@portal@theme@unusedId.yaml b/openapi/paths/API@portal@theme@unusedId.yaml deleted file mode 100644 index ee0706a..0000000 --- a/openapi/paths/API@portal@theme@unusedId.yaml +++ /dev/null @@ -1,28 +0,0 @@ -put: - tags: - - Theme - summary: Restore default Theme - description: | - Restore the default theme - operationId: restoreTheme - requestBody: - content: - application/json: - schema: - $ref: '../components/schemas/ThemeRestoreRequest.yaml' - - description: Partial Theme description - required: true - responses: - '200': - $ref: '../components/responses/OK.yaml' - '401': - $ref: '../components/responses/Unauthorized.yaml' - '403': - $ref: '../components/responses/Forbidden.yaml' - '400': - $ref: '../components/responses/BadRequest.yaml' - '404': - $ref: '../components/responses/NotFound.yaml' - '5XX': - $ref: '../components/responses/ServerError.yaml' diff --git a/openapi/paths/API@system@tenant@{id}.yaml b/openapi/paths/API@system@tenant@unusedId.yaml similarity index 77% rename from openapi/paths/API@system@tenant@{id}.yaml rename to openapi/paths/API@system@tenant@unusedId.yaml index 9ce9dcc..423e947 100644 --- a/openapi/paths/API@system@tenant@{id}.yaml +++ b/openapi/paths/API@system@tenant@unusedId.yaml @@ -3,18 +3,11 @@ get: - SystemTenant summary: Get the current Tenant description: | - Pause and resume tenant services in order to do maintenance on a tenant. + Get tenant status, pause and resume tenant services in order to do maintenance on a tenant. operationId: getSystemTenant - parameters: - - description: ID of the tenant - in: path - name: id - required: true - schema: - type: string responses: '200': - description: "Success " + description: "Success" content: application/json: schema: @@ -36,13 +29,6 @@ put: description: | Pause or resume the current tenant. operationId: updateSystemTenant - parameters: - - description: ID of the tenant - in: path - name: id - required: true - schema: - type: string requestBody: content: application/json: