From 840f6bf20ad39f3908f479801d282d7f8c23a7f8 Mon Sep 17 00:00:00 2001 From: Petr Plavjanik Date: Fri, 14 Aug 2020 09:57:27 +0200 Subject: [PATCH 1/9] Fix wrong usage of UI instead of API --- zowe_conformance/test_evaluation_guide_table.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zowe_conformance/test_evaluation_guide_table.md b/zowe_conformance/test_evaluation_guide_table.md index 6bf5794..6e214db 100644 --- a/zowe_conformance/test_evaluation_guide_table.md +++ b/zowe_conformance/test_evaluation_guide_table.md @@ -60,7 +60,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas x - An application service provides at least one service UI registered with discovery services + The product or applications that extends Zowe API ML must provide at least one API service registered with the Zowe API ML Discovery Service From 5fd74d0b1bb28739b11d30c5837bfd0bc9d333d0 Mon Sep 17 00:00:00 2001 From: Petr Plavjanik Date: Fri, 14 Aug 2020 11:31:30 +0200 Subject: [PATCH 2/9] Reserve URL for GraphQL --- zowe_conformance/test_evaluation_guide_table.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/zowe_conformance/test_evaluation_guide_table.md b/zowe_conformance/test_evaluation_guide_table.md index 6e214db..feb1c0e 100644 --- a/zowe_conformance/test_evaluation_guide_table.md +++ b/zowe_conformance/test_evaluation_guide_table.md @@ -187,6 +187,13 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas - ws/{serviceId} reserved for WebSockets + + v1 + x + + + - graphql/{serviceId} reserved for GraphQL + 9 From ab2566fd906579e15d52c1535807d37d84bdc741 Mon Sep 17 00:00:00 2001 From: Petr Plavjanik Date: Fri, 14 Aug 2020 11:34:12 +0200 Subject: [PATCH 3/9] Documentation criteria apply to public endpoints --- zowe_conformance/test_evaluation_guide_table.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/zowe_conformance/test_evaluation_guide_table.md b/zowe_conformance/test_evaluation_guide_table.md index feb1c0e..6dc1d83 100644 --- a/zowe_conformance/test_evaluation_guide_table.md +++ b/zowe_conformance/test_evaluation_guide_table.md @@ -260,7 +260,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas x - Every method of each REST endpoint is documented + Every method of each public REST endpoint is documented 13 @@ -268,7 +268,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas x - Every method of each REST endpoint is demonstrated with an example + Every method of each public REST endpoint is demonstrated with an example 14 From 3fce7b592f4ac2e77641b9360e4408299847e74a Mon Sep 17 00:00:00 2001 From: Petr Plavjanik Date: Fri, 14 Aug 2020 11:37:51 +0200 Subject: [PATCH 4/9] Allow registration of applications that are not lifecycled by Zowe --- zowe_conformance/test_evaluation_guide_table.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/zowe_conformance/test_evaluation_guide_table.md b/zowe_conformance/test_evaluation_guide_table.md index 6dc1d83..a0fffb3 100644 --- a/zowe_conformance/test_evaluation_guide_table.md +++ b/zowe_conformance/test_evaluation_guide_table.md @@ -223,6 +223,13 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas c. Adding the path of a launch component to the instance.env file for the Zowe workspace + + v1 + x + + + d. Dynamic registration of application that is NOT lifecycled as a Zowe address space /td> + From 74e4074880f7cb4b26e5cef47bf0d1ecb9ad1a0e Mon Sep 17 00:00:00 2001 From: Petr Plavjanik Date: Fri, 14 Aug 2020 11:40:00 +0200 Subject: [PATCH 5/9] Fix formatting --- zowe_conformance/test_evaluation_guide_table.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zowe_conformance/test_evaluation_guide_table.md b/zowe_conformance/test_evaluation_guide_table.md index a0fffb3..c1c1c0f 100644 --- a/zowe_conformance/test_evaluation_guide_table.md +++ b/zowe_conformance/test_evaluation_guide_table.md @@ -132,7 +132,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas - 8 + 8 Versioned From cedaa99db2f2f82b53cd4784a7c9e7593b8009c5 Mon Sep 17 00:00:00 2001 From: Petr Plavjanik Date: Fri, 14 Aug 2020 11:41:21 +0200 Subject: [PATCH 6/9] Fix formatting --- zowe_conformance/test_evaluation_guide_table.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/zowe_conformance/test_evaluation_guide_table.md b/zowe_conformance/test_evaluation_guide_table.md index c1c1c0f..78b00d5 100644 --- a/zowe_conformance/test_evaluation_guide_table.md +++ b/zowe_conformance/test_evaluation_guide_table.md @@ -144,7 +144,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas x - - api/v1/{serviceId} reserved for REST APIs + - api/v1/{serviceId} reserved for REST APIs v1 @@ -171,32 +171,32 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas x - - api/{serviceId} reserved for REST APIs + - api/{serviceId} reserved for REST APIs v1 x - - ui/{serviceId} reserved for UIs + - ui/{serviceId} reserved for UIs v1 x - - ws/{serviceId} reserved for WebSockets + - ws/{serviceId} reserved for WebSockets v1 x - - graphql/{serviceId} reserved for GraphQL + - graphql/{serviceId} reserved for GraphQL - 9 + 9 Mark (a) or (b) or (c) From 7c91a0dc377d5a6cfa8e4cd84ddf7bb9a209d614 Mon Sep 17 00:00:00 2001 From: Petr Plavjanik Date: Fri, 14 Aug 2020 11:47:45 +0200 Subject: [PATCH 7/9] List all optons --- zowe_conformance/test_evaluation_guide_table.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zowe_conformance/test_evaluation_guide_table.md b/zowe_conformance/test_evaluation_guide_table.md index 78b00d5..21b221c 100644 --- a/zowe_conformance/test_evaluation_guide_table.md +++ b/zowe_conformance/test_evaluation_guide_table.md @@ -200,7 +200,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas Mark (a) or (b) or (c) - Registration of the service must not be performed by modifying the Zowe runtime directory api-defs folder. Supported methods include:

