From c9180fbf2c9655fefa4071eda1d4b384700bd14e Mon Sep 17 00:00:00 2001 From: Petr Plavjanik Date: Tue, 29 Sep 2020 15:31:25 +0200 Subject: [PATCH] Improvements to the API conformance criteria (#115) Signed-off-by: John Mertic --- .../test_evaluation_guide_table.md | 46 ++++++++++++------- 1 file changed, 30 insertions(+), 16 deletions(-) diff --git a/zowe_conformance/test_evaluation_guide_table.md b/zowe_conformance/test_evaluation_guide_table.md index 1e81633..18259ff 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 @@ -132,7 +132,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas - 8 + 8 Versioned @@ -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,29 +171,36 @@ 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 APIs - 9 + 9 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 @@ -216,10 +223,17 @@ 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 an application that is NOT lifecycled as a Zowe address space /td> + -### API Documentation +### REST API Documentation @@ -253,7 +267,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas - + @@ -261,7 +275,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas - + @@ -281,7 +295,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas
x Every method of each REST endpoint is documentedEvery method of each public REST endpoint is documented
13x Every method of each REST endpoint is demonstrated with an exampleEvery method of each public REST endpoint is demonstrated with an example
14
-### API Naming and Addressing +### REST API Naming and Addressing @@ -337,7 +351,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas - + @@ -345,7 +359,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas - + @@ -353,7 +367,7 @@ These Zowe Conformance criteria are applicable to the lastest Zowe v1 LTS Releas - + @@ -361,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