API Connect

Hi 

This is my vision and looking for some recommendations or suggestions.

• Tagging Product as Active/Deprecated/Retired. So when User search the products  and Products lists are shown , when Products are shown as Cards , it also has some label showing  Active/Deprecated/Retired. And is there way to color code the Card that Green is active , yellow/orange is Deprecated and Red is retired.
• And similar to Product, I am trying to show or tag these APIs as Deprecated/Retired.
• And once those can be achieved and if these can also provide way to filter based on these Active/Deprecated/retired.
• These I am looking for /product or /api pages.

I know there will be questions asked like retired Product should not be there and that is correct but I am just trying to find a way to tag those.

This could be purely Drupal question but wanted to see if anyone has tried this or any suggestions. 

I'm not sure this makes sense to attempt.

Retired products are removed from the portal as they are no longer used so there's no point tagging them with anything, they no longer exist. (This cannot be prevented, it's automatic)

Deprecated products are only visible to someone who is already subscribed to it and inaccessible to everyone else (and are already labeled Deprecated pretty clearly).

I think you might want to have a play around with the APIC lifecycle and the effect on the portal before wasting effort on this further. 

Essentially every product an anonymous user can see is in "published" state.

Hi 

This is my vision and looking for some recommendations or suggestions.

• Tagging Product as Active/Deprecated/Retired. So when User search the products  and Products lists are shown , when Products are shown as Cards , it also has some label showing  Active/Deprecated/Retired. And is there way to color code the Card that Green is active , yellow/orange is Deprecated and Red is retired.
• And similar to Product, I am trying to show or tag these APIs as Deprecated/Retired.
• And once those can be achieved and if these can also provide way to filter based on these Active/Deprecated/retired.
• These I am looking for /product or /api pages.

I know there will be questions asked like retired Product should not be there and that is correct but I am just trying to find a way to tag those.

This could be purely Drupal question but wanted to see if anyone has tried this or any suggestions. 

Yes , For Product Deprecating or retired , I get that. for existing user of the product I want to show that now this Product is deprecated.

But For APIs list , yes I am looking for that functionality where APIs are tagged or similar way so that when user is checking the API list under product , these info are there for them.

Or If I want to find deprecated/retired/Active some kind of search or View that I can create based on this data. 

I'm not sure this makes sense to attempt.

Retired products are removed from the portal as they are no longer used so there's no point tagging them with anything, they no longer exist. (This cannot be prevented, it's automatic)

Deprecated products are only visible to someone who is already subscribed to it and inaccessible to everyone else (and are already labeled Deprecated pretty clearly).

I think you might want to have a play around with the APIC lifecycle and the effect on the portal before wasting effort on this further. 

Essentially every product an anonymous user can see is in "published" state.

Hi 

This is my vision and looking for some recommendations or suggestions.

• Tagging Product as Active/Deprecated/Retired. So when User search the products  and Products lists are shown , when Products are shown as Cards , it also has some label showing  Active/Deprecated/Retired. And is there way to color code the Card that Green is active , yellow/orange is Deprecated and Red is retired.
• And similar to Product, I am trying to show or tag these APIs as Deprecated/Retired.
• And once those can be achieved and if these can also provide way to filter based on these Active/Deprecated/retired.
• These I am looking for /product or /api pages.

I know there will be questions asked like retired Product should not be there and that is correct but I am just trying to find a way to tag those.

This could be purely Drupal question but wanted to see if anyone has tried this or any suggestions. 

Deprecated products are already marked deprecated.

An api isn't deprecated, the product it is in is deprecated.

Retired ones don't even exist on the portal as they are deleted as soon as you retire the last product that contains that api.

As I said, I think you need to experiment with what happens in the portal with different lifecycle states. Right now all apis will be a member of a published product or a handful might be in a product that is deprecated.

Navigation is primarily around products not apis, the page is listing products not apis. 
When looking at the apis within a product those apis all have the state of the parent product. You don't deprecate an api you deprecate the product that  obtains it. You can't retire an api, you retire the product that contains it.

So if a product is deprecated and that's the only one you're subscribed to then all the apis are deprecated. If the product is published then so are all the apis in it. If the product is retired then it won't exist on the portal anymore, all subs will be deleted and any Apis only in that product will also be deleted.

I dont think your scenario exists in APIC, simply APIs do not have state, products do.

Yes , For Product Deprecating or retired , I get that. for existing user of the product I want to show that now this Product is deprecated.

But For APIs list , yes I am looking for that functionality where APIs are tagged or similar way so that when user is checking the API list under product , these info are there for them.

Or If I want to find deprecated/retired/Active some kind of search or View that I can create based on this data. 

I'm not sure this makes sense to attempt.

