As a modern programmer I want to easily find the APIs relevant to my work

[balhar-jakub]

Is your feature request related to a problem? Please describe.
As a modern programmer, I am expected to provide the infrastructure application to simplify the deployment of the new applications into the dev, test, and production environments removing any manual steps along the route.

I am not coming originally from a mainframe environment and as such, I am not certain what APIs and services are available. At the moment I usually need to reach out to more experienced mainframe engineers and ask for their help.

Describe the solution you'd like
I want to be able to find what I need via self-service. I want to easily find what services and APIs are available, what's their purpose and how I can use them.

I am ok with using google and other searches to look for the options and details but ideally, I would find the information in a place where I will be able to directly verify the usage of the APIs.

Acceptance Criteria

• I am able to find what endpoint on which service I need to use to get a specific commit from my code base without needing to consult more experienced developers

[CarsonCook]

This will include a search through swagger documents, we should cache search results or pre-tag the swagger docs so each search doesn't result in a search through every swagger doc every time. This could be done after an easier implementation that does a full search every time.

We already cache swagger docs themselves, we will leverage this and add them to the cache if they are missing during a search.

[CarsonCook]

This could also include keywords added in the onboarded service's config

[taban03]

The swagger-ui team has introduced the filter by tags functionality starting from version 4.1.0.
We will have to update the library to at least v4.0.0 for the code snippet generator anyway, so we can bump it up at at least 4.1.0 and use the filter prop

[taban03]

This branch shows the new search functionality in the Swagger UI. However it is very limited, allowing to search the APIs only by tags.

But the functionality can be extended via plugins, to filter for instance also based on path, summary (title) and description, as shown here.

A possible further improvement would be to improve the generic search bar in the Dashboard, to provide something similar to what is done in Zowe.org, so that the user can search over all the APIs directly from the Dashboard and can be redirected to the correct Service APIs based on the result of the search action.

[balhar-jakub]

It will be improved, but not in this issue.