[New Feature]: Health API JSON Schema Update: Add componentType, componentCategory, and description fields

[anilnatha]

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:

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.

NOTE: PLEASE REVIEW THE PROPOSED VALUES BELOW WITH THE UI/UX TEAM, BEFORE PROCEEDING. THESE ARE JUST PROPOSALS AT THIS TIME. Primarily componentType should be reviewed here. componentCategory values are probably okay.

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

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]

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.

[anilnatha]

@galenatjpl Any updates regarding this feature request and if it can be completed in 24.4?

[galenatjpl]

@anilnatha I'm not yet sure if we can complete this in 24.4, but I think it's probable. I just think there are some other larger higher priority tickets still in the kitchen currently

[rtapella]

agreed.
also Description would be great.

[rtapella]

defaults:
componentType: "unknown"
componentCategory: "general"
description: ""

[rtapella]

FIeld Name	Possible Values
componentCategory	administration, catalogs, development, infrastructure, processing, general (default)
componentType	api, ui, unknown (default)

[anilnatha]

@hargitayjpl We added comments above to indicate the default and new list of proposed values

[hargitayjpl]

@anilnatha Thank you, I will make the above changes today and I will create a MC for testing later this week

[hargitayjpl]

@anilnatha
The following changes have been implemented and pushed:

Every new MC will now include three additional fields in its health status response:

• "componentCategory": "general"
• "componentType": "unknown"
• "description": "" These values will be the default going forward.

---

Below is a sample JSON file reflecting these changes:

    "services": [
        {
            "componentName": "Data Catalog",
            "componentCategory": "general",
            "componentType": "unknown",
            "description": "",
            "ssmKey": "/unity/shared-services/component/data-catalog",
            "healthCheckUrl": "https://d3vc8w9zcq658.cloudfront.net/am-uds-dapa/collections",
            "landingPageUrl": "https://www.dev.mdps.mcp.nasa.gov:4443/data/misc/stac_entry",
            "healthChecks": [
                {
                    "status": "HEALTHY",
                    "httpResponseCode": "200",
                    "date": "2025-02-20T01:02:31.270019"
                }
            ]
        },
        {
            "componentName": "Hargitay shared service test",
            "componentCategory": "general",
            "componentType": "unknown",
            "description": "",
            "ssmKey": "/unity/shared-services/component/hargitay/test",
            "healthCheckUrl": "https://www.google.com/",
            "landingPageUrl": "https://www.google.com/",
            "healthChecks": [
                {
                    "status": "HEALTHY",
                    "httpResponseCode": "200",
                    "date": "2025-02-20T01:02:31.807772"
                }
            ]
        },
        {
            "componentName": "Management Console",
            "componentCategory": "general",
            "componentType": "unknown",
            "description": "",
            "ssmKey": "/unity/unity-ui/dev/component/management-console",
            "healthCheckUrl": "https://www.dev.mdps.mcp.nasa.gov:4443/unity-ui/dev/management/api/health_checks",
            "landingPageUrl": "https://www.dev.mdps.mcp.nasa.gov:4443/unity-ui/dev/management/ui/landing",
            "healthChecks": [
                {
                    "status": "HEALTHY",
                    "httpResponseCode": "200",
                    "date": "2025-02-20T01:02:33.070141"
                }
            ]
        }
    ]
}

---

Testing Information
A Management Console has been spun up for Unity-UI testing. It is available at:
Unity-UI Management Console

The UI Dashboard can be accessed here:
UI Health Dashboard

For testing new features, you can install and utilize Unity-UI from this link:
Unity-UI Applications.

You can do this by updating the marketplace file to point to the correct Unity-UI version in the Unity Marketplace repository:
Unity Marketplace - Unity-UI.

[anilnatha]

@hargitayjpl This is great news! Thanks for working on getting this implemented. We'll get started on implementing the changes on our end in this sprint.