diff --git a/en/docs/administration/configurations/configure-logs-router.md b/en/docs/administration/configurations/configure-logs-router.md index 64b9342ee..061eb3325 100644 --- a/en/docs/administration/configurations/configure-logs-router.md +++ b/en/docs/administration/configurations/configure-logs-router.md @@ -14,7 +14,7 @@ To enable the Router access logs, update the `values.yaml`'s `wso2.apk.dp.gatewa enable: true ``` -For the Advance Configuration, you can configure Router access logs by using the following configs. Router access logs related configurations are in the `log_config.toml` file, which is located in ConfigMap file located in the following file in the APK helm chart. +For the advanced configurations, you can configure Router access logs by using the following configs. Router access logs related configurations are in the `log_config.toml` file, which is located in ConfigMap file located in the following file in the APK helm chart. ```yaml apk/helm-charts/templates/data-plane/gateway-components/log-conf.yaml @@ -308,7 +308,7 @@ To enable the wire logs, update the `values.yaml`'s `wso2.apk.dp.gatewayRuntime. enable: true ``` -For the Advance Configurations, configure the wire logs, using the following configuration in the `log_config.toml` file, which is located in ConfigMap file located in the following file in the APK helm chart. +For the advanced configurations, configure the wire logs, using the following configuration in the `log_config.toml` file, which is located in ConfigMap file located in the following file in the APK helm chart. ```yaml apk/helm-charts/templates/data-plane/gateway-components/log-conf.yaml diff --git a/en/docs/assets/files/get-started/EmployeeServiceDefinition.json b/en/docs/assets/files/get-started/EmployeeServiceDefinition.json index e9551f726..68e74e623 100644 --- a/en/docs/assets/files/get-started/EmployeeServiceDefinition.json +++ b/en/docs/assets/files/get-started/EmployeeServiceDefinition.json @@ -12,7 +12,7 @@ } ], "paths": { - "/employee": { + "/employees": { "get": { "tags": [ "employee-controller" diff --git a/en/docs/control-plane/apk-as-gateway-in-apim/api-management/control-plane-create-and-deploy-graphql-apis.md b/en/docs/control-plane/apk-as-gateway-in-apim/api-management/control-plane-create-and-deploy-graphql-apis.md index fd65254a2..d92f30557 100644 --- a/en/docs/control-plane/apk-as-gateway-in-apim/api-management/control-plane-create-and-deploy-graphql-apis.md +++ b/en/docs/control-plane/apk-as-gateway-in-apim/api-management/control-plane-create-and-deploy-graphql-apis.md @@ -1,15 +1,15 @@ -1. Save and download the sample [StarWarsAPI.graphql](../../../assets/files/get-started/StarWarsAPI.graphql) file. This is the GraphQL SDL of the API that we will be using. +1. Download and save the sample [StarWarsAPI.graphql](../../../assets/files/get-started/StarWarsAPI.graphql) file. This is the GraphQL SDL of the API that we will be using. 2. Login to the Publisher Console [API Publisher](https://am.wso2.com/publisher) of the WSO2 API Manager. 3. Under the GraphQL option, use `Import GraphQL SDL` option. 4. Provide the GraphQL definition of the API that was downloaded in step 1 and click `Next`. 5. Provide the following information. - | Field | Sample value | - |----------|---------------------------------------------| - | Name | StarWarsAPI | - | Context | /starwars | - | Version | 1.0.0 | - | Endpoint | http://graphql-faker-service:9002/graphql | + | Field | Sample value | + | -------- | ----------------------------------------- | + | Name | StarWarsAPI | + | Context | /starwars | + | Version | 1.0.0 | + | Endpoint | http://graphql-faker-service:9002/graphql | 6. Select the APK Gateway and click Create. 7. Navigate to the Deploy section and click Deployments. diff --git a/en/docs/control-plane/apk-as-gateway-in-apim/apk-as-gateway-in-apim-qsg.md b/en/docs/control-plane/apk-as-gateway-in-apim/apk-as-gateway-in-apim-qsg.md index bdecc4cbc..a13781d0a 100644 --- a/en/docs/control-plane/apk-as-gateway-in-apim/apk-as-gateway-in-apim-qsg.md +++ b/en/docs/control-plane/apk-as-gateway-in-apim/apk-as-gateway-in-apim-qsg.md @@ -53,7 +53,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. !!! Note - Please refer to the [Advance Configuration for APIM](../apim-deploy.md) for more information. + Please refer to the [Advanced Configuration for APIM](../apim-deploy.md) for more information. ### Setup WSO2 APK Dataplane 1.2.0 @@ -85,7 +85,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. ``` !!! Note - Please refer to the [Advance Configuration for APK](../apk-deploy.md) for more information. + Please refer to the Advanced Configuration for APK for more information. ### Setup WSO2 APIM-APK Agent 1.2.0 @@ -114,7 +114,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. ``` !!! Note - Please refer to the [Advance Configuration for agent](../apim-apk-agent-deploy.md) for more information. + Please refer to the [Advanced Configuration for agent](../apim-apk-agent-deploy.md) for more information. ### Verify the deployment diff --git a/en/docs/control-plane/apk-as-gateway-in-apim/start-apk-cp-to-dp-k8s.md b/en/docs/control-plane/apk-as-gateway-in-apim/start-apk-cp-to-dp-k8s.md index e00aaa8bf..7e4ea8d8a 100644 --- a/en/docs/control-plane/apk-as-gateway-in-apim/start-apk-cp-to-dp-k8s.md +++ b/en/docs/control-plane/apk-as-gateway-in-apim/start-apk-cp-to-dp-k8s.md @@ -46,7 +46,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. 4. Install NGINX Ingress Controller. Please refer to the NGINX Ingress Controller documentation for more information. !!! Note - Please refer to the [Advance Configuration for APIM](../../../control-plane/apim-deploy/) for more information. + Please refer to the [Advanced Configuration for APIM](../../../control-plane/apim-deploy/) for more information. #### Setup WSO2 APK Dataplane 1.2.0 @@ -99,7 +99,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. ``` !!! Note - Please refer to the [Advance Configuration for APK](../../../control-plane/apk-deploy) for more information. + Please refer to the Advanced Configuration for APK for more information. #### Setup WSO2 APIM-APK Agent 1.2.0 @@ -128,7 +128,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. ``` !!! Note - Please refer to the [Advance Configuration for agent](../../../control-plane/apim-apk-agent-deploy) for more information. + Please refer to the [Advanced Configuration for agent](../../../control-plane/apim-apk-agent-deploy) for more information. #### Verify the deployment diff --git a/en/docs/control-plane/apk-as-gateway-in-apim/start-apk-cp-to-dp-vms.md b/en/docs/control-plane/apk-as-gateway-in-apim/start-apk-cp-to-dp-vms.md index 83532bc31..a77e34886 100644 --- a/en/docs/control-plane/apk-as-gateway-in-apim/start-apk-cp-to-dp-vms.md +++ b/en/docs/control-plane/apk-as-gateway-in-apim/start-apk-cp-to-dp-vms.md @@ -21,7 +21,7 @@ Add a hostname mapping to the ```/etc/hosts``` file as follows. Setup WSO2 API Manager 4.3.0 in VM. 1. Refer to the [APIM Deployment Guide](https://apim.docs.wso2.com/en/latest/install-and-setup/install/installation-options/#2-dockerdocker-compose) to deploy the APIM 4.3.0 in a VM. -2. Change the configurations in the ```deployment.toml``` file in the APIM 4.3.0 VM refer to the [Advance Configuration for APIM](../../../control-plane/apim-deploy/) for more information. +2. Change the configurations in the ```deployment.toml``` file in the APIM 4.4.0 VM refer to the [Advanced Configuration for APIM](../../../control-plane/apim-deploy/) for more information. #### Setup WSO2 APK Dataplane 1.2.0 diff --git a/en/docs/control-plane/start-apk-dp-to-cp-vms.md b/en/docs/control-plane/start-apk-dp-to-cp-vms.md index 96fd13e89..6e689eefc 100644 --- a/en/docs/control-plane/start-apk-dp-to-cp-vms.md +++ b/en/docs/control-plane/start-apk-dp-to-cp-vms.md @@ -21,7 +21,7 @@ Add a hostname mapping to the ```/etc/hosts``` file as follows. Setup WSO2 API Manager 4.3.0 in VM. 1. Refer to the [APIM Deployment Guide](https://apim.docs.wso2.com/en/latest/install-and-setup/install/installation-options/#2-dockerdocker-compose) to deploy the APIM 4.3.0 in a VM. -2. Change the configurations in the ```deployment.toml``` file in the APIM 4.3.0 VM refer to the [Advance Configuration for APIM](../../../control-plane/apim-deploy/) for more information. +2. Change the configurations in the ```deployment.toml``` file in the APIM 4.3.0 VM refer to the [Advanced Configuration for APIM](../../../control-plane/apim-deploy/) for more information. #### Setup WSO2 APK Dataplane 1.2.0 @@ -74,7 +74,7 @@ Setup WSO2 API Manager 4.3.0 in VM. helm repo update ``` -3. Change the configurations in the ```values.yaml``` file in the APIM APK Agent Helm Chart, refer to the [Advance Configuration for agent](../../../control-plane/apim-apk-agent-deploy) for more information. +3. Change the configurations in the ```values.yaml``` file in the APIM APK Agent Helm Chart, refer to the [Advanced Configuration for agent](../../../control-plane/apim-apk-agent-deploy) for more information. 4. Install the APIM APK Agent components and start WSO2 API Platform For Kubernetes. Consider ```apk``` as the `````` for this guide. As the ```--version``` of this command, use the version of the release you used in point 1 above and use the changed values.yaml you used in point 3 above. It will take a few minutes for the deployment to complete. diff --git a/en/docs/create-api/create-and-deploy-apis/ai/create-ai-api-using-rest-api.md b/en/docs/create-api/create-and-deploy-apis/ai/create-ai-api-using-rest-api.md index 6c14c4ce7..6d3db78e0 100644 --- a/en/docs/create-api/create-and-deploy-apis/ai/create-ai-api-using-rest-api.md +++ b/en/docs/create-api/create-and-deploy-apis/ai/create-ai-api-using-rest-api.md @@ -8,7 +8,7 @@ You can use the following sample OpenAPI Specification (OAS) definition for the - [Azure OpenAI OAS Definition](https://raw.githubusercontent.com/wso2/apk/refs/heads/main/samples/llm-providers-oas-definitions/azure/azure_api.yaml) - [Mistral AI OAS Definition](https://raw.githubusercontent.com/wso2/apk/refs/heads/main/samples/llm-providers-oas-definitions/mistral/mistral_api.yaml) -Save and download the selected sample file. This is the OAS definition of the AI API that we are going to deploy in APK. +Download and save the selected sample file. This is the OAS definition of the AI API that we are going to deploy in APK. ## Step 2. Obtain the API Key and Endpoint from the LLM Service Provider @@ -153,11 +153,11 @@ operations: The 'ai provider' field should be replaced with the actual AI Provider name and API Version. Refer the following table for the AI Provider name and API Version. - | AI Provider | API Version | - |--------------------------|-------------| - | AzureAI | 2024-06-01 | - | ai-provider-open-ai | v1 | - | ai-provider-mistral-ai | v1 | + | AI Provider | API Version | + | ---------------------- | ----------- | + | AzureAI | 2024-06-01 | + | ai-provider-open-ai | v1 | + | ai-provider-mistral-ai | v1 | !!! note - The `endpoint` and `deployment-id` in the `endpoint` field should be replaced with the actual values provided by the LLM Service Provider. diff --git a/en/docs/create-api/create-and-deploy-apis/graphql/create-graphql-api-using-rest-api.md b/en/docs/create-api/create-and-deploy-apis/graphql/create-graphql-api-using-rest-api.md index eef84d6b9..fb1c499d2 100644 --- a/en/docs/create-api/create-and-deploy-apis/graphql/create-graphql-api-using-rest-api.md +++ b/en/docs/create-api/create-and-deploy-apis/graphql/create-graphql-api-using-rest-api.md @@ -23,7 +23,7 @@ kubectl get pods -n Follow the instructions below to design a GraphQL API. -1. Save and download the sample [StarWarsAPI.graphql](../../../assets/files/get-started/StarWarsAPI.graphql) file. This is the GraphQL SDL of the API that we are going to deploy in APK. +1. Download and save the sample [StarWarsAPI.graphql](../../../assets/files/get-started/StarWarsAPI.graphql) file. This is the GraphQL SDL of the API that we are going to deploy in APK. 2. Execute the following request to generate the APK configuration. Use the values provided in the table below in the body of your request. diff --git a/en/docs/create-api/create-and-deploy-apis/grpc/create-grpc-api-using-rest-api.md b/en/docs/create-api/create-and-deploy-apis/grpc/create-grpc-api-using-rest-api.md index 295951d5d..1e586ce71 100644 --- a/en/docs/create-api/create-and-deploy-apis/grpc/create-grpc-api-using-rest-api.md +++ b/en/docs/create-api/create-and-deploy-apis/grpc/create-grpc-api-using-rest-api.md @@ -25,7 +25,7 @@ If you wish to deploy a GRPC API that has multiple .proto files, you can follow ### Step 1 - Obtain the proto files for the given API -Save and download the following file as Student.proto. +Download and save the following file as Student.proto. Student API: [Student.proto](https://raw.githubusercontent.com/wso2/docs-apk/refs/heads/1.2.0/en/docs/assets/files/get-started/student.proto) diff --git a/en/docs/create-api/create-and-deploy-apis/grpc/create-grpc-api-with-multiple-proto-files.md b/en/docs/create-api/create-and-deploy-apis/grpc/create-grpc-api-with-multiple-proto-files.md index b83be229d..ce041b76f 100644 --- a/en/docs/create-api/create-and-deploy-apis/grpc/create-grpc-api-with-multiple-proto-files.md +++ b/en/docs/create-api/create-and-deploy-apis/grpc/create-grpc-api-with-multiple-proto-files.md @@ -23,7 +23,7 @@ The following steps are a quickstart guide on deploying a GRPC API that has mult ### Step 1 - Obtain the proto files for the given API -Save and download the following files. +Download and save the following files. Order API: [OrderDefinition.zip](../../../assets/files/get-started/OrderDefinition.zip) diff --git a/en/docs/get-started/quick-start-guide-as-gateway.md b/en/docs/get-started/quick-start-guide-as-gateway.md index 307afd028..8784566c6 100644 --- a/en/docs/get-started/quick-start-guide-as-gateway.md +++ b/en/docs/get-started/quick-start-guide-as-gateway.md @@ -82,7 +82,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. 3. Install the APK components and start WSO2 API Platform For Kubernetes. Consider ```apk``` as the `````` for this guide. As the ```--version``` of this command, use the version of the release you used in point 1 above. It will take a few minutes for the deployment to complete. !!!NOTE - If you already have an installation of the APK in your cluster, please remove the installation by following the steps specified in the [Uninstall APK](../../setup/uninstall.md) section. + If you already have an installation of the APK in your cluster, please remove the installation by following the steps specified in the Uninstall APK section. === "Command" @@ -95,7 +95,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. ``` !!! Note - Please refer to the [Advance Configuration for APK](../apk-deploy.md) for more information. + Please refer to the Advanced Configuration for APK for more information. ### Setup WSO2 APIM-APK Agent 1.2.0 @@ -124,7 +124,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. ``` !!! Note - Please refer to the [Advance Configuration for agent](../apim-apk-agent-deploy.md) for more information. + Please refer to the Advanced Configuration for Agent for more information. ### Verify the deployment diff --git a/en/docs/get-started/quick-start-guide-with-cp.md b/en/docs/get-started/quick-start-guide-with-cp.md index 1e897e222..c55c76dc6 100644 --- a/en/docs/get-started/quick-start-guide-with-cp.md +++ b/en/docs/get-started/quick-start-guide-with-cp.md @@ -21,7 +21,7 @@ Install the prerequisitesEmployeeServiceDefinition.json file. This is the OAS definition of the API that we are going to deploy in APK. 2. Add a hostname mapping to the ```/etc/hosts``` file as follows. diff --git a/en/docs/get-started/quick-start-guide.md b/en/docs/get-started/quick-start-guide.md index 64cf37a2d..bc9ff03d9 100644 --- a/en/docs/get-started/quick-start-guide.md +++ b/en/docs/get-started/quick-start-guide.md @@ -34,7 +34,7 @@ kubectl get pods ## Step 3 - Create and Deploy the API -1. Save and download the sample +1. Download and save the sample EmployeeServiceDefinition.json file. This is the OAS definition of the API that we are going to deploy in APK. 1. Add a hostname mapping to the ```/etc/hosts``` file as follows. diff --git a/en/docs/includes/create-apk-conf-api.md b/en/docs/includes/create-apk-conf-api.md index 038b585d1..4467ca3b8 100644 --- a/en/docs/includes/create-apk-conf-api.md +++ b/en/docs/includes/create-apk-conf-api.md @@ -20,7 +20,7 @@ kubectl get pods You will need an OpenAPI Specification 3.x that describes the structure and behavior of your API. This file serves as the foundation for configuring your API and is essential for generating the APK Configuration file. -Save and download the sample [EmployeeServiceDefinition.json](https://raw.githubusercontent.com/wso2/apk/main/developer/tryout/samples/definitions/EmployeeServiceDefinition.json) file. This is the OAS definition of the API that we are going to deploy in APK. +Download and save the sample [EmployeeServiceDefinition.json](https://raw.githubusercontent.com/wso2/apk/main/developer/tryout/samples/definitions/EmployeeServiceDefinition.json) file. This is the OAS definition of the API that we are going to deploy in APK. ## Step 3. Generate APK configuration file. diff --git a/en/docs/setup/deployment/apk-with-apim-cp-deployment-patterns.md b/en/docs/setup/deployment/apk-with-apim-cp-deployment-patterns.md index 9f6a9abb2..b1eb1b7cf 100644 --- a/en/docs/setup/deployment/apk-with-apim-cp-deployment-patterns.md +++ b/en/docs/setup/deployment/apk-with-apim-cp-deployment-patterns.md @@ -62,5 +62,4 @@ By default, WSO2 APK is configured to support the Data Plane Only Pattern. You c {!control-plane/start-apk-dp-to-cp-vms.md!} - This approach is recommended for all Production, Dev, Test, and UAT environments. Here a seperate kubernetes cluster and a VM server is required for each environment.