Skip to content

Commit

Permalink
Fix references to different APIM version
Browse files Browse the repository at this point in the history
  • Loading branch information
PasanT9 committed Oct 29, 2024
1 parent 2add3ca commit 1411c3e
Show file tree
Hide file tree
Showing 44 changed files with 524 additions and 529 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ As an open source project, WSO2 API-M welcomes contributions from the community.

If the CLA gets changed for some (unlikely) reason, you will be presented with the new CLA text after sending your first PR after the change.

2. Fork this repository, make your changes, and send in a pull request (PR). Make sure you are contributing to the correct branch (for example, if your change is relevant to WSO2 API-M 3.2.0 documentation, you should commit your changes to the 3.2.0 branch).
2. Fork this repository, make your changes, and send in a pull request (PR). Make sure you are contributing to the correct branch (for example, if your change is relevant to WSO2 API-M 4.4.0 documentation, you should commit your changes to the 4.4.0 branch).

3. Send multiple pull requests to all the relevant branches.

If your change is relevant to the latest API-M release, please send your change to the respective latest API-M release branch and the master branch, which is the upcoming API-M release documentation branch, as well.

For example, if the latest API-M release is 3.2.0, and if your change is relevant to API-M 3.2.0, 3.1.0, and 3.0.0, send PRs to the 3.0.0, 3.1.0, 3.2.0, and the master branches.
For example, if the latest API-M release is 4.4.0, and if your change is relevant to API-M 4.4.0, 4.3.0, and 4.2.0, send PRs to the 4.4.0, 4.3.0, 4.2.0, and the master branches.

Check the issue tracker for open issues that interest you. We look forward to receiving your contributions.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Publishing Custom Analytics Events Data - API Manager Documentation 4.2.0
title: Publishing Custom Analytics Events Data - API Manager Documentation
---

# Publishing Custom Analytics Events Data
Expand Down Expand Up @@ -94,15 +94,15 @@ Build the project using,

## Configuring the Sample

This section will cover the steps required to configure WSO2 API-M Gateway for the sample created above. The steps covered are adding the .jar file, configuring the deployment.toml file, and enabling the logs.
This section will cover the steps required to configure WSO2 API-M Gateway for the sample created above. The steps covered are adding the .jar file, configuring the deployment.toml file, and enabling the logs. `<APIM_HOME>` refers to the root folder of the extracted WSO2 APIM.

1. Add the .jar file created in the target directory after building the project.

Place the created .jar file inside the `wso2am-4.2.0/repository/components/lib` directory.
Place the created .jar file inside the `<APIM_HOME>/repository/components/lib` directory.

2. Configure the deployment.toml file.

Edit the `apim.analytics` configurations in the `deployment.toml` file located inside `wso2am-4.2.0/repository/conf` with the following configuration.
Edit the `apim.analytics` configurations in the `deployment.toml` file located inside `<APIM_HOME>/repository/conf` with the following configuration.

```code
[apim.analytics]
Expand All @@ -118,7 +118,7 @@ This configuration will be used when engaging the custom data provider class.

3. Enabling Logs

To [enable trace logs]({{base_path}}/administer/logging-and-monitoring/logging/configuring-logging/#enabling-logs-for-a-component) for the component: `org.wso2.am.analytics.publisher`, edit `log4j2.properties` file located inside `wso2am-4.2.0/repository/conf` directory.
To [enable trace logs]({{base_path}}/administer/logging-and-monitoring/logging/configuring-logging/#enabling-logs-for-a-component) for the component: `org.wso2.am.analytics.publisher`, edit `log4j2.properties` file located inside `<APIM_HOME>/repository/conf` directory.

1. Add new publisher to the loggers list:

Expand All @@ -134,7 +134,7 @@ This configuration will be used when engaging the custom data provider class.
logger.org-wso2-analytics-publisher.appenderRef.CARBON_TRACE_LOGFILE.ref = CARBON_TRACE_LOGFILE
```

4. Now you can trigger an event and check the `<WSO2AM-4.2.0-HOME>/repository/logs/wso2carbon-trace-messages.log` to find the event object passed out from API Manager.
4. Now you can trigger an event and check the `<APIM_HOME>/repository/logs/wso2carbon-trace-messages.log` to find the event object passed out from API Manager.