Retired products are removed from the portal as they are no longer used so there's no point tagging them with anything, they no longer exist. (This cannot be prevented, it's automatic)

Deprecated products are only visible to someone who is already subscribed to it and inaccessible to everyone else (and are already labeled Deprecated pretty clearly).

I think you might want to have a play around with the APIC lifecycle and the effect on the portal before wasting effort on this further. 

Essentially every product an anonymous user can see is in "published" state.

Hi 

This is my vision and looking for some recommendations or suggestions.

• Tagging Product as Active/Deprecated/Retired. So when User search the products  and Products lists are shown , when Products are shown as Cards , it also has some label showing  Active/Deprecated/Retired. And is there way to color code the Card that Green is active , yellow/orange is Deprecated and Red is retired.
• And similar to Product, I am trying to show or tag these APIs as Deprecated/Retired.
• And once those can be achieved and if these can also provide way to filter based on these Active/Deprecated/retired.
• These I am looking for /product or /api pages.

I know there will be questions asked like retired Product should not be there and that is correct but I am just trying to find a way to tag those.

This could be purely Drupal question but wanted to see if anyone has tried this or any suggestions. 

Deprecated products are already marked deprecated.

An api isn't deprecated, the product it is in is deprecated.

Retired ones don't even exist on the portal as they are deleted as soon as you retire the last product that contains that api.

As I said, I think you need to experiment with what happens in the portal with different lifecycle states. Right now all apis will be a member of a published product or a handful might be in a product that is deprecated.

Navigation is primarily around products not apis, the page is listing products not apis. 
When looking at the apis within a product those apis all have the state of the parent product. You don't deprecate an api you deprecate the product that  obtains it. You can't retire an api, you retire the product that contains it.

So if a product is deprecated and that's the only one you're subscribed to then all the apis are deprecated. If the product is published then so are all the apis in it. If the product is retired then it won't exist on the portal anymore, all subs will be deleted and any Apis only in that product will also be deleted.

I dont think your scenario exists in APIC, simply APIs do not have state, products do.

Yes , For Product Deprecating or retired , I get that. for existing user of the product I want to show that now this Product is deprecated.

But For APIs list , yes I am looking for that functionality where APIs are tagged or similar way so that when user is checking the API list under product , these info are there for them.

Or If I want to find deprecated/retired/Active some kind of search or View that I can create based on this data. 

I'm not sure this makes sense to attempt.

Retired products are removed from the portal as they are no longer used so there's no point tagging them with anything, they no longer exist. (This cannot be prevented, it's automatic)

Deprecated products are only visible to someone who is already subscribed to it and inaccessible to everyone else (and are already labeled Deprecated pretty clearly).

I think you might want to have a play around with the APIC lifecycle and the effect on the portal before wasting effort on this further. 

Essentially every product an anonymous user can see is in "published" state.

Hi 

This is my vision and looking for some recommendations or suggestions.

• Tagging Product as Active/Deprecated/Retired. So when User search the products  and Products lists are shown , when Products are shown as Cards , it also has some label showing  Active/Deprecated/Retired. And is there way to color code the Card that Green is active , yellow/orange is Deprecated and Red is retired.
• And similar to Product, I am trying to show or tag these APIs as Deprecated/Retired.
• And once those can be achieved and if these can also provide way to filter based on these Active/Deprecated/retired.
• These I am looking for /product or /api pages.

I know there will be questions asked like retired Product should not be there and that is correct but I am just trying to find a way to tag those.

This could be purely Drupal question but wanted to see if anyone has tried this or any suggestions. 

Basically my use case is I want to show the label Marked as Deprecated when consumers are searching.

And I was able to get this functionality by editing the structure -->content Type -->Product and enable the state to the Card view and now it shows Deprecated on the card view

Deprecated products are already marked deprecated.

An api isn't deprecated, the product it is in is deprecated.

Retired ones don't even exist on the portal as they are deleted as soon as you retire the last product that contains that api.

As I said, I think you need to experiment with what happens in the portal with different lifecycle states. Right now all apis will be a member of a published product or a handful might be in a product that is deprecated.

Navigation is primarily around products not apis, the page is listing products not apis. 
When looking at the apis within a product those apis all have the state of the parent product. You don't deprecate an api you deprecate the product that  obtains it. You can't retire an api, you retire the product that contains it.

So if a product is deprecated and that's the only one you're subscribed to then all the apis are deprecated. If the product is published then so are all the apis in it. If the product is retired then it won't exist on the portal anymore, all subs will be deleted and any Apis only in that product will also be deleted.

I dont think your scenario exists in APIC, simply APIs do not have state, products do.

