You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ch...@apache.org on 2022/02/09 13:03:22 UTC
[flink] branch master updated: [FLINK-26046][rest][docs] Fix link to OpenAPI spec
This is an automated email from the ASF dual-hosted git repository.
chesnay pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new 7c348db [FLINK-26046][rest][docs] Fix link to OpenAPI spec
7c348db is described below
commit 7c348db09485902604bb1fca20d0fc86d19975ec
Author: Chesnay Schepler <ch...@apache.org>
AuthorDate: Wed Feb 9 10:26:10 2022 +0100
[FLINK-26046][rest][docs] Fix link to OpenAPI spec
---
docs/content.zh/docs/ops/rest_api.md | 2 +-
docs/content/docs/ops/rest_api.md | 2 +-
docs/layouts/shortcodes/ref_static.html | 21 +++++++++++++++++++++
3 files changed, 23 insertions(+), 2 deletions(-)
diff --git a/docs/content.zh/docs/ops/rest_api.md b/docs/content.zh/docs/ops/rest_api.md
index 765cba7..8ee9c2c 100644
--- a/docs/content.zh/docs/ops/rest_api.md
+++ b/docs/content.zh/docs/ops/rest_api.md
@@ -67,7 +67,7 @@ Flink 具有监控 API ,可用于查询正在运行的作业以及最近完成
### JobManager
-[OpenAPI specification](/generated/rest_v1_dispatcher.yml)
+[OpenAPI specification]({{< ref_static "generated/rest_v1_dispatcher.yml" >}})
{{< hint warning >}}
The OpenAPI specification is still experimental.
diff --git a/docs/content/docs/ops/rest_api.md b/docs/content/docs/ops/rest_api.md
index 4fb16e4..bc61beb 100644
--- a/docs/content/docs/ops/rest_api.md
+++ b/docs/content/docs/ops/rest_api.md
@@ -74,7 +74,7 @@ The retry is only safe until the [async operation store duration]({{< ref "docs/
### JobManager
-[OpenAPI specification](/generated/rest_v1_dispatcher.yml)
+[OpenAPI specification]({{< ref_static "generated/rest_v1_dispatcher.yml" >}})
{{< hint warning >}}
The OpenAPI specification is still experimental.
diff --git a/docs/layouts/shortcodes/ref_static.html b/docs/layouts/shortcodes/ref_static.html
new file mode 100644
index 0000000..797d25c
--- /dev/null
+++ b/docs/layouts/shortcodes/ref_static.html
@@ -0,0 +1,21 @@
+{{/*
+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.
+*/}}{{/*
+ Shortcode for embedding a link to a static resource.
+*/}}
+{{ .Site.BaseURL }}{{ .Get 0 }}