minor: show request method for api endpoint (#17241)

2025-08-26 18:06:03 +00:00 · 2024-07-31 15:42:09 +05:30 · 2024-07-31 15:42:09 +05:30 · a6b63aabaa
commit a6b63aabaa
parent 62c51e284d
15 changed files with 67 additions and 3 deletions
--- a/openmetadata-ui/src/main/resources/ui/src/components/DataAssets/DataAssetsHeader/DataAssetsHeader.component.tsx
+++ b/openmetadata-ui/src/main/resources/ui/src/components/DataAssets/DataAssetsHeader/DataAssetsHeader.component.tsx
@ -82,13 +82,17 @@ import {
 export const ExtraInfoLabel = ({
  label,
  value,
+  dataTestId,
 }: {
  label: string;
  value: string | number;
+  dataTestId?: string;
 }) => (
  <>
    <Divider className="self-center" type="vertical" />
-    <Typography.Text className="self-center text-xs whitespace-nowrap">
+    <Typography.Text
+      className="self-center text-xs whitespace-nowrap"
+      data-testid={dataTestId}>
      {!isEmpty(label) && (
        <span className="text-grey-muted">{`${label}: `}</span>
      )}
--- a/openmetadata-ui/src/main/resources/ui/src/components/DataAssets/DataAssetsHeader/DataAssetsHeader.test.tsx
+++ b/openmetadata-ui/src/main/resources/ui/src/components/DataAssets/DataAssetsHeader/DataAssetsHeader.test.tsx
@ -13,6 +13,10 @@
 import { render, screen } from '@testing-library/react';
 import React from 'react';
 import { EntityType } from '../../../enums/entity.enum';
+import {
+  APIEndpoint,
+  APIRequestMethod,
+} from '../../../generated/entity/data/apiEndpoint';
 import { Container } from '../../../generated/entity/data/container';
 import { MOCK_TIER_DATA } from '../../../mocks/TableData.mock';
 import { getContainerByName } from '../../../rest/storageAPI';
@ -140,4 +144,25 @@ describe('DataAssetsHeader component', () => {

    expect(screen.getByTestId('Tier')).toContainHTML('label.no-entity');
  });
+
+  it('should render the request method if entityType is apiEndpoint', () => {
+    render(
+      <DataAssetsHeader
+        {...mockProps}
+        dataAsset={
+          {
+            name: 'testAPIEndpoint',
+            id: 'testAPIEndpointId',
+            endpointURL: 'testAPIEndpointURL',
+            requestMethod: APIRequestMethod.Get,
+          } as APIEndpoint
+        }
+        entityType={EntityType.API_ENDPOINT}
+      />
+    );
+
+    expect(
+      screen.getByTestId('api-endpoint-request-method')
+    ).toBeInTheDocument();
+  });
 });
--- a/openmetadata-ui/src/main/resources/ui/src/locale/languages/de-de.json
+++ b/openmetadata-ui/src/main/resources/ui/src/locale/languages/de-de.json
@ -944,6 +944,7 @@
    "reply-lowercase": "antwort",
    "reply-lowercase-plural": "antworten",
    "request": "Request",
+    "request-method": "Request Method",
    "request-schema-field": "Request Schema Field",
    "request-tag-plural": "Tag-Anfragen",
    "requirement-plural": "Anforderungen",
--- a/openmetadata-ui/src/main/resources/ui/src/locale/languages/en-us.json
+++ b/openmetadata-ui/src/main/resources/ui/src/locale/languages/en-us.json
@ -944,6 +944,7 @@
    "reply-lowercase": "reply",
    "reply-lowercase-plural": "replies",
    "request": "Request",
+    "request-method": "Request Method",
    "request-schema-field": "Request Schema Field",
    "request-tag-plural": "Request Tags",
    "requirement-plural": "Requirements",
--- a/openmetadata-ui/src/main/resources/ui/src/locale/languages/es-es.json
+++ b/openmetadata-ui/src/main/resources/ui/src/locale/languages/es-es.json
@ -944,6 +944,7 @@
    "reply-lowercase": "respuesta",
    "reply-lowercase-plural": "respuestas",
    "request": "Request",
+    "request-method": "Request Method",
    "request-schema-field": "Request Schema Field",
    "request-tag-plural": "Etiquetas de solicitud",
    "requirement-plural": "Requisitos",
--- a/openmetadata-ui/src/main/resources/ui/src/locale/languages/fr-fr.json
+++ b/openmetadata-ui/src/main/resources/ui/src/locale/languages/fr-fr.json
@ -944,6 +944,7 @@
    "reply-lowercase": "réponse",
    "reply-lowercase-plural": "réponses",
    "request": "Request",
+    "request-method": "Request Method",
    "request-schema-field": "Request Schema Field",
    "request-tag-plural": "Demander l'ajout de tags",
    "requirement-plural": "Critères",
--- a/openmetadata-ui/src/main/resources/ui/src/locale/languages/he-he.json
+++ b/openmetadata-ui/src/main/resources/ui/src/locale/languages/he-he.json
@ -944,6 +944,7 @@
    "reply-lowercase": "תגובה",
    "reply-lowercase-plural": "תגובות",
    "request": "Request",
+    "request-method": "Request Method",
    "request-schema-field": "Request Schema Field",
    "request-tag-plural": "בקשת תגיות",
    "requirement-plural": "דרישות",
--- a/openmetadata-ui/src/main/resources/ui/src/locale/languages/ja-jp.json
+++ b/openmetadata-ui/src/main/resources/ui/src/locale/languages/ja-jp.json
@ -944,6 +944,7 @@
    "reply-lowercase": "返信",
    "reply-lowercase-plural": "返信",
    "request": "Request",
+    "request-method": "Request Method",
    "request-schema-field": "Request Schema Field",
    "request-tag-plural": "タグをリクエスト",
    "requirement-plural": "Requirements",
--- a/openmetadata-ui/src/main/resources/ui/src/locale/languages/nl-nl.json
+++ b/openmetadata-ui/src/main/resources/ui/src/locale/languages/nl-nl.json
@ -944,6 +944,7 @@
    "reply-lowercase": "antwoord",
    "reply-lowercase-plural": "antwoorden",
    "request": "Request",
+    "request-method": "Request Method",
    "request-schema-field": "Request Schema Field",
    "request-tag-plural": "Aanvraagtags",
    "requirement-plural": "Vereisten",
--- a/openmetadata-ui/src/main/resources/ui/src/locale/languages/pt-br.json
+++ b/openmetadata-ui/src/main/resources/ui/src/locale/languages/pt-br.json
@ -944,6 +944,7 @@
    "reply-lowercase": "resposta",
    "reply-lowercase-plural": "respostas",
    "request": "Request",
+    "request-method": "Request Method",
    "request-schema-field": "Request Schema Field",
    "request-tag-plural": "Solicitar Tags",
    "requirement-plural": "Requisitos",
--- a/openmetadata-ui/src/main/resources/ui/src/locale/languages/ru-ru.json
+++ b/openmetadata-ui/src/main/resources/ui/src/locale/languages/ru-ru.json
@ -944,6 +944,7 @@
    "reply-lowercase": "ответить",
    "reply-lowercase-plural": "ответы",
    "request": "Request",
+    "request-method": "Request Method",
    "request-schema-field": "Request Schema Field",
    "request-tag-plural": "Теги запроса",
    "requirement-plural": "Требования",
--- a/openmetadata-ui/src/main/resources/ui/src/locale/languages/zh-cn.json
+++ b/openmetadata-ui/src/main/resources/ui/src/locale/languages/zh-cn.json
@ -944,6 +944,7 @@
    "reply-lowercase": "回复",
    "reply-lowercase-plural": "回复",
    "request": "Request",
+    "request-method": "Request Method",
    "request-schema-field": "Request Schema Field",
    "request-tag-plural": "请求补充标签",
    "requirement-plural": "需求",
--- a/openmetadata-ui/src/main/resources/ui/src/pages/APICollectionPage/APIEndpointsTab.tsx
+++ b/openmetadata-ui/src/main/resources/ui/src/pages/APICollectionPage/APIEndpointsTab.tsx
@ -24,7 +24,7 @@ import NextPrevious from '../../components/common/NextPrevious/NextPrevious';
 import { NextPreviousProps } from '../../components/common/NextPrevious/NextPrevious.interface';
 import RichTextEditorPreviewer from '../../components/common/RichTextEditor/RichTextEditorPreviewer';
 import TableAntd from '../../components/common/Table/Table';
-import { PAGE_SIZE } from '../../constants/constants';
+import { NO_DATA, PAGE_SIZE } from '../../constants/constants';
 import { ERROR_PLACEHOLDER_TYPE } from '../../enums/common.enum';
 import { EntityType } from '../../enums/entity.enum';
 import { APICollection } from '../../generated/entity/data/apiCollection';
@ -75,7 +75,7 @@ function APIEndpointsTab({
        title: t('label.name'),
        dataIndex: 'name',
        key: 'name',
-        width: 500,
+        width: 400,
        render: (_, record: APIEndpoint) => {
          return (
            <div className="d-inline-flex w-max-90">
@ -92,6 +92,15 @@ function APIEndpointsTab({
          );
        },
      },
+      {
+        title: t('label.request-method'),
+        dataIndex: 'requestMethod',
+        key: 'requestMethod',
+
+        render: (requestMethod: APIEndpoint['requestMethod']) => {
+          return <Typography.Text>{requestMethod || NO_DATA}</Typography.Text>;
+        },
+      },
      {
        title: t('label.description'),
        dataIndex: 'description',
--- a/openmetadata-ui/src/main/resources/ui/src/utils/DataAssetsHeader.utils.tsx
+++ b/openmetadata-ui/src/main/resources/ui/src/utils/DataAssetsHeader.utils.tsx
@ -441,6 +441,13 @@ export const getDataAssetsHeaderInfo = (

      returnData.extraInfo = (
        <>
+          {apiEndpoint.requestMethod && (
+            <ExtraInfoLabel
+              dataTestId="api-endpoint-request-method"
+              label={t('label.request-method')}
+              value={apiEndpoint.requestMethod}
+            />
+          )}
          {apiEndpoint.endpointURL && (
            <ExtraInfoLink
              href={apiEndpoint.endpointURL}
--- a/openmetadata-ui/src/main/resources/ui/src/utils/EntityUtils.tsx
+++ b/openmetadata-ui/src/main/resources/ui/src/utils/EntityUtils.tsx
@ -996,6 +996,15 @@ const getApiEndpointOverview = (apiEndpoint: APIEndpoint) => {
        DRAWER_NAVIGATION_OPTIONS.lineage,
      ],
    },
+    {
+      name: i18next.t('label.request-method'),
+      value: apiEndpoint.requestMethod || NO_DATA,
+      isLink: false,
+      visible: [
+        DRAWER_NAVIGATION_OPTIONS.explore,
+        DRAWER_NAVIGATION_OPTIONS.lineage,
+      ],
+    },
  ];

  return overview;