Yes , For Product Deprecating or retired , I get that. for existing user of the product I want to show that now this Product is deprecated.

But For APIs list , yes I am looking for that functionality where APIs are tagged or similar way so that when user is checking the API list under product , these info are there for them.

Or If I want to find deprecated/retired/Active some kind of search or View that I can create based on this data. 

I'm not sure this makes sense to attempt.

Retired products are removed from the portal as they are no longer used so there's no point tagging them with anything, they no longer exist. (This cannot be prevented, it's automatic)

Deprecated products are only visible to someone who is already subscribed to it and inaccessible to everyone else (and are already labeled Deprecated pretty clearly).

I think you might want to have a play around with the APIC lifecycle and the effect on the portal before wasting effort on this further. 

Essentially every product an anonymous user can see is in "published" state.

Hi 

This is my vision and looking for some recommendations or suggestions.

• Tagging Product as Active/Deprecated/Retired. So when User search the products  and Products lists are shown , when Products are shown as Cards , it also has some label showing  Active/Deprecated/Retired. And is there way to color code the Card that Green is active , yellow/orange is Deprecated and Red is retired.
• And similar to Product, I am trying to show or tag these APIs as Deprecated/Retired.
• And once those can be achieved and if these can also provide way to filter based on these Active/Deprecated/retired.
• These I am looking for /product or /api pages.

I know there will be questions asked like retired Product should not be there and that is correct but I am just trying to find a way to tag those.

This could be purely Drupal question but wanted to see if anyone has tried this or any suggestions. 

I understand what you want to do but it's not really correct.

the api is not deprecated, the product it is in is deprecated not the api. Apis don't have state so I'm not sure how you expect to add labels to it to show an attribute it doesn't have.

swaggertags are something entirely different and aren't going to help you here.

There is no state field on an api that will show deprecated because Apis aren't deprecated so there is no label to show.

Navigation in the portal is product first not api - you start on /products not /apis. If you switch that round in your portal then you do so at the cost of not being able to see the product specific attributes like lifecycle state. Can I suggest you revisit that decision? There is a reason none of our customers do it!

Basically my use case is I want to show the label Marked as Deprecated when consumers are searching.

And I was able to get this functionality by editing the structure -->content Type -->Product and enable the state to the Card view and now it shows Deprecated on the card view

Deprecated products are already marked deprecated.

An api isn't deprecated, the product it is in is deprecated.

Retired ones don't even exist on the portal as they are deleted as soon as you retire the last product that contains that api.

As I said, I think you need to experiment with what happens in the portal with different lifecycle states. Right now all apis will be a member of a published product or a handful might be in a product that is deprecated.

Navigation is primarily around products not apis, the page is listing products not apis. 
When looking at the apis within a product those apis all have the state of the parent product. You don't deprecate an api you deprecate the product that  obtains it. You can't retire an api, you retire the product that contains it.

So if a product is deprecated and that's the only one you're subscribed to then all the apis are deprecated. If the product is published then so are all the apis in it. If the product is retired then it won't exist on the portal anymore, all subs will be deleted and any Apis only in that product will also be deleted.

I dont think your scenario exists in APIC, simply APIs do not have state, products do.

Yes , For Product Deprecating or retired , I get that. for existing user of the product I want to show that now this Product is deprecated.

But For APIs list , yes I am looking for that functionality where APIs are tagged or similar way so that when user is checking the API list under product , these info are there for them.

Or If I want to find deprecated/retired/Active some kind of search or View that I can create based on this data. 

I'm not sure this makes sense to attempt.

Retired products are removed from the portal as they are no longer used so there's no point tagging them with anything, they no longer exist. (This cannot be prevented, it's automatic)

Deprecated products are only visible to someone who is already subscribed to it and inaccessible to everyone else (and are already labeled Deprecated pretty clearly).

I think you might want to have a play around with the APIC lifecycle and the effect on the portal before wasting effort on this further. 

Essentially every product an anonymous user can see is in "published" state.

Hi 

This is my vision and looking for some recommendations or suggestions.

• Tagging Product as Active/Deprecated/Retired. So when User search the products  and Products lists are shown , when Products are shown as Cards , it also has some label showing  Active/Deprecated/Retired. And is there way to color code the Card that Green is active , yellow/orange is Deprecated and Red is retired.
• And similar to Product, I am trying to show or tag these APIs as Deprecated/Retired.
• And once those can be achieved and if these can also provide way to filter based on these Active/Deprecated/retired.
• These I am looking for /product or /api pages.

I know there will be questions asked like retired Product should not be there and that is correct but I am just trying to find a way to tag those.

This could be purely Drupal question but wanted to see if anyone has tried this or any suggestions. 

Thank you Chris. I am completely on the same page as you.

