Merge pull request #61 from TharmiganK/lifecycle

Add Lifecycle Management documentation

Author: pcnfernando

Diff for: en/docs/api-management/lifecycle-management.md

@@ -0,0 +1,33 @@
+# Lifecycle Management
+
+API lifecycle management is an important aspect of API management. The API lifecycle consists of various states that an API passes through, from creation to retirement. In Devant, there are six distinct lifecycle states: `created`, `pre-released`, `published`, `blocked`, `deprecated`, and `retired`.
+
+By leveraging the various lifecycle states, API managers can optimize the development process and ensure that subscribers have access to the latest and most reliable APIs.
+
+## API lifecycle states
+
+The following lifecycle states are applicable to APIs in Devant:
+
+| **API lifecycle state** | **Use case** | **Corresponding action** |
+|-----------------------|------------|-----------|
+| `CREATED` | The API is created but is not ready for consumption.| The API is not visible to subscribers in the Developer Portal.|
+| `PRE-RELEASED` | A prototype is created for early promotion and consumer testing. You can deploy a new API or a new version of an existing API as a prototype to provide subscribers with an early implementation of the API.|The API is published to the Developer Portal as a pre-release.|
+| `PUBLISHED` | The API is ready for subscribers to view and subscribe to via the Developer Portal| The API is visible in the Developer Portal and is available for subscription.|
+| `BLOCKED` | Access to the API is temporarily blocked.| Runtime calls are blocked, and the API is not visible in the Developer Portal.|
+| `DEPRECATED` | The old version of an API is moved to this state when a newer version of the API is PUBLISHED.| The API is deployed and is available to existing subscribers. New subscriptions are disabled. Existing subscribers can continue to use it as usual until the API is retired.|
+| `RETIRED` | The API is no longer in use when it is in this state.| The API is unpublished and deleted from the Developer Portal.|
+
+## Manage the lifecycle of an API
+
+To change the lifecycle state of an API via the Devant Console, follow the instructions given below:
+
+!!! tip
+     You must have publishing privileges to manage the lifecycle states of an integration.
+
+1. Sign in to the [Devant Console](https://console.devant.dev/).
+2. Select the project.
+3. In the **Integrations** pane, click on the integration for which you want to manage the lifecycle.
+4. In the overview page, click **Lifecycle Status** to view the lifecycle management page.
+5. You will see the lifecycle state transition diagram indicating the current lifecycle state of the integration. Just above the lifecycle state transition diagram, The possible lifecycle states you can apply to the integration are displayed just above the lifecycle state transition diagram. Click on a required lifecycle state to apply it to the integration. For example, if an integration is in the `Created` state, you can click either `Pre-release` or `Publish`.
+
+   ![Lifecycle Management](../assets/img/api-management/lifecycle-management.png){.cInlineImage-full}

Diff for: en/docs/assets/img/api-management/lifecycle-management.png

@@ -2,7 +2,7 @@
 
 An Endpoint is a network-exposed function that resides within an integration. In Devant, **Integration Type** `Integration as API` exposes one or more endpoints. Each endpoint in an integration can have a service contract (OpenAPI, GraphQL SDL) associated with it. This contract is used to expose the endpoint to consumers. In the absence of a contract, Devant uses /* exposed on all HTTP verbs as the default contract to expose the service or the integration.
 
-Each endpoint exposed in a component is considered a single API. Therefore, Devant allows you to do API management per endpoint for a given component. For example, you can perform lifecycle management and configure security settings per endpoint in a given component.
+Each endpoint exposed in an integration is considered a single API. Therefore, Devant allows you to do API management per endpoint for a given integration. For example, you can perform lifecycle management and configure security settings per endpoint in a given integration.
 
 [//]: # (Todo: Uncomment the following after the required page is completed)
 [//]: # (See [Configure Endpoints](../develop-components/configure-endpoints.md) to learn how to configure endpoints when developing components in Devant.)

Diff for: en/docs/devant-concepts/endpoint.md

@@ -36,7 +36,7 @@ Devant roles are defined as follows:
 - **API Subscriber**: An API subscriber is a developer in a particular organization. An API subscriber can subscribe to an API, manage subscriptions, manage integrations, generate API keys, and manage API keys.
 - **Admin**: An administrator is responsible for all administration tasks, including user management, customizing the Developer Portal, managing projects, enabling analytics, managing domains, etc.
 - **Billing Admin**: Is responsible for billing administration that includes viewing tiers, creating and viewing organizations, managing invoices, viewing and creating subscriptions, and viewing and creating payment methods.
-- **Devant DevOps**: A Devant DevOps user is a user with access to the Devant DevOps portal, enabling them to actively manage, ensure dependable deployment, and monitor components.
+- **Devant DevOps**: A Devant DevOps user is a user with access to the Devant DevOps portal, enabling them to actively manage, ensure dependable deployment, and monitor integrations.
 - **Developer**: Users who develop, deploy, and manage integrations at scale. 
 - **External API subscriber**: External API subscribers are API consumers who have access only to the API Developer Portal. They can join an organization with the sole purpose of consuming APIs.
 - **Environment Manager (Deprecated)**: Manages deployment environments.

Diff for: en/docs/devant-concepts/organization.md

@@ -24,6 +24,6 @@ When you join the demo organization, you gain access to a comprehensive, read-on
 Key aspects you can explore include:
 
 - **Projects and integrations**: View the sample projects and their respective integrations, where each integration serves a distinct function within the customer rewards management system.
-- **Component details and architecture**: Understand the architecture by exploring how each integration is configured, including environment variables, API keys, and other dependencies that enable the required functionality.
+- **Integration details and architecture**: Understand the architecture by exploring how each integration is configured, including environment variables, API keys, and other dependencies that enable the required functionality.
 - **Build and deployment pipelines**: Inspect the build configurations and deployment history for each integration.
 - **Delivery insights, usage insights, and observability metrics**: Analyze metrics and insights for each integration.

Diff for: en/docs/devant-samples/explore-the-demo-organization.md

@@ -46,4 +46,4 @@ Once the database is added to the Marketplace, it can be consumed via a connecti
 !!! note
     To remove a database or cache that you added to the Marketplace, click the corresponding **Remove from Marketplace**. This action prevents new connections to the removed database, but existing connections remain unaffected.
 
-For details on using a database connection in your component, see [Use a Database Connection in Your Component](../sharing-and-reusing/use-a-database-connection-in-your-integration.md).
+For details on using a database connection in your integration, see [Use a Database Connection in Your Integration](../sharing-and-reusing/use-a-database-connection-in-your-integration.md).

Diff for: en/docs/manage-databases-and-caches/add-devant-managed-databases-and-caches-to-the-marketplace.md

@@ -1,7 +1,7 @@
 # Devant-Managed Databases, Vector Databases, and Caches
 
 Devant allows you to create PostgreSQL and MySQL databases as well as Devant-Managed Cache instances on all major cloud providers (AWS, Azure, GCP, and DigitalOcean) as fully Devant-managed platform services.
-These databases and caches can be seamlessly provisioned to offer persistence and caching capabilities for all your Devant components. Devant provides various service plans for each type, ranging from smaller instances for development purposes to production-grade databases with automatic backups and high-availability multi-nodes.
+These databases and caches can be seamlessly provisioned to offer persistence and caching capabilities for all your Devant integrations. Devant provides various service plans for each type, ranging from smaller instances for development purposes to production-grade databases with automatic backups and high-availability multi-nodes.
 
 !!! info "Note"
     - The capability to create Devant-managed databases, vector databases, and cache services is available only for paid Devant users.

Diff for: en/docs/manage-databases-and-caches/devant-managed-databases-and-caches.md

@@ -22,7 +22,7 @@ To create a connection to an API or a database, follow the step-by-step instruct
     7. Select an **Access Mode** and **Authentication Scheme** for the connection.
     8. Click **Create**.
 
-    This creates the connection and displays its details for each environment, along with an inline guide on how to use the connection in your component. 
+    This creates the connection and displays its details for each environment, along with an inline guide on how to use the connection in your integration. 
 
     !!! note
         During connection creation, secret values for the lowest environment are visible, allowing you to copy them for local use if necessary. Secret values for higher environments remain hidden to ensure security.
@@ -47,15 +47,15 @@ To create a connection to an API or a database, follow the step-by-step instruct
 
     Prerequisites:
 
-     - Create a Devant-managed database. For details, see [Devant-Managed Databases and Caches](../../manage-databases-and-caches/Devant-managed-databases-and-caches.md).
-     - Add the database to the Marketplace. For details, see [Add Devant-Managed Databases and Caches to the Marketplace](../../manage-databases-and-caches/add-Devant-managed-databases-and-caches-to-the-marketplace.md).
+     - Create a Devant-managed database. For details, see [Devant-Managed Databases and Caches](../manage-databases-and-caches/devant-managed-databases-and-caches.md).
+     - Add the database to the Marketplace. For details, see [Add Devant-Managed Databases and Caches to the Marketplace](../manage-databases-and-caches/add-devant-managed-databases-and-caches-to-the-marketplace.md).
 
     Follow these steps to create a connection to a Devant-managed database:
 
-    1. In the Devant Console, go to the top navigation menu and set the visibility level as [project](../../Devant-concepts/connections.md#project-connections) or [component](../../Devant-concepts/connections.md#component-connections) as follows: 
+    1. In the Devant Console, go to the top navigation menu and set the visibility level as [project](../devant-concepts/connections.md#project-connections) or [integration](../devant-concepts/connections.md#integration-connections) as follows: 
 
         - **Project Connection**: Select an organization and a project in that organization. 
-        - **Component Connection**: Select an organization, a project in that organization, and a component in the selected project. 
+        - **Integration Connection**: Select an organization, a project in that organization, and an integration in the selected project. 
 
     2. In the left navigation menu, click **Dependencies**  and then **Connections**. This page lists all the existing connections.
     3. Click **+Create**. This opens the Marketplace view where you can browse and search for services or databases.
@@ -71,9 +71,9 @@ To create a connection to an API or a database, follow the step-by-step instruct
 
         3. Click **Create**.  
 
-    This creates the connection and displays the database connection details for each environment, along with an inline guide on how to use the connection in your component. 
+    This creates the connection and displays the database connection details for each environment, along with an inline guide on how to use the connection in your integration. 
 
     !!! note
         During connection creation, secret values for the lowest environment are visible, allowing you to copy them for local use if necessary. Secret values for higher environments remain hidden to ensure security.
 
-    For step-by-step instructions on using a database in your component, see [Use a Database Connection in Your Component](./use-a-database-connection-in-your-integration.md).
+    For step-by-step instructions on using a database in your integration, see [Use a Database Connection in Your integration](./use-a-database-connection-in-your-integration.md).

Diff for: en/docs/sharing-and-reusing/create-a-connection.md

@@ -35,7 +35,7 @@ To integrate another service into your application, click the appropriate tab be
           | resourceRef      | A unique, readable identifier of the service being connected to.    |
 
 
-    2. If you've previously added a `connectionReferences` section under `dependencies`, append this as another item under `connectionReferences`. Upon deploying the component, Devant automatically creates a subscription if applicable and the necessary configurations to establish the connection will be injected into the Devant-defined environment variables.
+    2. If you've previously added a `connectionReferences` section under `dependencies`, append this as another item under `connectionReferences`. Upon deploying the integration, Devant automatically creates a subscription if applicable and the necessary configurations to establish the connection will be injected into the Devant-defined environment variables.
       
           The following table details the Devant-defined environment variables:
 
@@ -123,7 +123,7 @@ To integrate another service into your application, click the appropriate tab be
 
     2. Replace `<YOUR_ENV_VARIABLE_NAME_HERE>` with an appropriate environment variable name of your choice. If you have previously added a service reference section under `dependencies`, append this as another item under `serviceReferences`. 
 
-          Upon deploying the component, Devant automatically creates a subscription if applicable and populates the specified environment variables with actual values.
+          Upon deploying the integration, Devant automatically creates a subscription if applicable and populates the specified environment variables with actual values.
 
 
           The following table provides details on the configuration keys associated with the connection:
@@ -186,7 +186,7 @@ To integrate another service into your application, click the appropriate tab be
 
     2. Replace `<YOUR_ENV_VARIABLE_NAME_HERE>` with an appropriate environment variable name of your choice. If you have previously added an outbound service reference, append this as another item under `serviceReferences`. 
 
-          Upon deploying the component, Devant automatically creates a subscription if applicable and populates the specified environment variables with actual values.
+          Upon deploying the integration, Devant automatically creates a subscription if applicable and populates the specified environment variables with actual values.
 
 
           The following table provides details on the configuration keys associated with the connection:

Diff for: en/docs/sharing-and-reusing/use-a-connection-in-your-integration.md

@@ -35,7 +35,7 @@ To integrate a database into your application, click the appropriate tab below b
           | resourceRef      | A unique, readable identifier of the database being connected to.    |
 
 
-    2. If you've previously added a `connectionReferences` section under `dependencies`, append this as another item under `connectionReferences`. Upon deploying the component, the necessary configurations to establish the connection will be injected into Devant-defined environment variables.
+    2. If you've previously added a `connectionReferences` section under `dependencies`, append this as another item under `connectionReferences`. Upon deploying the integration, the necessary configurations to establish the connection will be injected into Devant-defined environment variables.
 
           The following table details the Devant-defined environment variables:
 
@@ -73,7 +73,7 @@ To integrate a database into your application, click the appropriate tab below b
 === "Component.yaml file (v1.0)"
 
     !!! note
-        The `component.yaml v1.0` file is considered legacy. For new components, we recommend using the latest version, `component.yaml v1.1`, which offers enhanced usability and features.
+        The `component.yaml v1.0` file is considered legacy. For new integrations, we recommend using the latest version, `component.yaml v1.1`, which offers enhanced usability and features.
 
     1. Copy and paste the snippet from the  developer guide into the `component.yaml` file.
 
@@ -111,7 +111,7 @@ To integrate a database into your application, click the appropriate tab below b
 
     2. Replace `<YOUR_ENV_VARIABLE_NAME_HERE>` with an appropriate environment variable name of your choice. If you have previously added a service reference section under `dependencies`, append this as another item under `serviceReferences`.
 
-          Upon deploying the component, Devant automatically populates the specified environment variables with actual values.
+          Upon deploying the integration, Devant automatically populates the specified environment variables with actual values.
 
           The following table provides details on the configuration keys associated with the connection:
 
@@ -136,7 +136,7 @@ To integrate a database into your application, click the appropriate tab below b
 === "Component-config.yaml file"
 
     !!! note
-        The `component-config.yaml` file is considered legacy. For new components, we recommend using the latest version, `component.yaml v1.1`, which offers enhanced usability and features.
+        The `component-config.yaml` file is considered legacy. For new integrations, we recommend using the latest version, `component.yaml v1.1`, which offers enhanced usability and features.
 
     1. Copy and paste the snippet from the  developer guide into the `component-config` file under the `spec` section.
 
@@ -173,7 +173,7 @@ To integrate a database into your application, click the appropriate tab below b
 
     2. Replace `<YOUR_ENV_VARIABLE_NAME_HERE>` with an appropriate environment variable name of your choice. If you have previously added an outbound service reference, append this as another item under `serviceReferences`.
 
-          Upon deploying the component, Devant automatically populates the specified environment variables with actual values.
+          Upon deploying the integration, Devant automatically populates the specified environment variables with actual values.
 
 
           The following table provides details on the configuration keys associated with the connection:
@@ -243,4 +243,4 @@ connection.connect((err) => {
 
 ```
 
-By following these steps, your component can interact with the Devant-managed database seamlessly.
+By following these steps, your integration can interact with the Devant-managed database seamlessly.

Diff for: en/docs/sharing-and-reusing/use-a-database-connection-in-your-integration.md

@@ -87,7 +87,7 @@ nav:
       - Resource Hierarchy: devant-concepts/resource-hierarchy.md
       - Organization: devant-concepts/organization.md
       - Project: devant-concepts/project.md
-      - Component: devant-concepts/integration.md
+      - Integration: devant-concepts/integration.md
       - Endpoint: devant-concepts/endpoint.md
       - CI/CD: devant-concepts/ci-cd.md
       - Deployment Tracks: devant-concepts/deployment-tracks.md
@@ -104,6 +104,8 @@ nav:
       - MySQL: manage-databases-and-caches/devant-managed-mysql-databases.md
       - Devant-Managed Cache: manage-databases-and-caches/devant-managed-caches.md
       - Add Devant-Managed Databases and Caches to the Marketplace: manage-databases-and-caches/add-devant-managed-databases-and-caches-to-the-marketplace.md
+  - API Management:
+      - Lifecycle Management: api-management/lifecycle-management.md
   - Testing: 
       - Test REST Endpoints via the OpenAPI Console: testing/test-rest-endpoints-via-the-openapi-console.md
   - Monitoring and Insights: