Skip to content

[4.5.0] Labels Feature #9046

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.

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

Open
wants to merge 1 commit into
base: 4.5.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added en/docs/assets/img/develop/attach_label.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/docs/assets/img/develop/new_add_label.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 54 additions & 0 deletions en/docs/reference/customize-product/customizations/label.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@

# Labels

You can use Labels to group and categorize APIs for any purpose. Labels do not use a naming convention. Therefore, the admin does not need to take into consideration any naming conventions when using Label based grouping. Administrators can use any naming conventions for the Labels depending on the usecase.

Initially, the Admins will define Labels. Then, API providers will add Labels to APIs when designing them via the API Publisher. Labels allow API providers to categorize APIs that have similar attributes or based on the business usecase of the APIs.

## Step 1 - Add Label

You can add a Label using any of the following methods:

- Add a Label using the Admin Portal UI
- Add a Label using the Admin REST API. (You can use the POST resource in the **Labels (Individual)** section [here]({{base_path}}/reference/product-apis/admin-apis/admin-v4/admin-v4))

### Add a Label using the Admin Portal UI

1. Sign in to the Admin Portal.

[https://localhost:9443/admin](https://localhost:9443/admin)

2. Navigate to **Label** section.

<img src="{{base_path}}/assets/img/develop/new_label_left_tag.png" width="250" alt="Labels menu">

3. Click **Add Label**.

[![Add API category page]({{base_path}}/assets/img/develop/new_click_add_label.png)]({{base_path}}/assets/img/develop/new_click_add_label.png)

4. Enter a name and a description for the Label.

| Field | Value |
|----------------|------------------------|
| Name | Health |
| Description | Health related APIs |

<img src="{{base_path}}/assets/img/develop/new_add_label.png" width="500" alt="Add Label">

5. Click **Save**.

## Step 2 - Attach the Label to an API

1. Sign in to the Publisher.

[https://localhost:9443/publisher](https://localhost:9443/publisher)

2. Click on an API.

3. Click **Portal Configurations > Basic Info**.

<img src="{{base_path}}/assets/img/develop/api-portal-config-basic-info.png" width="235" alt="Add API category">

4. Add/Remove Labels from the side menu.

[![Add API categories]({{base_path}}/assets/img/develop/attach_label.png)]({{base_path}}/assets/img/develop/attach_label.png)
6 changes: 5 additions & 1 deletion en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,7 @@ nav:
- Define Custom Linter Rules: reference/customize-product/customizations/define-custom-linters.md
- Advanced UI Customization: reference/customize-product/customizations/advanced-ui-customization.md
- Modify Workflow Approval Task Limit: reference/customize-product/customizations/modify-workflow-approval-task-limit.md
- Label: reference/customize-product/customizations/label.md
- Admin Services: reference/wso2-admin-services.md
- Work with the Source Code: reference/working-with-the-source-code.md
- Java Documentation: reference/java-documentation.md
Expand Down Expand Up @@ -713,6 +714,7 @@ plugins:
- redirects:
redirect_maps:
'learn/consume-api/customizations/customizing-the-developer-portal/customize-api-listing/api-category-based-grouping.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/customizing-the-developer-portal/customize-api-listing/api-category-based-grouping/'
'learn/consume-api/customizations/label.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/label/'
'learn/consume-api/customizations/customizing-the-developer-portal/customize-api-listing/change-default-view.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/customizing-the-developer-portal/customize-api-listing/change-default-view/'
'learn/consume-api/customizations/customizing-the-developer-portal/enabling-or-disabling-api-detail-tabs.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/customizing-the-developer-portal/enabling-or-disabling-api-detail-tabs/'
'learn/consume-api/customizations/customizing-the-developer-portal/override-api-overview-page-per-api.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/customizing-the-developer-portal/override-api-overview-page-per-api/'
Expand Down Expand Up @@ -1032,6 +1034,7 @@ plugins:
'develop/extending-api-manager/saml2-sso/multi-factor-authentication-mfa-for-publisher-and-developer-portals.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/extending-api-manager/saml2-sso/multi-factor-authentication-mfa-for-publisher-and-developer-portals/'
'develop/customizations/customizing-the-developer-portal/overriding-developer-portal-theme.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/customizing-the-developer-portal/overriding-developer-portal-theme/'
'develop/customizations/customizing-the-developer-portal/customize-api-listing/api-category-based-grouping.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/customizing-the-developer-portal/customize-api-listing/api-category-based-grouping/'
'learn/consume-api/customizations/label.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/label/'
'develop/customizations/customizing-the-developer-portal/customize-api-listing/change-default-view.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/customizing-the-developer-portal/customize-api-listing/change-default-view/'
'develop/customizations/customizing-the-developer-portal/enabling-or-disabling-api-detail-tabs.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/customizing-the-developer-portal/enabling-or-disabling-api-detail-tabs/'
'develop/customizations/customizing-the-developer-portal/override-api-overview-page-per-api.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/customizing-the-developer-portal/override-api-overview-page-per-api/'
Expand Down Expand Up @@ -1096,6 +1099,7 @@ plugins:
'design/prototype-api/create-a-prototype-api.md': 'https://apim.docs.wso2.com/en/4.4.0/design/prototype-api/overview/'
'deploy-and-publish/deploy-on-gateway/api-gateway/message-tracing.md': 'https://apim.docs.wso2.com/en/4.4.0/get-started/about-this-release/#removed-features-and-functionalities'
'develop/customizations/customizing-the-developer-portal/customize-api-listing/categorizing-and-grouping-apis/api-category-based-grouping.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/customizing-the-developer-portal/customize-api-listing/api-category-based-grouping/'
'learn/consume-api/customizations/label.md': 'https://apim.docs.wso2.com/en/4.4.0/reference/customize-product/customizations/label/'
# Extra
extra_css:
- assets/lib/highlightjs/default.min.css
Expand All @@ -1121,6 +1125,6 @@ extra:
version: 1.2.0-1
git_tag: v1.2.0.1
site_version: 4.5.0
# base_path: http://localhost:8000/en/latest
# base_path: http://localhost:8000/en/4.5.0
base_path: https://apim.docs.wso2.com/en/4.5.0
envoy_path: https://www.envoyproxy.io/docs/envoy/v1.24.1