Currently we always have 1 Product version and all the APIs goes into that even multiple version of APIs.

So right now I am researching all the possible ways and best which fits for our organization Product version policy.

I have captured 2-3 ways of doing product versioning and one way is to maintain one Product as Deprecated which contains deprecated APIs and other product as Active which contains all latest APIs. 

but this has issue  like if you end up versioning the APIs more frequent then you end up moving up quickly on the product version, with-in few months you end up on Version 10 of product which does not makes sense for the consumers. because you have to do lot of stuff like migrating the subscription etc.

We don't do minor or patches of the APIs. Its always major version up which is another topic.

So that's why I am trying to explore if there is a way to show a label that says this API is "Deprecated"

Now yes I get that API does not have any state(deprecated/retired etc.) that's why I am trying to find ways and one way I thought of using the "tags" which currently we don't use for any purpose. So that we can tag the API as ACTIVE/DEPRECATED in YAML and this label is shown.

I understand what you want to do but it's not really correct.

the api is not deprecated, the product it is in is deprecated not the api. Apis don't have state so I'm not sure how you expect to add labels to it to show an attribute it doesn't have.

swaggertags are something entirely different and aren't going to help you here.

There is no state field on an api that will show deprecated because Apis aren't deprecated so there is no label to show.

Navigation in the portal is product first not api - you start on /products not /apis. If you switch that round in your portal then you do so at the cost of not being able to see the product specific attributes like lifecycle state. Can I suggest you revisit that decision? There is a reason none of our customers do it!

Basically my use case is I want to show the label Marked as Deprecated when consumers are searching.

And I was able to get this functionality by editing the structure -->content Type -->Product and enable the state to the Card view and now it shows Deprecated on the card view

Deprecated products are already marked deprecated.

An api isn't deprecated, the product it is in is deprecated.

Retired ones don't even exist on the portal as they are deleted as soon as you retire the last product that contains that api.

As I said, I think you need to experiment with what happens in the portal with different lifecycle states. Right now all apis will be a member of a published product or a handful might be in a product that is deprecated.

Navigation is primarily around products not apis, the page is listing products not apis. 
When looking at the apis within a product those apis all have the state of the parent product. You don't deprecate an api you deprecate the product that  obtains it. You can't retire an api, you retire the product that contains it.

So if a product is deprecated and that's the only one you're subscribed to then all the apis are deprecated. If the product is published then so are all the apis in it. If the product is retired then it won't exist on the portal anymore, all subs will be deleted and any Apis only in that product will also be deleted.

I dont think your scenario exists in APIC, simply APIs do not have state, products do.

Yes , For Product Deprecating or retired , I get that. for existing user of the product I want to show that now this Product is deprecated.

But For APIs list , yes I am looking for that functionality where APIs are tagged or similar way so that when user is checking the API list under product , these info are there for them.

Or If I want to find deprecated/retired/Active some kind of search or View that I can create based on this data. 

I'm not sure this makes sense to attempt.

Retired products are removed from the portal as they are no longer used so there's no point tagging them with anything, they no longer exist. (This cannot be prevented, it's automatic)

Deprecated products are only visible to someone who is already subscribed to it and inaccessible to everyone else (and are already labeled Deprecated pretty clearly).

I think you might want to have a play around with the APIC lifecycle and the effect on the portal before wasting effort on this further. 

Essentially every product an anonymous user can see is in "published" state.

Hi 

This is my vision and looking for some recommendations or suggestions.

• Tagging Product as Active/Deprecated/Retired. So when User search the products  and Products lists are shown , when Products are shown as Cards , it also has some label showing  Active/Deprecated/Retired. And is there way to color code the Card that Green is active , yellow/orange is Deprecated and Red is retired.
• And similar to Product, I am trying to show or tag these APIs as Deprecated/Retired.
• And once those can be achieved and if these can also provide way to filter based on these Active/Deprecated/retired.
• These I am looking for /product or /api pages.

I know there will be questions asked like retired Product should not be there and that is correct but I am just trying to find a way to tag those.

This could be purely Drupal question but wanted to see if anyone has tried this or any suggestions. 

I don't think that's a very good plan because you'd only be able to set the yaml tag by updating the api and republishing, it would also be entirely manual and easily forgotten.

maybe look at adding a custom field to the api content type in the portal, then you can set the value whenever you like sepately from publishing new versions. The downside is the same - you'd need to do it separately from publishing the product.

Thank you Chris. I am completely on the same page as you.

Currently we always have 1 Product version and all the APIs goes into that even multiple version of APIs.

So right now I am researching all the possible ways and best which fits for our organization Product version policy.

