API Connect

Hi ,

I am trying to understand the category at API level. what benefits it. what are the use case we should use Category or tags.

Use case 1: If we put Category on API YAML then these category shows up under dropdown on API Products search page but the search does not work. And even it dos not come with level1 -level 2 category under drop down. 

Use Case 2: If we put category on Product then it shows up under dropdown on API Products search page and search works with that. And this also comes like level1-level2 search criteria which is good.

And so if we are putting category at API YAML then it should match with same as product category other wise it messes the API product search page.

So I am trying to understand

• what is the benefits of having category at API YAML
• what are the use case we should use category at API YAML

Categories can be assigned to APIs and products in the yaml documents.

The portal then turns those categories into a hierarchical taxonomy tree.

You can then browse by that or search using it to find content in the portal - that works for both APIs and Products. (There's a page in the docs on how to add a hierarchical taxonomy navigation block to the portal: https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=structure-providing-navigation-by-tag-hierarchy).

I suspect where you are coming unstuck is that you are adding a category to an API but then searching for a product based on the API's category. That is obviously not going to work, when you are browsing for products it is only the attributes of the product that come into play, if the product does not have the same category then it won't be shown. 

I suspect you possibly want to make the categories of the product the superset of the categories for all the APIs included within that product. You could suggest that we could do that automatically.... and that would be a good RFE, but it isn't how it works today :-)

Hi ,

I am trying to understand the category at API level. what benefits it. what are the use case we should use Category or tags.

Use case 1: If we put Category on API YAML then these category shows up under dropdown on API Products search page but the search does not work. And even it dos not come with level1 -level 2 category under drop down. 

Use Case 2: If we put category on Product then it shows up under dropdown on API Products search page and search works with that. And this also comes like level1-level2 search criteria which is good.

And so if we are putting category at API YAML then it should match with same as product category other wise it messes the API product search page.

So I am trying to understand

• what is the benefits of having category at API YAML
• what are the use case we should use category at API YAML

so my point is if we put Category on API Yaml then it also comes under drop down of API Products search and that does not work then why it is even coming there.

And where I can use the Category of API , what is the use case. I understand it groups but not able to understand where this is helping from UI presepective.

And I did try to follow the https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=structure-providing-navigation-by-tag-hierarchy and and i am not able to follow from here. It is not moving forward . it just stops there . It does not go to next step. not sure why.

1. Find the Hierarchical Taxonomy Menu block in the list and click Place block.

Categories can be assigned to APIs and products in the yaml documents.

The portal then turns those categories into a hierarchical taxonomy tree.

You can then browse by that or search using it to find content in the portal - that works for both APIs and Products. (There's a page in the docs on how to add a hierarchical taxonomy navigation block to the portal: https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=structure-providing-navigation-by-tag-hierarchy).

I suspect where you are coming unstuck is that you are adding a category to an API but then searching for a product based on the API's category. That is obviously not going to work, when you are browsing for products it is only the attributes of the product that come into play, if the product does not have the same category then it won't be shown. 

I suspect you possibly want to make the categories of the product the superset of the categories for all the APIs included within that product. You could suggest that we could do that automatically.... and that would be a good RFE, but it isn't how it works today :-)

Hi ,

I am trying to understand the category at API level. what benefits it. what are the use case we should use Category or tags.

Use case 1: If we put Category on API YAML then these category shows up under dropdown on API Products search page but the search does not work. And even it dos not come with level1 -level 2 category under drop down. 

Use Case 2: If we put category on Product then it shows up under dropdown on API Products search page and search works with that. And this also comes like level1-level2 search criteria which is good.

And so if we are putting category at API YAML then it should match with same as product category other wise it messes the API product search page.

So I am trying to understand

• what is the benefits of having category at API YAML
• what are the use case we should use category at API YAML

The list of categories shown is all of those in the taxonomy. Some of which may or may not have content in them.

if you want to look for apis then don't use /product. Try the main site search page or /api. As a reminder the product page lists products not apis and you can't find a product based on an attribute of an api.

if you add a taxonomy navigation block then it will show all content in each category - that might be products, apis, custom doc pages, blog posts etc… Remember the portal is a full Content Management System. It includes all sorts of content navigation options, some are suitable for done scenarios, others for other ones - you don't need to use them all :-)

so my point is if we put Category on API Yaml then it also comes under drop down of API Products search and that does not work then why it is even coming there.

And where I can use the Category of API , what is the use case. I understand it groups but not able to understand where this is helping from UI presepective.

And I did try to follow the https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=structure-providing-navigation-by-tag-hierarchy and and i am not able to follow from here. It is not moving forward . it just stops there . It does not go to next step. not sure why.

1. Find the Hierarchical Taxonomy Menu block in the list and click Place block.

Categories can be assigned to APIs and products in the yaml documents.

The portal then turns those categories into a hierarchical taxonomy tree.

You can then browse by that or search using it to find content in the portal - that works for both APIs and Products. (There's a page in the docs on how to add a hierarchical taxonomy navigation block to the portal: https://www.ibm.com/docs/en/api-connect/10.0.5.x_lts?topic=structure-providing-navigation-by-tag-hierarchy).

I suspect where you are coming unstuck is that you are adding a category to an API but then searching for a product based on the API's category. That is obviously not going to work, when you are browsing for products it is only the attributes of the product that come into play, if the product does not have the same category then it won't be shown. 

I suspect you possibly want to make the categories of the product the superset of the categories for all the APIs included within that product. You could suggest that we could do that automatically.... and that would be a good RFE, but it isn't how it works today :-)

Hi ,

I am trying to understand the category at API level. what benefits it. what are the use case we should use Category or tags.

Use case 1: If we put Category on API YAML then these category shows up under dropdown on API Products search page but the search does not work. And even it dos not come with level1 -level 2 category under drop down. 

Use Case 2: If we put category on Product then it shows up under dropdown on API Products search page and search works with that. And this also comes like level1-level2 search criteria which is good.

And so if we are putting category at API YAML then it should match with same as product category other wise it messes the API product search page.

So I am trying to understand

• what is the benefits of having category at API YAML
• what are the use case we should use category at API YAML