search

unity-sds / unity-cs

Unity Common Services
Apache License 2.0
0 stars 2 forks source link

[New Feature]: Health API JSON Schema Update: Add componentType and componentCategory #479

Open anilnatha opened 1 week ago

anilnatha commented 1 week ago

Checked for duplicates

Have you checked for duplicate issue tickets?

Yes.

Alternatives considered

Have you considered alternative solutions to your feature request?

No.

Related problems

Is your feature request related to any problems? Please help us understand if so, including linking to any other issue tickets.

The UI/UX team had originally designed the UI's navbar to have categories to help organize links in the navbar and make it easier for users to find what they are looking for.

In addition, we expect the health API to include services (e.g. APIs, etc.) that a user wouldn't typically navigate to in a browser. So, we would need to know which of those items returned by the health API endpoint are items that have a UI the user should access.

Here is an example screenshot of the originally proposed navbar design:

image



Describe the feature request

The UI/UX team would like to propose the addition of two new fields that when filled in, helps bucket components into meaningful categories in the UI's navbar and help inform us of what should be added to the navbar as a navigable item. The values set in this field should be restricted to a specific set of values and those listed below are to get the conversation started on what the values should be.

FIeld Name Possible Values
componentCategory administration, catalogs, development, infrastructure, processing
componentType api, ui, service

Example: 

{
    "componentName": "Management Console",
        "componentCategory": "administration",
        "componentType": "ui",
    "ssmKey": "/unity/ramesh/hc1/component/management-console",
    ...
},
{
    "componentName": "Health API",
        "componentCategory": "infrastructure",
        "componentType": "api",
    "ssmKey": "/unity/ramesh/hc1/component/management-console",
    ...
}

@rtapella Please chime in on what I have posted above to ensure the accuracy of the request and fill in any missing details, and if we want to add/change the list of possible values for each of the fields.

anilnatha commented 1 week ago

A comment regarding

And we also would like to be able to know which items returned by the endpoint should be added to the navbar so that the health endpoint isn't restricted to only reporting on services that a user can navigate to in a browser.

Only those components that have their componentType set to ui would be added to the navbar. In addition, on the health dashboard, we could potentially add these two fields listing the components category and type.