I have captured 2-3 ways of doing product versioning and one way is to maintain one Product as Deprecated which contains deprecated APIs and other product as Active which contains all latest APIs. 

but this has issue  like if you end up versioning the APIs more frequent then you end up moving up quickly on the product version, with-in few months you end up on Version 10 of product which does not makes sense for the consumers. because you have to do lot of stuff like migrating the subscription etc.

We don't do minor or patches of the APIs. Its always major version up which is another topic.

So that's why I am trying to explore if there is a way to show a label that says this API is "Deprecated"

Now yes I get that API does not have any state(deprecated/retired etc.) that's why I am trying to find ways and one way I thought of using the "tags" which currently we don't use for any purpose. So that we can tag the API as ACTIVE/DEPRECATED in YAML and this label is shown.

I understand what you want to do but it's not really correct.

the api is not deprecated, the product it is in is deprecated not the api. Apis don't have state so I'm not sure how you expect to add labels to it to show an attribute it doesn't have.

swaggertags are something entirely different and aren't going to help you here.

There is no state field on an api that will show deprecated because Apis aren't deprecated so there is no label to show.

Navigation in the portal is product first not api - you start on /products not /apis. If you switch that round in your portal then you do so at the cost of not being able to see the product specific attributes like lifecycle state. Can I suggest you revisit that decision? There is a reason none of our customers do it!

Basically my use case is I want to show the label Marked as Deprecated when consumers are searching.

And I was able to get this functionality by editing the structure -->content Type -->Product and enable the state to the Card view and now it shows Deprecated on the card view

Deprecated products are already marked deprecated.

An api isn't deprecated, the product it is in is deprecated.

Retired ones don't even exist on the portal as they are deleted as soon as you retire the last product that contains that api.

As I said, I think you need to experiment with what happens in the portal with different lifecycle states. Right now all apis will be a member of a published product or a handful might be in a product that is deprecated.

Navigation is primarily around products not apis, the page is listing products not apis. 
When looking at the apis within a product those apis all have the state of the parent product. You don't deprecate an api you deprecate the product that  obtains it. You can't retire an api, you retire the product that contains it.

So if a product is deprecated and that's the only one you're subscribed to then all the apis are deprecated. If the product is published then so are all the apis in it. If the product is retired then it won't exist on the portal anymore, all subs will be deleted and any Apis only in that product will also be deleted.

I dont think your scenario exists in APIC, simply APIs do not have state, products do.

Yes , For Product Deprecating or retired , I get that. for existing user of the product I want to show that now this Product is deprecated.

But For APIs list , yes I am looking for that functionality where APIs are tagged or similar way so that when user is checking the API list under product , these info are there for them.

Or If I want to find deprecated/retired/Active some kind of search or View that I can create based on this data. 

I'm not sure this makes sense to attempt.

Retired products are removed from the portal as they are no longer used so there's no point tagging them with anything, they no longer exist. (This cannot be prevented, it's automatic)

Deprecated products are only visible to someone who is already subscribed to it and inaccessible to everyone else (and are already labeled Deprecated pretty clearly).

I think you might want to have a play around with the APIC lifecycle and the effect on the portal before wasting effort on this further. 

Essentially every product an anonymous user can see is in "published" state.

Hi 

This is my vision and looking for some recommendations or suggestions.

• Tagging Product as Active/Deprecated/Retired. So when User search the products  and Products lists are shown , when Products are shown as Cards , it also has some label showing  Active/Deprecated/Retired. And is there way to color code the Card that Green is active , yellow/orange is Deprecated and Red is retired.
• And similar to Product, I am trying to show or tag these APIs as Deprecated/Retired.
• And once those can be achieved and if these can also provide way to filter based on these Active/Deprecated/retired.
• These I am looking for /product or /api pages.

I know there will be questions asked like retired Product should not be there and that is correct but I am just trying to find a way to tag those.

This could be purely Drupal question but wanted to see if anyone has tried this or any suggestions. 

could you please elaborate on this , i did not fully understand it. >> maybe look at adding a custom field to the api content type in the portal, then you can set the value whenever you like sepately from publishing new versions. 

how and where I will set the value. Are you suggesting via admin tool and update this field to set "Deprecated" after deployment.

I don't think that's a very good plan because you'd only be able to set the yaml tag by updating the api and republishing, it would also be entirely manual and easily forgotten.

maybe look at adding a custom field to the api content type in the portal, then you can set the value whenever you like sepately from publishing new versions. The downside is the same - you'd need to do it separately from publishing the product.

Thank you Chris. I am completely on the same page as you.

Currently we always have 1 Product version and all the APIs goes into that even multiple version of APIs.

So right now I am researching all the possible ways and best which fits for our organization Product version policy.