```log
TRACE {org.wso2.am.analytics.publisher.client.EventHubClient} - [{ Cloud-Analytics-Queue-Worker-pool-2-thread-1 }] -
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"info": {
"_postman_id": "ae5aa07c-6961-4758-b2ab-9305baeda272",
"name": "WSO2 API Manager 4.0.0 - Admin REST API",
"name": "WSO2 API Manager 4.4.0 - Admin REST API",
"description": "This document specifies a **RESTful API** for WSO2 **API Manager - Admin REST API** .\nIt is written with [swagger 2.0](http://swagger.io/).\n",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"info": {
"_postman_id": "70cf89a8-49d5-46e5-901c-8f13646d1913",
"name": "WSO2 API Manager 4.0.0 - DevPortal REST APIs",
"name": "WSO2 API Manager 4.4.0 - DevPortal REST APIs",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"info": {
"_postman_id": "cccaac2d-c36c-455a-a66e-cc686b09185c",
"name": "WSO2 API Manager 4.0.0 - Publisher REST API",
"name": "WSO2 API Manager 4.4.0 - Publisher REST API",
"description": "This document specifies a **RESTful API** for WSO2 **API Manager - Publisher REST API** .\nIt is written with [swagger 2.0](http://swagger.io/).\n",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
Expand Down
8 changes: 4 additions & 4 deletions en/docs/get-started/api-manager-quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Follow the instructions below to start WSO2 API-M.

For more information on setting the `JAVA_HOME` environment variable for different operating systems, see [Setup and Install]({{base_path}}/install-and-setup/install/installing-the-product/installing-api-m-runtime/).

2. [Download version 4.2.0 of WSO2 API-M](https://wso2.com/api-management/).
2. [Download version 4.4.0 of WSO2 API-M](https://wso2.com/api-management/).

3. Start WSO2 API-M by navigating to the `<API-M_HOME>/bin` directory using the command-line and execute the following command.

Expand Down Expand Up @@ -220,13 +220,13 @@ API Products, and Applications across WSO2 API-M environments and to perform CI/

Follow the instructions below to setup WSO2 API Controller.

1. [Make sure that you run WSO2 API Manager (WSO2 API-M) 4.2.0]({{base_path}}/get-started/api-manager-quick-start-guide/#before-you-begin).
1. [Make sure that you run WSO2 API Manager]({{base_path}}/get-started/api-manager-quick-start-guide/#before-you-begin).

2. Download the apictl.

1. Navigate to the [API Manager Tooling page](https://wso2.com/api-management/tooling/).

2. Download the apictl version 4.3.0 (or the latest of the 4.3.x family) based on your operating system from the **API Controller Tooling** section.
2. Download the apictl version 4.4.0 (or the latest of the 4.4.x family) based on your operating system from the **API Controller Tooling** section.

3. Extract the ZIP to a preferred location.

Expand Down Expand Up @@ -269,7 +269,7 @@ Follow the instructions below to create an API via WSO2 API Controller.

1. Initialize an API project by providing a name for the project.

First, copy the content from `https://apim.docs.wso2.com/en/4.3.0/assets/attachments/get_started/petstore.json` and create `petstore.json` file.
First, copy the content from `https://apim.docs.wso2.com/en/4.4.0/assets/attachments/get_started/petstore.json` and create `petstore.json` file.

Let's use the command below to create an API named `PetstoreAPI`. This creates a folder named `PetstoreAPI` in your current directory.
Expand Down
2 changes: 1 addition & 1 deletion en/docs/includes/analytics/configure-synapse-gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Follow the instructions below to publish analytics data to the analytics cloud v
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul><li><p>This is the basic configuration that you need to publish analytics data to the analytics cloud.</p></li>
<li>If you need to change the following default values of the Worker Thread Count, Queue Size or Client Flushing Delay, see the <a href="https://apim.docs.wso2.com/en/4.2.0/api-analytics/gateways/configure-synapse-gateway/#advanced-configurations">Advanced configurations</a>.
<li>If you need to change the following default values of the Worker Thread Count, Queue Size or Client Flushing Delay, see the <a href="{{base_path}}/api-analytics/gateways/configure-synapse-gateway/#advanced-configurations">Advanced configurations</a>.
<table>
<tr>
<th><b>Parameter</b></th>
Expand Down
4 changes: 2 additions & 2 deletions en/docs/includes/design/additional-api-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ in the following formats.

