tr(api): deprecate api routes coming with version 9.0.0 (#138)

* tr(api): deprecate api routes coming with version 9.0.0 Those routes are depreciated with the new SCA approach where components are created or updated during the engine startup. * fix(api): add missing layoutId in ApplicationUpdateRequest object * tr(api): deprecate /APIv2/service/install * tr(api): deprecate GET /API/system/tenant * docs(api): add missing edition enterprise badge
bonitasoft · Oct 25, 2023 · c6278d4 · c6278d4
1 parent a4c1758
commit c6278d4
Show file tree

Hide file tree

Showing 27 changed files with 99 additions and 7 deletions.
diff --git 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"
+   themeId: "2"
+   layoutId: "17"
diff --git a/openapi/paths/API@bpm@actor@{id}.yaml b/openapi/paths/API@bpm@actor@{id}.yaml
@@ -35,8 +35,11 @@ put:
   tags:
     - Actor
   summary: Update the Actor by ID
+  deprecated: true
   description: |
     Update the Actor for the given ID
+
+    Warning: as of 9.0.0, updating an Actor using this API is deprecated.
   operationId: updateActorById
   parameters:
     - description: ID of the Actor to return

diff --git a/openapi/paths/API@bpm@process.yaml b/openapi/paths/API@bpm@process.yaml
@@ -43,9 +43,12 @@ post:
   tags:
     - Process
   summary: Create the Process
+  deprecated: true
   description: |
     Create the Process.
     A process resource is created using the content of a .bar file that has previously been uploaded, using the [processUpload servlet](#operation/uploadProcess), to get the process archive path.
+
+    Warning: as of 9.0.0, creating a process using this API is deprecated.
   operationId: createProcess
   requestBody:
     content:

diff --git a/openapi/paths/API@bpm@process@{id}.yaml b/openapi/paths/API@bpm@process@{id}.yaml
@@ -35,8 +35,11 @@ put:
   tags:
     - Process
   summary: Update the Process by ID
+  deprecated: true
   description: |
     Update the Process for the given ID
+
+    Warning: as of 9.0.0, updating a process using this API is deprecated.
   operationId: updateProcessById
   parameters:
     - description: ID of the Process to return

diff --git a/openapi/paths/API@bpm@processConnector@{id}@{connectorImplId}@{connectorImplVersion}.yaml b/openapi/paths/API@bpm@processConnector@{id}@{connectorImplId}@{connectorImplVersion}.yaml
@@ -2,8 +2,13 @@ put:
   tags:
     - Process
   summary: Update the Process Connector by Process ID
+  deprecated: true
   description: |
+    ![edition](https://img.shields.io/badge/edition-entreprise-blue)
+
     Update the ProcessConnector for the given ID
+
+    Warning: as of 9.0.0, updating a Process Connector using this API is deprecated.
   operationId: updateProcessConnectorByProcessId
   parameters:
     - description: ID of the process to update

diff --git a/openapi/paths/API@bpm@processParameter@{id}@{name}.yaml b/openapi/paths/API@bpm@processParameter@{id}@{name}.yaml
@@ -43,10 +43,13 @@ put:
   tags:
     - ProcessParameter
   summary: Update the ProcessParameter by ID
+  deprecated: true
   description: |
     ![edition](https://img.shields.io/badge/edition-entreprise-blue)
 
     Update the ProcessParameter for the given ID
+
+    Warning: as of 9.0.0, importing a Process parameter using this API is deprecated.
   operationId: updateProcessParameterById
   parameters:
     - description: ID of the process to get parameter from

diff --git a/openapi/paths/API@form@mapping@{id}.yaml b/openapi/paths/API@form@mapping@{id}.yaml
@@ -2,10 +2,13 @@ put:
   tags:
     - FormMapping
   summary: Update the FormMapping by ID
+  deprecated: true
   description: |
     ![edition](https://img.shields.io/badge/edition-entreprise-blue)
 
     Update the FormMapping for the given ID
+
+    Warning: as of 9.0.0, updating a Form Mapping using this API is deprecated.
   operationId: updateFormMappingById
   parameters:
     - description: ID of the FormMapping to return

diff --git a/openapi/paths/API@living@application-menu.yaml b/openapi/paths/API@living@application-menu.yaml
@@ -43,8 +43,11 @@ post:
   tags:
     - ApplicationMenu
   summary: New application menu item
+  deprecated: true
   description: |
     Create an application menu item
+
+    Warning: as of 9.0.0, creating an application menu item using this API is deprecated.
   operationId: createApplicationMenu
   requestBody:
     description: A partial representation of an application menu in JSON

diff --git a/openapi/paths/API@living@application-menu@{id}.yaml b/openapi/paths/API@living@application-menu@{id}.yaml
@@ -71,8 +71,12 @@ delete:
 put:
   tags:
     - ApplicationMenu
-  summary: Update a application menu by ID
-  description: Update a application menu for the given ID
+  summary: Update an application menu by ID
+  deprecated: true
+  description: |
+    Update an application menu for the given ID
+
+    Warning: as of 9.0.0, updating an application menu item using this API is deprecated.
   operationId: updateApplicationMenuById
   parameters:
     - description: ID of the application menu to return

diff --git a/openapi/paths/API@living@application-page.yaml b/openapi/paths/API@living@application-page.yaml
@@ -45,8 +45,11 @@ post:
   tags:
     - ApplicationPage
   summary: Create an application page
+  deprecated: true
   description: |
     Create an application page
+
+    Warning: as of 9.0.0, creating an application page using this API is deprecated.
   operationId: createApplicationPage
   requestBody:
     content:

diff --git a/openapi/paths/API@living@application.yaml b/openapi/paths/API@living@application.yaml
@@ -42,9 +42,12 @@ get:
 post:
   tags:
     - Application
-  summary: Create a living applications
+  summary: Create a living application
+  deprecated: true
   description: |
     Create a living applications
+
+    Warning: as of 9.0.0, creating a living application using this API is deprecated.
   operationId: createApplication
   requestBody:
     content:

diff --git a/openapi/paths/API@living@application@{id}.yaml b/openapi/paths/API@living@application@{id}.yaml
@@ -64,8 +64,11 @@ put:
   tags:
     - Application
   summary: Update a living application by ID
+  deprecated: true
   description: |
     Update a single application for the given ID
+
+    Warning: as of 9.0.0, updating a living application using this API is deprecated.
   operationId: updateApplicationById
   parameters:
     - description: ID of application to return

diff --git a/openapi/paths/API@portal@page.yaml b/openapi/paths/API@portal@page.yaml
@@ -7,7 +7,6 @@ get:
 
     - can search on `displayName`,`description`
     - can filter on `createdBy`,`contentType`
-
   operationId: searchPages
   parameters:
     - $ref: '../components/parameters/pageIndex.yaml'
@@ -42,9 +41,11 @@ post:
   tags:
     - Page
   summary: Create the Page
+  deprecated: true
   description: |
-    Upload the page content using the `portal/pageUpload` . This returns a temporary file name that can be used as input for this operation.
+    Upload the page content using the `portal/pageUpload`. This returns a temporary file name that can be used as input for this operation.
 
+    Warning: as of 9.0.0, creating a page using this API is deprecated.
   operationId: createPage
   requestBody:
     content:

diff --git a/openapi/paths/API@portal@page@{id}.yaml b/openapi/paths/API@portal@page@{id}.yaml
@@ -35,9 +35,11 @@ put:
   tags:
     - Page
   summary: Update the Page by ID
+  deprecated: true
   description: |
     Use the PUT method to update an existing custom page. To update a custom page, upload the new page content using the pageUpload servlet, which returns a temporary file name, and then call this API with the temporary file name.
 
+    Warning: as of 9.0.0, updating a page using this API is deprecated.
   operationId: updatePageById
   parameters:
     - description: ID of the Page to return

diff --git a/openapi/paths/API@portal@profile.yaml b/openapi/paths/API@portal@profile.yaml
@@ -43,8 +43,13 @@ post:
   tags:
     - Profile
   summary: Create the Profile
+  deprecated: true
   description: |
+    ![edition](https://img.shields.io/badge/edition-entreprise-blue)
+
     Create the Profile
+
+    Warning: as of 9.0.0, creating profiles using this API is deprecated.
   operationId: createProfile
   requestBody:
     content:

diff --git a/openapi/paths/API@portal@profile@{id}.yaml b/openapi/paths/API@portal@profile@{id}.yaml
@@ -35,8 +35,13 @@ put:
   tags:
     - Profile
   summary: Update the Profile by ID
+  deprecated: true
   description: |
+    ![edition](https://img.shields.io/badge/edition-entreprise-blue)
+
     Update the Profile for the given ID
+
+    Warning: as of 9.0.0, updating a profile using this API is deprecated.
   operationId: updateProfileById
   parameters:
     - description: ID of the Profile to return

diff --git a/openapi/paths/API@system@tenant@{id}.yaml b/openapi/paths/API@system@tenant@{id}.yaml
@@ -2,8 +2,11 @@ get:
   tags:
     - SystemTenant
   summary: Get the current Tenant
+  deprecated: true
   description: |
     Pause and resume tenant services in order to do maintenance on a tenant.
+
+    Warning: since Bonita 9.0.0, /API/system/tenant API resource is deprecated. Use /API/system/maintenance instead to retrieve the maintenance state.
   operationId: getSystemTenant
   parameters:
     - description: ID of the tenant
@@ -38,8 +41,8 @@ put:
   deprecated: true
   description: |
     Pause or resume the current tenant.
-    
-    Warning: Since Bonita 9.0, system/tenant API resource is deprecated. Use system/maintenance instead to enable the maintenance mode (same behavior as pausing the tenant).
+
+    Warning: since Bonita 9.0.0, /API/system/tenant API resource is deprecated. Use /API/system/maintenance instead to enable the maintenance mode (same behavior as pausing the tenant).
   operationId: updateSystemTenant
   parameters:
     - description: ID of the tenant

diff --git a/openapi/paths/API@tenant@bdm.yaml b/openapi/paths/API@tenant@bdm.yaml
@@ -27,8 +27,11 @@ post:
   tags:
     - BDM
   summary: Install a BDM
+  deprecated: true
   description: |
     Install a BDM
+
+    Warning: as of 9.0.0, importing a BDM using this API is deprecated.
   operationId: installBDM
   requestBody:
     content:

diff --git a/openapi/paths/APIv2@service@install.yaml b/openapi/paths/APIv2@service@install.yaml
@@ -2,10 +2,13 @@ post:
   tags:
     - Application
   summary: Upload an application configuration file
+  deprecated: true
   description: |
     ![edition](https://img.shields.io/badge/edition-entreprise-blue)
 
     Upload an application configuration file in the `bconf` format.
+
+    Warning: as of 9.0.0, uploading an application configuration file using this API is deprecated.
   operationId: uploadApplicationConfiguration
   requestBody:
     content:

diff --git a/openapi/paths/portal@applicationsUpload.yaml b/openapi/paths/portal@applicationsUpload.yaml
@@ -3,8 +3,11 @@ post:
     - Application
     - Upload
   summary: Upload a living application
+  deprecated: true
   description: |
     Upload application
+
+    Warning: as of 9.0.0, uploading a living application using the portal is deprecated.
   operationId: uploadApplication
   requestBody:
     content:

diff --git a/openapi/paths/portal@bdmAccessControlUpload.yaml b/openapi/paths/portal@bdmAccessControlUpload.yaml
@@ -3,10 +3,13 @@ post:
     - BDMAccessControl
     - Upload
   summary: Upload a BDM Access Control
+  deprecated: true
   description: |
     ![edition](https://img.shields.io/badge/edition-entreprise-blue)
 
     Upload BDM Access Control
+
+    Warning: as of 9.0.0, uploading a BDM Access Control using the portal is deprecated.
   operationId: uploadBDMAccessControl
   requestBody:
     content:

diff --git a/openapi/paths/portal@pageUpload.yaml b/openapi/paths/portal@pageUpload.yaml
@@ -3,8 +3,11 @@ post:
     - Page
     - Upload
   summary: Upload a Page
+  deprecated: true
   description: |
     Upload Page
+
+    Warning: as of 9.0.0, uploading a page using the portal is deprecated.
   operationId: uploadPage
   requestBody:
     content:

diff --git a/openapi/paths/portal@processUpload.yaml b/openapi/paths/portal@processUpload.yaml
@@ -2,9 +2,12 @@ post:
   tags:
     - Process
     - Upload
+  deprecated: true
   summary: Upload a bar file
   description: |
     Upload a bar file
+
+    Warning: as of 9.0.0, uploading a bar file using the portal is deprecated.
   operationId: uploadProcess
   requestBody:
     content:

diff --git a/openapi/paths/portal@profilesUpload.yaml b/openapi/paths/portal@profilesUpload.yaml
@@ -3,8 +3,13 @@ post:
     - Profile
     - Upload
   summary: Upload profiles
+  deprecated: true
   description: |
+    ![edition](https://img.shields.io/badge/edition-entreprise-blue)
+
     Upload profiles
+
+    Warning: as of 9.0.0, uploading profiles using the portal is deprecated.
   operationId: uploadprofiles
   requestBody:
     content:

diff --git a/openapi/paths/services@application@import.yaml b/openapi/paths/services@application@import.yaml
@@ -2,8 +2,11 @@ post:
   tags:
     - Application
   summary: Import a living application
+  deprecated: true
   description: |
     Import a single application
+
+    Warning: as of 9.0.0, importing a living application using this service is deprecated.
   operationId: importApplication
   requestBody:
     content:

diff --git a/openapi/paths/services@bdmAccessControl@install.yaml b/openapi/paths/services@bdmAccessControl@install.yaml
@@ -2,10 +2,13 @@ post:
   tags:
     - BDMAccessControl
   summary: Import a BDM Access Control
+  deprecated: true
   description: |
     ![edition](https://img.shields.io/badge/edition-entreprise-blue)
 
     Import a BDM Access Control
+
+    Warning: as of 9.0.0, importing a BDM Access Control using this service is deprecated.
   operationId: importBDMAccessControl
   requestBody:
     content:

diff --git a/openapi/paths/services@profile@import.yaml b/openapi/paths/services@profile@import.yaml
@@ -2,8 +2,11 @@ post:
   tags:
     - Profile
   summary: Import profiles
+  deprecated: true
   description: |
     Import profiles
+
+    Warning: as of 9.0.0, importing profiles using this service is deprecated.
   operationId: importProfiles
   requestBody:
     content: