jscheffl commented on code in PR #39899:
URL: https://github.com/apache/airflow/pull/39899#discussion_r1617835374
##########
airflow/api_connexion/openapi/v1.yaml:
##########
@@ -4124,6 +4124,14 @@ components:
readOnly: true
items:
type: string
+ doc_md:
+ type: string
+ readOnly: true
+ nullable: true
+ description: |
+ Task documentation.
Review Comment:
```suggestion
Task documentation in markdown.
```
##########
airflow/www/static/js/dag/details/taskInstance/TaskDocumentation.tsx:
##########
@@ -0,0 +1,83 @@
+/*!
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import React from "react";
+import {
+ Accordion,
+ AccordionItem,
+ AccordionButton,
+ AccordionPanel,
+ AccordionIcon,
+ Alert,
+ AlertIcon,
+ Box,
+ Spinner,
+ Text,
+} from "@chakra-ui/react";
+
+import { useTaskDetail } from "src/api";
+import ReactMarkdown from "src/components/ReactMarkdown";
+
+interface Props {
+ taskId: string;
+}
+
+const TaskDocumentation = ({ taskId }: Props) => {
+ const { data, isLoading, error } = useTaskDetail({
+ taskId,
+ });
+
+ if (isLoading) {
+ return <Spinner size="md" thickness="4px" speed="0.65s" />;
+ }
+
+ if (error) {
+ return (
+ <Alert status="error" marginBottom="10px">
+ <AlertIcon />
+ An error occurred while fetching task documentation.
+ </Alert>
+ );
+ }
+
+ if (data && data.docMd) {
+ return (
+ <Box mt={3} flexGrow={1}>
+ <Accordion defaultIndex={[0]} allowToggle>
+ <AccordionItem>
+ <AccordionButton p={0} fontSize="inherit">
+ <Box flex="1" textAlign="left">
+ <Text as="strong" size="lg">
+ Task Documentation:
Review Comment:
Small nit, would propose headline without colon.
```suggestion
Task Documentation
```
##########
airflow/www/static/js/api/useTaskDetail.tsx:
##########
@@ -0,0 +1,34 @@
+/*!
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import axios, { AxiosResponse } from "axios";
+import type { API } from "src/types";
+import { useQuery } from "react-query";
+import { getMetaValue } from "../utils";
+
+const taskDetailURI = getMetaValue("task_detail_api");
+
+export default function useTaskDetail({ taskId }: { taskId: string }) {
+ return useQuery(["taskDetails", taskId], async () => {
+ const url = taskDetailURI.replace("_TASK_ID_", taskId);
+
+ const datum = await axios.get<AxiosResponse, API.Task>(url);
+ return datum;
Review Comment:
Small nit, does it make sense to define a const just to return the same? Can
be a one-liner
```suggestion
return await axios.get<AxiosResponse, API.Task>(url);
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