2. Select `IP Addresses`, add the IP addresses in the text input as shown below, and generate the key.

[![IP Restricted API key](https://apim.docs.wso2.com/en/4.2.0/assets/img/learn/ip-api-key.png)](https://apim.docs.wso2.com/en/4.2.0/assets/img/learn/ip-api-key.png)
[![IP Restricted API key]({{base_path}}/assets/img/learn/ip-api-key.png)]({{base_path}}/assets/img/learn/ip-api-key.png)

#### 2) HTTP referrer restriction

Expand All @@ -30,4 +30,4 @@ When the HTTP referrer restriction has been enabled, only the specific HTTP refe

2. Select `HTTP Referrers (Web Sites)` and add the referrers in the text input as shown below and generate the key.

[![HTTP Referer Restricted API key](https://apim.docs.wso2.com/en/4.2.0/assets/img/learn/http-referer-api-key.png)](https://apim.docs.wso2.com/en/4.2.0/assets/img/learn/http-referer-api-key.png)
[![HTTP Referer Restricted API key]({{base_path}}/assets/img/learn/http-referer-api-key.png)]({{base_path}}/assets/img/learn/http-referer-api-key.png)
2 changes: 1 addition & 1 deletion en/docs/includes/design/create-mtls-api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Create an API secured with Mutual SSL

1. [Create an API](https://apim.docs.wso2.com/en/4.1.0/design/create-api/create-rest-api/create-a-rest-api/).
1. [Create an API]({{base_path}}/design/create-api/create-rest-api/create-a-rest-api/).
2. Click **Develop -> API Configurations -> Runtime**.
3. Select **Mutual SSL**.

Expand Down
2 changes: 1 addition & 1 deletion en/docs/includes/design/create-publish-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@

4. Select **API Key**. Note that `APIKey` is used as the default header. This value can be changed using the `APIKey Header` field.

[![Configure API key authentication](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/api-key-option.png)](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/api-key-option.png)
[![Configure API key authentication]({{base_path}}/assets/img/learn/api-key-option.png)]({{base_path}}/assets/img/learn/api-key-option.png)

5. Click **Save and Deploy** to save the changes made within the **Runtime Configurations** page. Upon redirection to the **Deployments** page, select the relevant Gateway and click on **Deploy**.
6 changes: 3 additions & 3 deletions en/docs/includes/design/deploy-revision.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Follow the instructions below to deploy a new revision for an API:

The Deployments page appears as follows when you do not have any existing revisions.

[![New revision](https://apim.docs.wso2.com/en/4.1.0/assets/img/design/revision/deploy-first-revision.png){: style="width:80%"}](https://apim.docs.wso2.com/en/4.1.0/assets/img/design/revision/deploy-first-revision.png)
[![New revision]({{base_path}}/assets/img/design/revision/deploy-first-revision.png){: style="width:80%"}]({{base_path}}/assets/img/design/revision/deploy-first-revision.png)

The Deployments page appears as follows when you have at least one revision.

[![Deploy new revision option](https://apim.docs.wso2.com/en/4.1.0/assets/img/design/revision/deploy-new-revision.png)](https://apim.docs.wso2.com/en/4.1.0/assets/img/design/revision/deploy-new-revision.png)
[![Deploy new revision option]({{base_path}}/assets/img/design/revision/deploy-new-revision.png)]({{base_path}}/assets/img/design/revision/deploy-new-revision.png)

!!! note
The **Information icon** will appear only if you have added a product revision description. You can view the description when you hover over the information icon.
Expand All @@ -30,4 +30,4 @@ Follow the instructions below to deploy a new revision for an API:
!!! warning
You cannot deploy more than 5 revisions. If you want to deploy a new revision after the maximum allowed number of revisions are reached, you need to delete one of the existing revisions.

[![Delete revision if max count is reached](https://apim.docs.wso2.com/en/4.1.0/assets/img/design/revision/delete-and-deploy-revision.png){: style="width:60%"}](https://apim.docs.wso2.com/en/4.1.0/assets/img/design/revision/delete-and-deploy-revision.png)
[![Delete revision if max count is reached]({{base_path}}/assets/img/design/revision/delete-and-deploy-revision.png){: style="width:60%"}]({{base_path}}/assets/img/design/revision/delete-and-deploy-revision.png)
8 changes: 4 additions & 4 deletions en/docs/includes/design/generate-api-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@

5. Click **Subscribe**.

[![Subscribe to the API](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/subscribe-to-api.png)](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/subscribe-to-api.png)
[![Subscribe to the API]({{base_path}}/assets/img/learn/subscribe-to-api.png)]({{base_path}}/assets/img/learn/subscribe-to-api.png)

6. Click **MANAGE APP**, corresponding to the application that you used to subscribe to the API.

[![View list of credentials](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/view-credentials-manage-app.png)](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/view-credentials-manage-app.png)
[![View list of credentials]({{base_path}}/assets/img/learn/view-credentials-manage-app.png)]({{base_path}}/assets/img/learn/view-credentials-manage-app.png)

7. Click **API KEY** and click **GENERATE KEY**.

[![Generate API key](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/generate-api-key.png){: style="width:80%"}](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/generate-api-key.png)
[![Generate API key]({{base_path}}/assets/img/learn/generate-api-key.png){: style="width:80%"}]({{base_path}}/assets/img/learn/generate-api-key.png)

8. Optionally, define a validity period for the token.

Expand All @@ -38,4 +38,4 @@

9. Copy the API key.

[![Copy API key](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/copy-api-key.png){: style="width:60%"}](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/copy-api-key.png)
[![Copy API key]({{base_path}}/assets/img/learn/copy-api-key.png){: style="width:60%"}]({{base_path}}/assets/img/learn/copy-api-key.png)
4 changes: 2 additions & 2 deletions en/docs/includes/design/invoke-mtls-api-using-postman.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Import the certificate and private key to Postman.

1. Navigate to the certificates tab in Postman settings.

[![Add the certificate to Postman](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/add-certificate-to-postman.png)](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/add-certificate-to-postman.png)
[![Add the certificate to Postman]({{base_path}}/assets/img/learn/add-certificate-to-postman.png)]({{base_path}}/assets/img/learn/add-certificate-to-postman.png)

2. Add the certificate and private key.

[![Provide certificate and private key](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/provide-crt-and-private-key.png)](https://apim.docs.wso2.com/en/4.1.0/assets/img/learn/provide-crt-and-private-key.png)
[![Provide certificate and private key]({{base_path}}/assets/img/learn/provide-crt-and-private-key.png)]({{base_path}}/assets/img/learn/provide-crt-and-private-key.png)

3. Invoke the API from Postman.

2 changes: 1 addition & 1 deletion en/docs/includes/design/redis-counter-note.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

!!! note
- **[Configure Rate Limiting for the API Gateway Cluster](https://apim.docs.wso2.com/en/4.1.0/design/rate-limiting/advanced-topics/configuring-rate-limiting-api-gateway-cluster)** so that the request counters will be replicated across the API Gateway cluster when working with multiple API Gateway nodes.
- **[Configure Rate Limiting for the API Gateway Cluster]({{base_path}}/design/rate-limiting/advanced-topics/configuring-rate-limiting-api-gateway-cluster)** so that the request counters will be replicated across the API Gateway cluster when working with multiple API Gateway nodes.
- Configuring Rate Limiting for the API Gateway cluster is not applicable if you have a clustered setup.

2 changes: 1 addition & 1 deletion en/docs/includes/handling-mtls-ssl-termination.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ When SSL termination of API requests takes place at the Load Balancer or Reverse

The following diagram illustrates how Mutual SSL works in such an environment.

[![MTLS Load Balancer](https://apim.docs.wso2.com/en/4.2.0/assets/img/learn/mtls-loadbalancer.png)](https://apim.docs.wso2.com/en/4.2.0/assets/img/learn/mtls-loadbalancer.png)
[![MTLS Load Balancer]({{base_path}}/assets/img/learn/mtls-loadbalancer.png)]({{base_path}}/assets/img/learn/mtls-loadbalancer.png)

Loading

0 comments on commit 1411c3e

Please sign in to comment.