From 240c12c0208e2078d3e1e14193794997dad5e9a2 Mon Sep 17 00:00:00 2001 From: Tharanidk Date: Tue, 5 Nov 2024 12:26:52 +0530 Subject: [PATCH 1/4] added rate limiting toml config --- .../design/rate-limiting/adding-new-throttling-policies.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/en/docs/design/rate-limiting/adding-new-throttling-policies.md b/en/docs/design/rate-limiting/adding-new-throttling-policies.md index 59fd4fd3d1..899f9e9649 100644 --- a/en/docs/design/rate-limiting/adding-new-throttling-policies.md +++ b/en/docs/design/rate-limiting/adding-new-throttling-policies.md @@ -42,6 +42,10 @@ You can add advanced rate limiting policies to both APIs and resources.
  • Note that if you want to add a header, query param, or JSON Web Token (JWT) claim condition, you need to set the `enable_header_based_throttling` , `enable_jwt_claim_based_throttling` or `enable_query_param_based_throttling` element to `true` (depending on which condition you need) under `[apim.throttling]` in the `repository/conf/deployment.toml` file.
    • + ```toml + [transport.passthru_https.sender.parameters] + HostnameVerifier = "AllowAll" + ```
  • This JWT is the backend JWT and not the one you use to invoke it. In addition, you need to enable the Backend JWT token to get this rate limiting flow to work.

    • From 2429f04d827e1d6ea5ed64999b1905666752d292 Mon Sep 17 00:00:00 2001 From: Tharanidk Date: Mon, 4 Nov 2024 18:11:00 +0530 Subject: [PATCH 2/4] added missing search instruction --- .../design/create-api/adding-custom-properties-to-apis.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/en/docs/design/create-api/adding-custom-properties-to-apis.md b/en/docs/design/create-api/adding-custom-properties-to-apis.md index d4284bd748..e1b4683436 100644 --- a/en/docs/design/create-api/adding-custom-properties-to-apis.md +++ b/en/docs/design/create-api/adding-custom-properties-to-apis.md @@ -80,4 +80,10 @@ For example, if you want to search for the environment property with a specific When you click on the name of the API in the above screen, the respective API Overview page appears. Click on the **Properties** tab to list the API properties that you added. -[![API Properties]({{base_path}}/assets/img/learn/view-custom-api-properties.png)]({{base_path}}/assets/img/learn/view-custom-api-properties.png) \ No newline at end of file +[![API Properties]({{base_path}}/assets/img/learn/view-custom-api-properties.png)]({{base_path}}/assets/img/learn/view-custom-api-properties.png) + +??? note "Note" + When devportal visibility is enabled for a property when searching from Publisher, we need to search it in the following manner. + __display: + + For example, if you added a property called env with value dev, we need to search it in the publisher as env__display:dev. \ No newline at end of file From e60762f35d5341d36240890304dc56325fe6c1cc Mon Sep 17 00:00:00 2001 From: Tharanidk Date: Wed, 6 Nov 2024 01:22:43 +0530 Subject: [PATCH 3/4] fix review changes --- .../design/create-api/adding-custom-properties-to-apis.md | 6 ------ .../design/rate-limiting/adding-new-throttling-policies.md | 6 ++++-- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/en/docs/design/create-api/adding-custom-properties-to-apis.md b/en/docs/design/create-api/adding-custom-properties-to-apis.md index e1b4683436..dc5b59a994 100644 --- a/en/docs/design/create-api/adding-custom-properties-to-apis.md +++ b/en/docs/design/create-api/adding-custom-properties-to-apis.md @@ -81,9 +81,3 @@ For example, if you want to search for the environment property with a specific When you click on the name of the API in the above screen, the respective API Overview page appears. Click on the **Properties** tab to list the API properties that you added. [![API Properties]({{base_path}}/assets/img/learn/view-custom-api-properties.png)]({{base_path}}/assets/img/learn/view-custom-api-properties.png) - -??? note "Note" - When devportal visibility is enabled for a property when searching from Publisher, we need to search it in the following manner. - __display: - - For example, if you added a property called env with value dev, we need to search it in the publisher as env__display:dev. \ No newline at end of file diff --git a/en/docs/design/rate-limiting/adding-new-throttling-policies.md b/en/docs/design/rate-limiting/adding-new-throttling-policies.md index 899f9e9649..65f97ec6bf 100644 --- a/en/docs/design/rate-limiting/adding-new-throttling-policies.md +++ b/en/docs/design/rate-limiting/adding-new-throttling-policies.md @@ -43,8 +43,10 @@ You can add advanced rate limiting policies to both APIs and resources.
  • Note that if you want to add a header, query param, or JSON Web Token (JWT) claim condition, you need to set the `enable_header_based_throttling` , `enable_jwt_claim_based_throttling` or `enable_query_param_based_throttling` element to `true` (depending on which condition you need) under `[apim.throttling]` in the `repository/conf/deployment.toml` file.
    • ```toml - [transport.passthru_https.sender.parameters] - HostnameVerifier = "AllowAll" + [apim.throttling] + enable_header_based_throttling = true + enable_jwt_claim_based_throttling = true + enable_query_param_based_throttling = true ```
  • This JWT is the backend JWT and not the one you use to invoke it. In addition, you need to enable the Backend JWT token to get this rate limiting flow to work.
    • From bf9f0326ddce3169b01e62cf431187495666d1e3 Mon Sep 17 00:00:00 2001 From: Tharanidk Date: Wed, 6 Nov 2024 01:28:31 +0530 Subject: [PATCH 4/4] Removed design a new API Thumbnail document --- .../design/create-api/change-api-thumbnail.md | 35 ------------------- 1 file changed, 35 deletions(-) diff --git a/en/docs/design/create-api/change-api-thumbnail.md b/en/docs/design/create-api/change-api-thumbnail.md index 12fea51d09..4dc21390f7 100644 --- a/en/docs/design/create-api/change-api-thumbnail.md +++ b/en/docs/design/create-api/change-api-thumbnail.md @@ -18,38 +18,3 @@ The thumbnail of an API can be changed by uploading an image for the thumbnail o The newly added image appears as the API thumbnail. - -## Design a new API Thumbnail - -1. Follow [steps 1 - 3 under Upload new API thumbnail](#Upload-new-API-thumbnail). - -2. Click **Design**. - [![]({{base_path}}/assets/img/learn/change-thumbnail-design.png)]({{base_path}}/assets/img/learn/change-thumbnail-design.png) - -4. Select an icon, color, and background for the thumbnail. - - - **Category** - - Select the icon category. Currently, the API Publisher supports the following categories. - - - - - **Icon Color** - - Select the icon color from the color picker. - - - - - **Background** - - Select the thumbnail background from the designs. - - - -5. Click **SAVE** to save the thumbnail. - [![change thumbnail design icon]({{base_path}}/assets/img/learn/change-thumbnail-design-icon.png)]({{base_path}}/assets/img/learn/change-thumbnail-design-icon.png) - - The designed thumbnail appears as the API thumbnail. - - - \ No newline at end of file