From a6b63aabaabfa37c55a7390040fe7466c8a37db6 Mon Sep 17 00:00:00 2001 From: Sachin Chaurasiya Date: Wed, 31 Jul 2024 15:42:09 +0530 Subject: [PATCH] minor: show request method for api endpoint (#17241) --- .../DataAssetsHeader.component.tsx | 6 ++++- .../DataAssetsHeader.test.tsx | 25 +++++++++++++++++++ .../ui/src/locale/languages/de-de.json | 1 + .../ui/src/locale/languages/en-us.json | 1 + .../ui/src/locale/languages/es-es.json | 1 + .../ui/src/locale/languages/fr-fr.json | 1 + .../ui/src/locale/languages/he-he.json | 1 + .../ui/src/locale/languages/ja-jp.json | 1 + .../ui/src/locale/languages/nl-nl.json | 1 + .../ui/src/locale/languages/pt-br.json | 1 + .../ui/src/locale/languages/ru-ru.json | 1 + .../ui/src/locale/languages/zh-cn.json | 1 + .../APICollectionPage/APIEndpointsTab.tsx | 13 ++++++++-- .../ui/src/utils/DataAssetsHeader.utils.tsx | 7 ++++++ .../resources/ui/src/utils/EntityUtils.tsx | 9 +++++++ 15 files changed, 67 insertions(+), 3 deletions(-) diff --git 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 index a97c75f449f..b5546c70d05 100644 --- 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; }) => ( <> - + {!isEmpty(label) && ( {`${label}: `} )} diff --git 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 index b9acfac4af9..84d2d0e3083 100644 --- 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( + + ); + + expect( + screen.getByTestId('api-endpoint-request-method') + ).toBeInTheDocument(); + }); }); diff --git 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 index 2da0f27421a..c71f58b7292 100644 --- 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", diff --git 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 index 703c516c7b1..e9da273eec3 100644 --- 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", diff --git 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 index b0975529275..172586b9a50 100644 --- 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", diff --git 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 index 90692df2336..a7ea68ce7d6 100644 --- 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", diff --git 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 index 40515b3ea62..4aeafb5541b 100644 --- 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": "דרישות", diff --git 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 index 9e424f27e2b..2c716fe7f0d 100644 --- 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", diff --git 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 index 318e916ad79..71bae09674c 100644 --- 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", diff --git 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 index b675b3f91fe..fa94ab94e77 100644 --- 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", diff --git 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 index 65e5485d8fc..70a12ee857a 100644 --- 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": "Требования", diff --git 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 index 8e4264e905a..d5eaddf03d3 100644 --- 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": "需求", diff --git a/openmetadata-ui/src/main/resources/ui/src/pages/APICollectionPage/APIEndpointsTab.tsx b/openmetadata-ui/src/main/resources/ui/src/pages/APICollectionPage/APIEndpointsTab.tsx index 01a528f417e..af02fca7bb3 100644 --- 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 (
@@ -92,6 +92,15 @@ function APIEndpointsTab({ ); }, }, + { + title: t('label.request-method'), + dataIndex: 'requestMethod', + key: 'requestMethod', + + render: (requestMethod: APIEndpoint['requestMethod']) => { + return {requestMethod || NO_DATA}; + }, + }, { title: t('label.description'), dataIndex: 'description', diff --git a/openmetadata-ui/src/main/resources/ui/src/utils/DataAssetsHeader.utils.tsx b/openmetadata-ui/src/main/resources/ui/src/utils/DataAssetsHeader.utils.tsx index 5e4f331e038..d545acf7605 100644 --- 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 && ( + + )} {apiEndpoint.endpointURL && ( { 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;