Skip to content

Commit

Permalink
Update wording on documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sgayangi committed Nov 11, 2024
1 parent 60cef07 commit 827484d
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 13 deletions.
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ kubectl get pods -n <namespace>

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.

Expand Down
4 changes: 2 additions & 2 deletions en/docs/get-started/quick-start-guide-as-gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ This section is a step-by-step guide to creating, deploying, and invoking an API

## Before you begin...

Install the [prerequisites](../../setup/prerequisites) that are required to run the WSO2 API Platform For Kubernetes.
Install the <a href="../../setup/prerequisites" target="_blank">prerequisites</a> that are required to run the WSO2 API Platform for Kubernetes.

!!!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 <a href="../../setup/uninstall" target="_blank">Uninstall APK</a> section.

### Create Kubernetes namespace

Expand Down
2 changes: 1 addition & 1 deletion en/docs/get-started/quick-start-guide-with-cp.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Install the <a href="../../setup/prerequisites" target="_blank">prerequisites</a

## Step 2 - Create and Deploy the API From Dataplane

1. Save and download the sample
1. Download and save the sample
<a href="https://raw.githubusercontent.com/wso2/docs-apk/refs/heads/1.2.0/en/docs/assets/files/get-started/EmployeeServiceDefinition.json"
target="_blank" onclick="downloadFile(event)">EmployeeServiceDefinition.json</a> 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.
Expand Down
2 changes: 1 addition & 1 deletion en/docs/get-started/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<a href="https://raw.githubusercontent.com/wso2/docs-apk/refs/heads/1.1.0/en/docs/assets/files/get-started/EmployeeServiceDefinition.json"
target="_blank" onclick="downloadFile(event)">EmployeeServiceDefinition.json</a> <script src="download.js"></script> 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.
Expand Down
2 changes: 1 addition & 1 deletion en/docs/includes/create-apk-conf-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 827484d

Please sign in to comment.