[jira] [Comment Edited] (FLINK-29208) Logs and stdout endpoints not mentioned in Docs or OpenAPI spec

["Lijie Wang (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FLINK-29208?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17628170#comment-17628170 ] 

Lijie Wang edited comment on FLINK-29208 at 11/3/22 7:57 AM:
-------------------------------------------------------------

I found that "{*}{{logs"}}{*} already exists in REST API Docs ([link|https://nightlies.apache.org/flink/flink-docs-master/docs/ops/rest_api/#jobmanager-logs]) and OpenAPI spec ([link|https://nightlies.apache.org/flink/flink-docs-master/generated/rest_v1_dispatcher.yml#:~:text=components/schemas/EnvironmentInfo%27-,/jobmanager/logs%3A,-get%3A%0A%20%20%20%20%20%20description%3A%20Returns]). But the "{*}{{stdout}}{*}" does not, I can help to see why and add it :).


was (Author: wanglijie95):
I found that "{*}{{logs"}}{*} already exists in REST API Docs ([link|https://nightlies.apache.org/flink/flink-docs-master/docs/ops/rest_api/#jobmanager-logs]) and OpenAPI spec ([link|https://nightlies.apache.org/flink/flink-docs-master/generated/rest_v1_dispatcher.yml#:~:text=components/schemas/EnvironmentInfo%27-,/jobmanager/logs%3A,-get%3A%0A%20%20%20%20%20%20description%3A%20Returns]). But the "{*}{{stdout}}{*}" does not, I can help to see why and add it.

> Logs and stdout endpoints not mentioned in Docs or OpenAPI spec
> ---------------------------------------------------------------
>
>                 Key: FLINK-29208
>                 URL: https://issues.apache.org/jira/browse/FLINK-29208
>             Project: Flink
>          Issue Type: Bug
>          Components: Runtime / REST
>    Affects Versions: 1.16.0, 1.15.2
>            Reporter: Nico Kruber
>            Priority: Major
>
> Using Flink's web UI and clicking on "Stdout" or "Logs" in a JM or TM accesses endpoints {{/jobmanager/logs}} and {{/jobmanager/stdout}} (and similar for TMs) but these don't seem to exist in the [REST API docs|https://nightlies.apache.org/flink/flink-docs-master/docs/ops/rest_api/] or the [REST API OpenAPI spec|https://nightlies.apache.org/flink/flink-docs-master/generated/rest_v1_dispatcher.yml].
> Either these should become some webui-internal APIs (for which no concept exists at the moment), or these endpoints should be added to the docs and spec.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)