tr(apis): deprecate some old apis (#64)

* tr(cleanup): remove deprecated apis

* tenant
* theme
* profileEntry

* Integrate code review feedbacks

README.adoc

@@ -24,7 +24,7 @@ This repository structure was inspired by https://github.com/Redocly/create-open
 == Live Documentation
 
 The api descriptor file can be used to render documentation sites. Those sites have different rendering and may show different parts of the specification file.
-That's the reason why it is interessting to test and evaluate differents sites and rendering.
+That's the reason why it is interesting to test and evaluate different sites and rendering.
 
 You 'll need to install the https://github.com/redocly/openapi-cli[openapi-cli] to be able to work on the specification.
 

openapi/components/schemas/SystemTenant.yaml

@@ -5,7 +5,7 @@ properties:
     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

openapi/components/schemas/Tenant.yaml

@@ -1,5 +1,6 @@
 type: object
-description: ""
+deprecated: true
+description: "Since Bonita 7.12, tenant management is deprecated"
 properties:
   id:
     description: "id of the tenant"

openapi/components/schemas/TenantCreateRequest.yaml

@@ -1,4 +1,6 @@
 type: object
+deprecated: true
+description: "Since Bonita 7.12, tenant creation is deprecated"
 properties:
    name:
      description: "the name of the tenant"

openapi/components/schemas/TenantUpdateRequest.yaml

@@ -1,4 +1,6 @@
 type: object
+deprecated: true
+description: "Since Bonita 7.12, tenant update is deprecated"
 properties:
    name:
      description: "the name of the tenant"
@@ -13,8 +15,17 @@ properties:
      description: "the password"
      type: string
      format: password
+   icon:
+     description: "the path of the icon"
+     type: string
+   state:
+     description: "the tenant state"
+     type: string
+     enum: [ ACTIVATED, DEACTIVATED ]
 example:
    name: "MyTenant"
-   description: "My tenant"
+   description: "My new tenant description"
    username: "john"
-   password: "bpm"
+   password: "bpm"
+   icon: "/default.png"
+   state: "ACTIVATED"

openapi/components/schemas/ThemeCreateRequest.yaml

@@ -1,4 +1,6 @@
 type: object
+deprecated: true
+description: "Since Bonita 7.13, theme management is deprecated"
 properties:
    type:
      description: theme type

openapi/components/schemas/ThemeRestoreRequest.yaml

@@ -1,4 +1,6 @@
 type: object
+deprecated: true
+description: "Since Bonita 7.13, theme management is deprecated"
 properties:
    type:
      description: theme type

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.10
   title: Bonita HTTP API
   description:
     # Ignore IDE warnings

openapi/paths/API@platform@tenant.yaml

@@ -2,6 +2,7 @@ get:
   tags:
     - Tenant
   summary: Finds Tenants
+  deprecated: true
   description: |
     ![edition](https://img.shields.io/badge/edition-entreprise-blue)
 
@@ -10,6 +11,8 @@ get:
     - can order on `id`
     - can search on `displayName`
     - can filter on `displayName`
+    
+    Warning: Since Bonita 7.12, multi-tenancy is deprecated
 
   operationId: searchTenants
   parameters:
@@ -45,10 +48,13 @@ post:
   tags:
     - Tenant
   summary: Create the Tenant
+  deprecated: true
   description: |
     ![edition](https://img.shields.io/badge/edition-entreprise-blue)
 
-    Create the Tenant
+    Create the Tenant.
+    
+    Warning: Since Bonita 7.12, multi-tenancy is deprecated. Creating new tenants is strongly discouraged.
   operationId: createTenant
   requestBody:
     content:

openapi/paths/API@platform@tenant@{id}.yaml

@@ -2,10 +2,12 @@ get:
   tags:
     - Tenant
   summary: Finds the Tenant by ID
+  deprecated: true
   description: |
     ![edition](https://img.shields.io/badge/edition-entreprise-blue)
 
     Returns the single Tenant for the given ID
+    Warning: Since Bonita 7.12, multi-tenancy is deprecated
   operationId: getTenantById
   parameters:
     - description: ID of the Tenant to return
@@ -35,13 +37,16 @@ put:
   tags:
     - Tenant
   summary: Update the Tenant by ID
+  deprecated: true
   description: |
-    ![edition](https://img.shields.io/badge/edition-entreprise-blue)
+    ![edition](https://img.shields.io/badge/edition-entreprise-blue) ![edition](https://img.shields.io/badge/edition-community-brightgreen)
+
+    Update a Tenant
 
-    Update the Tenant for the given ID
+    Warning: Since Bonita 7.12, multi-tenancy is deprecated
   operationId: updateTenantById
   parameters:
-    - description: ID of the Tenant to return
+    - description: ID of the Tenant to update. In Subscription edition, it is mandatory; not in Community edition, as there is only one tenant
       in: path
       name: id
       required: true
@@ -71,6 +76,7 @@ delete:
   tags:
     - Tenant
   summary: Delete the Tenant by ID
+  deprecated: true
   description: |
     ![edition](https://img.shields.io/badge/edition-entreprise-blue)
 

openapi/paths/API@portal@profileEntry.yaml

@@ -2,12 +2,14 @@ get:
   tags:
     - ProfileEntry
   summary: Finds ProfileEntries
+  deprecated: true
   description: |
     Finds ProfileEntries with pagination params and filters
 
     - can search on `name`
     - can filter on `page`,`name` and `parent_id`
 
+    Warning: Since Bonita 7.13, ProfileEntry is deprecated
   operationId: searchProfileEntries
   parameters:
     - $ref: '../components/parameters/pageIndex.yaml'
@@ -41,8 +43,10 @@ post:
   tags:
     - ProfileEntry
   summary: Create the ProfileEntry
+  deprecated: true
   description: |
     Create the ProfileEntry
+    Warning: Since Bonita 7.13, ProfileEntry is deprecated
   operationId: createProfileEntry
   requestBody:
     content:

openapi/paths/API@portal@profileEntry@{id}.yaml

@@ -2,8 +2,10 @@ get:
   tags:
     - ProfileEntry
   summary: Finds the ProfileEntry by ID
+  deprecated: true
   description: |
     Returns the single ProfileEntry for the given ID
+    Warning: Since Bonita 7.13, ProfileEntry is deprecated
   operationId: getProfileEntryById
   parameters:
     - description: ID of the ProfileEntry to return
@@ -33,8 +35,10 @@ put:
   tags:
     - ProfileEntry
   summary: Update the ProfileEntry by ID
+  deprecated: true
   description: |
     Update the ProfileEntry for the given ID
+    Warning: Since Bonita 7.13, ProfileEntry is deprecated
   operationId: updateProfileEntryById
   parameters:
     - description: ID of the ProfileEntry to return
@@ -67,6 +71,7 @@ delete:
   tags:
     - ProfileEntry
   summary: Delete the ProfileEntry by ID
+  deprecated: true
   description: |
     Delete the single ProfileEntry for the given ID
   operationId: deleteProfileEntryById

openapi/paths/API@portal@theme.yaml

@@ -2,8 +2,10 @@ post:
   tags:
     - Theme
   summary: Create the Theme
+  deprecated: true
   description: |
     Create the Theme
+    Warning: Since Bonita 7.13, theme management is deprecated
   operationId: createTheme
   requestBody:
     content:

openapi/paths/API@portal@theme@unusedId.yaml

@@ -2,8 +2,10 @@ put:
   tags:
     - Theme
   summary: Restore default Theme
+  deprecated: true
   description: |
     Restore the default theme
+    Warning: Since Bonita 7.13, theme management is deprecated
   operationId: restoreTheme
   requestBody:
     content: