From c9e00414453a305004ff4fd790aab2c884a397d1 Mon Sep 17 00:00:00 2001 From: sgayangi Date: Mon, 18 Nov 2024 16:02:03 +0530 Subject: [PATCH] Update file download for QSG sample json --- .../EmployeeServiceDefinition.json | 4 +- en/docs/get-started/downloadFile.js | 15 -------- .../get-started/quick-start-guide-with-cp.md | 26 ++----------- en/docs/get-started/quick-start-guide.md | 37 ++++--------------- 4 files changed, 13 insertions(+), 69 deletions(-) delete mode 100644 en/docs/get-started/downloadFile.js diff --git a/en/docs/assets/files/get-started/EmployeeServiceDefinition.json b/en/docs/assets/files/get-started/EmployeeServiceDefinition.json index 68e74e623..20038790e 100644 --- a/en/docs/assets/files/get-started/EmployeeServiceDefinition.json +++ b/en/docs/assets/files/get-started/EmployeeServiceDefinition.json @@ -43,7 +43,9 @@ } } } - }, + } + }, + "/employee": { "post": { "tags": [ "employee-controller" diff --git a/en/docs/get-started/downloadFile.js b/en/docs/get-started/downloadFile.js deleted file mode 100644 index 1ad9aaa9d..000000000 --- a/en/docs/get-started/downloadFile.js +++ /dev/null @@ -1,15 +0,0 @@ -function downloadFile(event) { - event.preventDefault(); - const url = event.target.href; - const fileName = "EmployeeServiceDefinition.json"; - fetch(url) - .then(response => response.blob()) - .then(blob => { - const link = document.createElement('a'); - link.href = URL.createObjectURL(blob); - link.download = fileName; - link.click(); - URL.revokeObjectURL(link.href); - }) - .catch(console.error); -} 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 c48a8be59..f24654465 100644 --- a/en/docs/get-started/quick-start-guide-with-cp.md +++ b/en/docs/get-started/quick-start-guide-with-cp.md @@ -21,9 +21,7 @@ Install the prerequisitesEmployeeServiceDefinition.json file. This is the OAS definition of the API that we are going to deploy in APK. +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. 2. Add a hostname mapping to the ```/etc/hosts``` file as follows. | IP | Domain name | @@ -134,7 +132,7 @@ operations: ``` !!! Important - We recommend installing the APK Config Language Support Visual Studio Code (VS Code) extension to edit the APK Configuration file. + We recommend installing the APK Config Language Support Visual Studio Code (VS Code) extension to edit the APK Configuration file. ### Deploy the API in APK DataPlane @@ -257,22 +255,4 @@ kubectl get pods -n apk curl -X GET "https://carbon.super.gw.wso2.com:9095/employees-info/3.14/employees" -H "Authorization: Bearer " -k ``` -You will now be able to see a successful response with the details of the Employees from the mock backend that we used for this guide. - - \ No newline at end of file +You will now be able to see a successful response with the details of the Employees from the mock backend that we used for this guide. \ No newline at end of file diff --git a/en/docs/get-started/quick-start-guide.md b/en/docs/get-started/quick-start-guide.md index bc9ff03d9..a68d56e25 100644 --- a/en/docs/get-started/quick-start-guide.md +++ b/en/docs/get-started/quick-start-guide.md @@ -34,10 +34,8 @@ kubectl get pods ## Step 3 - Create and Deploy the API -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. +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. +2. Add a hostname mapping to the ```/etc/hosts``` file as follows. | IP | Domain name | | --------- | ------------------- | @@ -60,7 +58,6 @@ kubectl get pods Apart from the above API definition file, we also need an `apk-conf` file that defines the configurations and metadata for this API. We have a configuration service that can be used to generate this apk-conf file when the OpenAPI definition is provided. - 1. Execute the following request to generate the APK configuration. Use the values provided in the table below in the body of your request. | Field | Value | @@ -112,7 +109,6 @@ Apart from the above API definition file, we also need an `apk-conf` file that d --form 'definition=@""' ``` - 2. You will get the apk-conf file content as the response. Save this content into a file named `EmployeeService.apk-conf`. You can edit these values as necessary. Let's change the basepath from the autogenerated value to "/employees-info". Your apk-conf file should now appear as follows. ``` @@ -145,8 +141,7 @@ operations: ``` !!! Important - We recommend installing the APK Config Language Support Visual Studio Code (VS Code) extension to edit the APK Configuration file. - + We recommend installing the APK Config Language Support Visual Studio Code (VS Code) extension to edit the APK Configuration file. ### Generate an access token to invoke APIs @@ -262,7 +257,7 @@ You now have the API Definition (`EmployeeServiceDefinition.json`) and the apk-c Now the API is ready to be invoked. Let’s get the list of employees by invoking the `/employees` resource in the `EmployeeServiceAPI`. -1. Execute the following request to invoke the API. Make sure to provide the access token obtained in the previous step under ["Generate an access token to invoke APIs"](#generate-an-access-token-to-invoke-apis) section as the `Authorization` header in this request. +1. Execute the following request to invoke the API. Make sure to provide the access token obtained in the previous step under [Generate an access token to invoke APIs](#generate-an-access-token-to-invoke-apis) section as the `Authorization` header in this request. === "Sample Request" @@ -307,24 +302,6 @@ Now the API is ready to be invoked. Let’s get the list of employees by invokin You will now be able to see a successful response with the details of the employees from the mock backend that we used for this guide. !!!Note - To invoke the APIs, we need a valid access token issued by an identity provider (IdP). APK supports third-party IdPs such as Asgardeo and Auth0. Refer Configure IDP. - -If you encounter any issues during the installation process, don't worry! We've compiled a list of frequently asked questions (FAQs) to help you troubleshoot common problems. Please refer to the FAQs section in this guide for step-by-step solutions to common installation issues. - - \ No newline at end of file + To invoke the APIs, we need a valid access token issued by an identity provider (IdP). APK supports third-party IdPs such as Asgardeo and Auth0. Refer Configure IDP. + +If you encounter any issues during the installation process, don't worry! We've compiled a list of frequently asked questions (FAQs) to help you troubleshoot common problems. Please refer to the FAQs section in this guide for step-by-step solutions to common installation issues. \ No newline at end of file