From 81026483d327ab4e232e2f5a8ac07c88f7dea6c8 Mon Sep 17 00:00:00 2001 From: Carson Cook Date: Mon, 14 Sep 2020 13:19:56 -0400 Subject: [PATCH 1/4] Add reference links to api docs Signed-off-by: Carson Cook --- docs/.vuepress/pages.json | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/.vuepress/pages.json b/docs/.vuepress/pages.json index 96c03ae246..af6f9c89fd 100644 --- a/docs/.vuepress/pages.json +++ b/docs/.vuepress/pages.json @@ -281,6 +281,22 @@ { "text": "Third-Party Software Requirements", "link": "appendix/tpsr.md" + }, + { + "text": "REST API for the Data sets and z/OS Unix Files Services", + "link": "https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/datasets.json" + }, + { + "text": "REST API for the API Gateway service", + "link": "https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/gateway.json" + }, + { + "text": "REST API for the JES Jobs Service", + "link": "https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/jobs.json" + }, + { + "text": "REST API for ZLUX Plugin", + "link": "https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/zlux-plugin.json" } ] } From 0107fc8560a09117b474112d74f12d4bd4293666 Mon Sep 17 00:00:00 2001 From: nannanli Date: Wed, 16 Sep 2020 00:05:27 +0800 Subject: [PATCH 2/4] Update the toc Signed-off-by: nannanli --- docs/.vuepress/pages.json | 22 +++++--------------- docs/appendix/zowe-api-reference.md | 11 ++++++++++ docs/appendix/zowe-cli-commannd-reference.md | 6 ++++++ 3 files changed, 22 insertions(+), 17 deletions(-) create mode 100644 docs/appendix/zowe-api-reference.md create mode 100644 docs/appendix/zowe-cli-commannd-reference.md diff --git a/docs/.vuepress/pages.json b/docs/.vuepress/pages.json index af6f9c89fd..207d447540 100644 --- a/docs/.vuepress/pages.json +++ b/docs/.vuepress/pages.json @@ -272,7 +272,11 @@ "canHideFirst": true, "items": [{ "text": "Zowe CLI command reference", - "link": "#zowe-cli-command-reference-guide" + "link": "appendix/zowe-cli-command-reference.md" + }, + { + "text": "Zowe API reference", + "link": "appendix/zowe-api-reference.md" }, { "text": "Bill of Materials", @@ -281,22 +285,6 @@ { "text": "Third-Party Software Requirements", "link": "appendix/tpsr.md" - }, - { - "text": "REST API for the Data sets and z/OS Unix Files Services", - "link": "https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/datasets.json" - }, - { - "text": "REST API for the API Gateway service", - "link": "https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/gateway.json" - }, - { - "text": "REST API for the JES Jobs Service", - "link": "https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/jobs.json" - }, - { - "text": "REST API for ZLUX Plugin", - "link": "https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/zlux-plugin.json" } ] } diff --git a/docs/appendix/zowe-api-reference.md b/docs/appendix/zowe-api-reference.md new file mode 100644 index 0000000000..485421003d --- /dev/null +++ b/docs/appendix/zowe-api-reference.md @@ -0,0 +1,11 @@ +# Zowe API reference + +Find and learn about the Zowe APIs that you can use. + +- **[REST API for the Data sets and z/OS Unix Files Services](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/datasets.json)** + +- **[REST API for the API Gateway service](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/gateway.json)** + +- **[REST API for the JES Jobs Service](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/jobs.json)** + +- **[REST API for ZLUX Plug-in](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/zowe/docs-site/docs-staging/api_definitions/zlux-plugin.json)** \ No newline at end of file diff --git a/docs/appendix/zowe-cli-commannd-reference.md b/docs/appendix/zowe-cli-commannd-reference.md new file mode 100644 index 0000000000..1082265c53 --- /dev/null +++ b/docs/appendix/zowe-cli-commannd-reference.md @@ -0,0 +1,6 @@ +# Zowe CLI command reference guide + +View detailed documentation on commands, actions, and options in Zowe CLI. The reference document is based on the `@zowe-v1-lts` version of the CLI. You can read an interactive online version, download a PDF document, or download a ZIP file containing the HTML for the online version: +- **[Browse online](../web_help/index.html)** +- **[Download CLI reference in PDF format](../CLIReference_Zowe.pdf)** +- **[Download CLI reference in ZIP format](../zowe_web_help.zip)** \ No newline at end of file From 4242c07fc1ca205052f607ce3da6d8809a129b66 Mon Sep 17 00:00:00 2001 From: nannanli Date: Wed, 16 Sep 2020 00:08:18 +0800 Subject: [PATCH 3/4] Fix link Signed-off-by: nannanli --- docs/.vuepress/pages.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/.vuepress/pages.json b/docs/.vuepress/pages.json index 207d447540..3c7938882b 100644 --- a/docs/.vuepress/pages.json +++ b/docs/.vuepress/pages.json @@ -272,7 +272,7 @@ "canHideFirst": true, "items": [{ "text": "Zowe CLI command reference", - "link": "appendix/zowe-cli-command-reference.md" + "link": "appendix/zowe-cli-commannd-reference.md" }, { "text": "Zowe API reference", From d5f2472e679546f5d11014262ede10f5875cbd3d Mon Sep 17 00:00:00 2001 From: Andrew Jandacek <38347291+janan07@users.noreply.github.com> Date: Wed, 16 Sep 2020 17:33:50 +0200 Subject: [PATCH 4/4] Add ##Zowe API Mediation Layer Single-Sign-On Overview Signed-off-by: Andrew Jandacek --- docs/extend/extend-apiml/api-mediation-security.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/extend/extend-apiml/api-mediation-security.md b/docs/extend/extend-apiml/api-mediation-security.md index c095d6b94d..1e3a69b5c5 100644 --- a/docs/extend/extend-apiml/api-mediation-security.md +++ b/docs/extend/extend-apiml/api-mediation-security.md @@ -1,6 +1,7 @@ # Zowe API Mediation Layer Security - [Zowe API Mediation Layer Security](#zowe-api-mediation-layer-security) + * [Zowe API Mediation Layer Single-Sign-On Overview](#zowe-api-mediation-layer-single-sign-on-overview) * [How API ML transport security works](#how-api-ml-transport-security-works) + [Transport layer security](#transport-layer-security) + [Authentication](#authentication)