(Mark which one applies _a_, _b_, or _c_) + Registration of the service must not be performed by modifying the Zowe runtime directory api-defs folder. Supported methods include:

(Mark which one applies _a_, _b_, _c_, or _d_) v1 From 02986d19471e9a9913161ede4669a26f5b5f2f6a Mon Sep 17 00:00:00 2001 From: Petr Plavjanik Date: Fri, 14 Aug 2020 11:56:44 +0200 Subject: [PATCH 8/9] More specific wording --- zowe_conformance/test_evaluation_guide_table.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/zowe_conformance/test_evaluation_guide_table.md b/zowe_conformance/test_evaluation_guide_table.md index 21b221c..54a5baf 100644 --- a/zowe_conformance/test_evaluation_guide_table.md +++ b/zowe_conformance/test_evaluation_guide_table.md @@ -192,7 +192,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas x - - graphql/{serviceId} reserved for GraphQL + - graphql/{serviceId} reserved for GraphQL APIs @@ -233,7 +233,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas -### API Documentation +### REST API Documentation @@ -295,7 +295,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas
-### API Naming and Addressing +### REST API Naming and Addressing @@ -351,7 +351,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas - + @@ -359,7 +359,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas - + @@ -367,7 +367,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas - + @@ -375,7 +375,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas - +
x API - Request and response payloads are in JSON or binary data formatREST API - Request and response payloads are in JSON or binary data format
20x API - in JSON format, use relative links, and must not contain schema, hostname, and port. Alternatively, an absolute link can be used, in which case the service must translate the link to the form that goes through the Gateway that is based on the X-Forwarded-* HeadersREST API - in JSON format, use relative links, and must not contain schema, hostname, and port. Alternatively, an absolute link can be used, in which case the service must translate the link to the form that goes through the Gateway that is based on the X-Forwarded-* Headers
21x WebSocket - Service URIs contained in WebSocket messages payload are addressed through the API ML GatewayWebSocket (if applicable) - Service URIs contained in WebSocket messages payload are addressed through the API ML Gateway
22x UI - The UI uses relative links and does not contain the schema, hostname, and port. Alternatively an absolute link can be used, in which case the service must translate the link to the form that goes through the Gateway that is based on the X-Forwarded-* HeadersUI (if applicable) - The UI uses relative links and does not contain the schema, hostname, and port. Alternatively an absolute link can be used, in which case the service must translate the link to the form that goes through the Gateway that is based on the X-Forwarded-* Headers
From f4c37ed1a6021ffd39eb447a945fcdff7bdb3080 Mon Sep 17 00:00:00 2001 From: Petr Plavjanik Date: Tue, 25 Aug 2020 14:40:21 +0200 Subject: [PATCH 9/9] Add a missing article --- zowe_conformance/test_evaluation_guide_table.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zowe_conformance/test_evaluation_guide_table.md b/zowe_conformance/test_evaluation_guide_table.md index 54a5baf..06d4797 100644 --- a/zowe_conformance/test_evaluation_guide_table.md +++ b/zowe_conformance/test_evaluation_guide_table.md @@ -228,7 +228,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas x - d. Dynamic registration of application that is NOT lifecycled as a Zowe address space /td> + d. Dynamic registration of an application that is NOT lifecycled as a Zowe address space /td>