api-layer icon indicating copy to clipboard operation
api-layer copied to clipboard

Improve onboarding of internal APIs

Open balhar-jakub opened this issue 3 years ago • 3 comments

Use Case

As a System Programmer, I want to ensure that all our internal APIs are available via the API Catalog and that we can benefit from the SSO functionalities and the visualization of all the APIs in the same place.

Acceptance Criteria

  • [ ] As a System Programmer, I will be able to find in the Catalog a way to onboard my services
  • [ ] As a System Programmer, I will be able to recognize the right way to onboard the internal services
  • [ ] As a System Programmer, I will be able to understand how I can save the static file

Notes

  • There will be another button specifically for static onboarding
  • The enablers will be renamed to SDK or some other meaningful way
  • The menu with the options in the API Catalog will be more understandable
  • The wizard for static onboarding will be cleansed from the current bugs
  • When I am in the static wizard I will always see the Save button and if I don't have the rights it will tell me what I need to do to get them.

balhar-jakub avatar Aug 19 '22 13:08 balhar-jakub

Thank you for opening this, my discussions with users would indicate that this is something that would offer value. Should we also distinguish, in the tile view of the catalog, which have been statically onboarded? Visually and/or via some text in the tile? And this label could be used in a search or filter function that could display only internal APIs.

jalel01 avatar Aug 19 '22 14:08 jalel01

I like the idea of being able to search for the APIs onboarded statically. As for actual indication, why not.

balhar-jakub avatar Aug 22 '22 08:08 balhar-jakub

As part of this Epic, the performance of the static onboarding should be verified and optimized to support bulk onboarding in reasonable timeframes.

boris-bc avatar Apr 17 '23 13:04 boris-bc