Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[4.3.0] Fix documentation Issues #8675

Merged
merged 5 commits into from
Nov 6, 2024
Merged

[4.3.0] Fix documentation Issues #8675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0b2cfc6
update response in password grant doc
Tharanidk Nov 4, 2024
42c5f8e
added missing search instruction
Tharanidk Nov 4, 2024
9d0385f
added rate limiting toml config
Tharanidk Nov 5, 2024
5e99612
Removed design a new API Thumbnail document
Tharanidk Nov 5, 2024
799a22c
fix review changes
Tharanidk Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion en/docs/design/api-security/oauth2/grant-types/password-grant.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ If you have multiple Carbon servers running on the same computer, [change the po
"scope":"default",
"token_type":"Bearer",
"expires_in":3600,
"refresh_token":"ca5a51f18b2edf4eaa9e4b871e42b58a",
"access_token":"f2c66f146278aaaf6513b585b5b68d1d"
}
```
Expand Down
2 changes: 1 addition & 1 deletion en/docs/design/create-api/adding-custom-properties-to-apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ 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)
[![API Properties]({{base_path}}/assets/img/learn/view-custom-api-properties.png)]({{base_path}}/assets/img/learn/view-custom-api-properties.png)
36 changes: 1 addition & 35 deletions en/docs/design/create-api/change-api-thumbnail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,38 +18,4 @@ 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.

<img src="{{base_path}}/assets/img/learn/change-thumbnail-api-updated.png" height="250"/>

## 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.

<img src="{{base_path}}/assets/img/learn/change-thumbnail-icon-types.png" height="300"/>

- **Icon Color**

Select the icon color from the color picker.

<img src="{{base_path}}/assets/img/learn/change-thumbnail-select-color.png" height="250"/>

- **Background**

Select the thumbnail background from the designs.

<img src="{{base_path}}/assets/img/learn/change-thumbnail-select-background.png" height="150"/>

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.

<img src="{{base_path}}/assets/img/learn/change-thumbnail-design-icon-changed.png" height="250"/>


6 changes: 6 additions & 0 deletions en/docs/design/rate-limiting/adding-new-throttling-policies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ You can add advanced rate limiting policies to both APIs and resources.
</li>
<li>
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.</li>
```toml
[apim.throttling]
enable_header_based_throttling = true
enable_jwt_claim_based_throttling = true
enable_query_param_based_throttling = true
```
<li>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.
</li></ul>
</p>
Expand Down