I have captured 2-3 ways of doing product versioning and one way is to maintain one Product as Deprecated which contains deprecated APIs and other product as Active which contains all latest APIs. 

but this has issue  like if you end up versioning the APIs more frequent then you end up moving up quickly on the product version, with-in few months you end up on Version 10 of product which does not makes sense for the consumers. because you have to do lot of stuff like migrating the subscription etc.

We don't do minor or patches of the APIs. Its always major version up which is another topic.

So that's why I am trying to explore if there is a way to show a label that says this API is "Deprecated"

Now yes I get that API does not have any state(deprecated/retired etc.) that's why I am trying to find ways and one way I thought of using the "tags" which currently we don't use for any purpose. So that we can tag the API as ACTIVE/DEPRECATED in YAML and this label is shown.

I understand what you want to do but it's not really correct.

the api is not deprecated, the product it is in is deprecated not the api. Apis don't have state so I'm not sure how you expect to add labels to it to show an attribute it doesn't have.

swaggertags are something entirely different and aren't going to help you here.

There is no state field on an api that will show deprecated because Apis aren't deprecated so there is no label to show.

Navigation in the portal is product first not api - you start on /products not /apis. If you switch that round in your portal then you do so at the cost of not being able to see the product specific attributes like lifecycle state. Can I suggest you revisit that decision? There is a reason none of our customers do it!

Basically my use case is I want to show the label Marked as Deprecated when consumers are searching.

And I was able to get this functionality by editing the structure -->content Type -->Product and enable the state to the Card view and now it shows Deprecated on the card view

Deprecated products are already marked deprecated.

An api isn't deprecated, the product it is in is deprecated.

Retired ones don't even exist on the portal as they are deleted as soon as you retire the last product that contains that api.

As I said, I think you need to experiment with what happens in the portal with different lifecycle states. Right now all apis will be a member of a published product or a handful might be in a product that is deprecated.

Navigation is primarily around products not apis, the page is listing products not apis. 
When looking at the apis within a product those apis all have the state of the parent product. You don't deprecate an api you deprecate the product that  obtains it. You can't retire an api, you retire the product that contains it.

So if a product is deprecated and that's the only one you're subscribed to then all the apis are deprecated. If the product is published then so are all the apis in it. If the product is retired then it won't exist on the portal anymore, all subs will be deleted and any Apis only in that product will also be deleted.

I dont think your scenario exists in APIC, simply APIs do not have state, products do.

Yes , For Product Deprecating or retired , I get that. for existing user of the product I want to show that now this Product is deprecated.

But For APIs list , yes I am looking for that functionality where APIs are tagged or similar way so that when user is checking the API list under product , these info are there for them.

Or If I want to find deprecated/retired/Active some kind of search or View that I can create based on this data. 

I'm not sure this makes sense to attempt.

Retired products are removed from the portal as they are no longer used so there's no point tagging them with anything, they no longer exist. (This cannot be prevented, it's automatic)

Deprecated products are only visible to someone who is already subscribed to it and inaccessible to everyone else (and are already labeled Deprecated pretty clearly).

I think you might want to have a play around with the APIC lifecycle and the effect on the portal before wasting effort on this further. 

Essentially every product an anonymous user can see is in "published" state.

Hi 

This is my vision and looking for some recommendations or suggestions.

• Tagging Product as Active/Deprecated/Retired. So when User search the products  and Products lists are shown , when Products are shown as Cards , it also has some label showing  Active/Deprecated/Retired. And is there way to color code the Card that Green is active , yellow/orange is Deprecated and Red is retired.
• And similar to Product, I am trying to show or tag these APIs as Deprecated/Retired.
• And once those can be achieved and if these can also provide way to filter based on these Active/Deprecated/retired.
• These I am looking for /product or /api pages.

I know there will be questions asked like retired Product should not be there and that is correct but I am just trying to find a way to tag those.

This could be purely Drupal question but wanted to see if anyone has tried this or any suggestions. 

Yes I was able to do the steps and set the value and it does makes sense. but the only thing is that, this is manual step which is why I am trying to avoid and see if a way to use the 1st option.

could you please elaborate on this , i did not fully understand it. >> maybe look at adding a custom field to the api content type in the portal, then you can set the value whenever you like sepately from publishing new versions. 

how and where I will set the value. Are you suggesting via admin tool and update this field to set "Deprecated" after deployment.

I don't think that's a very good plan because you'd only be able to set the yaml tag by updating the api and republishing, it would also be entirely manual and easily forgotten.

maybe look at adding a custom field to the api content type in the portal, then you can set the value whenever you like sepately from publishing new versions. The downside is the same - you'd need to do it separately from publishing the product.

Thank you Chris. I am completely on the same page as you.

Currently we always have 1 Product version and all the APIs goes into that even multiple version of APIs.

So right now I am researching all the possible ways and best which fits for our organization Product version policy.

I have captured 2-3 ways of doing product versioning and one way is to maintain one Product as Deprecated which contains deprecated APIs and other product as Active which contains all latest APIs. 

but this has issue  like if you end up versioning the APIs more frequent then you end up moving up quickly on the product version, with-in few months you end up on Version 10 of product which does not makes sense for the consumers. because you have to do lot of stuff like migrating the subscription etc.

We don't do minor or patches of the APIs. Its always major version up which is another topic.

So that's why I am trying to explore if there is a way to show a label that says this API is "Deprecated"

Now yes I get that API does not have any state(deprecated/retired etc.) that's why I am trying to find ways and one way I thought of using the "tags" which currently we don't use for any purpose. So that we can tag the API as ACTIVE/DEPRECATED in YAML and this label is shown.

I understand what you want to do but it's not really correct.

the api is not deprecated, the product it is in is deprecated not the api. Apis don't have state so I'm not sure how you expect to add labels to it to show an attribute it doesn't have.

swaggertags are something entirely different and aren't going to help you here.

There is no state field on an api that will show deprecated because Apis aren't deprecated so there is no label to show.

Navigation in the portal is product first not api - you start on /products not /apis. If you switch that round in your portal then you do so at the cost of not being able to see the product specific attributes like lifecycle state. Can I suggest you revisit that decision? There is a reason none of our customers do it!

Basically my use case is I want to show the label Marked as Deprecated when consumers are searching.

And I was able to get this functionality by editing the structure -->content Type -->Product and enable the state to the Card view and now it shows Deprecated on the card view

Deprecated products are already marked deprecated.

An api isn't deprecated, the product it is in is deprecated.

Retired ones don't even exist on the portal as they are deleted as soon as you retire the last product that contains that api.

As I said, I think you need to experiment with what happens in the portal with different lifecycle states. Right now all apis will be a member of a published product or a handful might be in a product that is deprecated.

Navigation is primarily around products not apis, the page is listing products not apis. 
When looking at the apis within a product those apis all have the state of the parent product. You don't deprecate an api you deprecate the product that  obtains it. You can't retire an api, you retire the product that contains it.

So if a product is deprecated and that's the only one you're subscribed to then all the apis are deprecated. If the product is published then so are all the apis in it. If the product is retired then it won't exist on the portal anymore, all subs will be deleted and any Apis only in that product will also be deleted.

I dont think your scenario exists in APIC, simply APIs do not have state, products do.

Yes , For Product Deprecating or retired , I get that. for existing user of the product I want to show that now this Product is deprecated.

But For APIs list , yes I am looking for that functionality where APIs are tagged or similar way so that when user is checking the API list under product , these info are there for them.

Or If I want to find deprecated/retired/Active some kind of search or View that I can create based on this data. 

I'm not sure this makes sense to attempt.

Retired products are removed from the portal as they are no longer used so there's no point tagging them with anything, they no longer exist. (This cannot be prevented, it's automatic)

Deprecated products are only visible to someone who is already subscribed to it and inaccessible to everyone else (and are already labeled Deprecated pretty clearly).

I think you might want to have a play around with the APIC lifecycle and the effect on the portal before wasting effort on this further. 

Essentially every product an anonymous user can see is in "published" state.

Hi 

This is my vision and looking for some recommendations or suggestions.

• Tagging Product as Active/Deprecated/Retired. So when User search the products  and Products lists are shown , when Products are shown as Cards , it also has some label showing  Active/Deprecated/Retired. And is there way to color code the Card that Green is active , yellow/orange is Deprecated and Red is retired.
• And similar to Product, I am trying to show or tag these APIs as Deprecated/Retired.
• And once those can be achieved and if these can also provide way to filter based on these Active/Deprecated/retired.
• These I am looking for /product or /api pages.

I know there will be questions asked like retired Product should not be there and that is correct but I am just trying to find a way to tag those.

This could be purely Drupal question but wanted to see if anyone has tried this or any suggestions. 

You could use a custom module in the portal that uses the update drupal hook for a node of type product. Then every time a product is updated it could check if that product is deprecated, then loop over all the apis in that product and set that custom field you just added.

That would remove the manual step and set the custom field based on the lifecycle state of the parent product. However this isn't going to work if the same API is in multiple products - which is precisely why we do not do anything like this out of the box.

Yes I was able to do the steps and set the value and it does makes sense. but the only thing is that, this is manual step which is why I am trying to avoid and see if a way to use the 1st option.

could you please elaborate on this , i did not fully understand it. >> maybe look at adding a custom field to the api content type in the portal, then you can set the value whenever you like sepately from publishing new versions. 

how and where I will set the value. Are you suggesting via admin tool and update this field to set "Deprecated" after deployment.

I don't think that's a very good plan because you'd only be able to set the yaml tag by updating the api and republishing, it would also be entirely manual and easily forgotten.

maybe look at adding a custom field to the api content type in the portal, then you can set the value whenever you like sepately from publishing new versions. The downside is the same - you'd need to do it separately from publishing the product.

Thank you Chris. I am completely on the same page as you.

Currently we always have 1 Product version and all the APIs goes into that even multiple version of APIs.

So right now I am researching all the possible ways and best which fits for our organization Product version policy.

I have captured 2-3 ways of doing product versioning and one way is to maintain one Product as Deprecated which contains deprecated APIs and other product as Active which contains all latest APIs. 

but this has issue  like if you end up versioning the APIs more frequent then you end up moving up quickly on the product version, with-in few months you end up on Version 10 of product which does not makes sense for the consumers. because you have to do lot of stuff like migrating the subscription etc.

We don't do minor or patches of the APIs. Its always major version up which is another topic.

So that's why I am trying to explore if there is a way to show a label that says this API is "Deprecated"

Now yes I get that API does not have any state(deprecated/retired etc.) that's why I am trying to find ways and one way I thought of using the "tags" which currently we don't use for any purpose. So that we can tag the API as ACTIVE/DEPRECATED in YAML and this label is shown.

I understand what you want to do but it's not really correct.

the api is not deprecated, the product it is in is deprecated not the api. Apis don't have state so I'm not sure how you expect to add labels to it to show an attribute it doesn't have.

swaggertags are something entirely different and aren't going to help you here.

There is no state field on an api that will show deprecated because Apis aren't deprecated so there is no label to show.

Navigation in the portal is product first not api - you start on /products not /apis. If you switch that round in your portal then you do so at the cost of not being able to see the product specific attributes like lifecycle state. Can I suggest you revisit that decision? There is a reason none of our customers do it!

Basically my use case is I want to show the label Marked as Deprecated when consumers are searching.

And I was able to get this functionality by editing the structure -->content Type -->Product and enable the state to the Card view and now it shows Deprecated on the card view

Deprecated products are already marked deprecated.

An api isn't deprecated, the product it is in is deprecated.

Retired ones don't even exist on the portal as they are deleted as soon as you retire the last product that contains that api.

As I said, I think you need to experiment with what happens in the portal with different lifecycle states. Right now all apis will be a member of a published product or a handful might be in a product that is deprecated.

Navigation is primarily around products not apis, the page is listing products not apis. 
When looking at the apis within a product those apis all have the state of the parent product. You don't deprecate an api you deprecate the product that  obtains it. You can't retire an api, you retire the product that contains it.

So if a product is deprecated and that's the only one you're subscribed to then all the apis are deprecated. If the product is published then so are all the apis in it. If the product is retired then it won't exist on the portal anymore, all subs will be deleted and any Apis only in that product will also be deleted.

I dont think your scenario exists in APIC, simply APIs do not have state, products do.

Yes , For Product Deprecating or retired , I get that. for existing user of the product I want to show that now this Product is deprecated.

But For APIs list , yes I am looking for that functionality where APIs are tagged or similar way so that when user is checking the API list under product , these info are there for them.

Or If I want to find deprecated/retired/Active some kind of search or View that I can create based on this data. 

I'm not sure this makes sense to attempt.

Retired products are removed from the portal as they are no longer used so there's no point tagging them with anything, they no longer exist. (This cannot be prevented, it's automatic)

Deprecated products are only visible to someone who is already subscribed to it and inaccessible to everyone else (and are already labeled Deprecated pretty clearly).

I think you might want to have a play around with the APIC lifecycle and the effect on the portal before wasting effort on this further. 

Essentially every product an anonymous user can see is in "published" state.

Hi 

This is my vision and looking for some recommendations or suggestions.

• Tagging Product as Active/Deprecated/Retired. So when User search the products  and Products lists are shown , when Products are shown as Cards , it also has some label showing  Active/Deprecated/Retired. And is there way to color code the Card that Green is active , yellow/orange is Deprecated and Red is retired.
• And similar to Product, I am trying to show or tag these APIs as Deprecated/Retired.
• And once those can be achieved and if these can also provide way to filter based on these Active/Deprecated/retired.
• These I am looking for /product or /api pages.

I know there will be questions asked like retired Product should not be there and that is correct but I am just trying to find a way to tag those.

This could be purely Drupal question but wanted to see if anyone has tried this or any suggestions.