Content Comparison

NOTE: This is a sample template for the purpose collaborating and soliciting feedback. The actual Zowe Participation Form will involve a DocuSign Form (or equivalent) provided by the Linux Foundation to enable a digital submission.

Complete this form for each Participant (e.g., company or other entity) that desires to participate in the Zowe Conformance Program and to use the Conformance Marks. The Project Word Mark and the Conformance Marks are trademarks of The Linux Foundation. Capitalized terms used herein and not otherwise defined shall have the same meanings set forth in the Program Terms.

By signing below and submitting this form to The Linux Foundation:

...

•  Participant is a member of Open Mainframe Project
•  Participant is NOT a member of the Open Mainframe Project
•  Participant is a non-profit organization.

Participation in the Zowe Conformance Program is free for members of Open Mainframe Project. Other potential Participants should contact the Open Mainframe Project for more information about participation fees.

Qualifying Offerings
Name, brief description and URLs for more information: ____________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

...

Zowe API Mediation layer - 2019

...

Zowe API Mediation Layer Conformance Criteria Check-list:

1) Application Service

...

Zowe Conformance Test Evaluation Guide is a set of self-certify and self-service tests to help the developer community integrate and extend specific technology into the Zowe framework. 

Below are the requirements for the available conformance programs. Items marked (required) are required for achieving conformance in a given program.

Zowe API Mediation layer - 2019

• Application Service
  1. An application provides at least one service or UI

                   Comments:

  2)
  1. (required)
• Register with discovery services

  Select all that apply:

  •  All exposed services of the application are discoverable by the API Mediation Layer Discovery Service
    •  The service is registered by dynamic registration (preferred)
    •  The service is registered by static definition (minimum requirement)
   The service provides
  1. A service must be registered using one of the following methods: (required)

Dynamic registration - preferred (best practice)

Static definition - minimum requirement

1. The service must provide a default service ID that is prefixed by the provider name (for example:

...

1.  `acme`,

...

1.  `xyzcorp`, `bar`). (required)
2. The service ID must be configurable externally after deployment

...

1. . (required)
2. The service ID

...

1. must written in lower case, contain no symbols, and is limited to 64 characters

...

1. . (required)
2. The API ID

...

1. must follow the same rules as for Java packages

...

1. . The example of the API ID: zowe.apiml.apicatalog

...

1. . (required)
2. The published service URL

...

1. must follow the gateway URL conventions

...

1. . (required)
2. For versioned APIs,

...

1. service URLs must contain a service version before the service ID in the following formats:
          - api/v1/{serviceId}

...

1.  reserved for REST APIs

...

1. 
            - ui/v1/{serviceId}

...

1.  reserved for UIs

...

1. 
            - ws/v1/{serviceId}

...

1.  reserved for WebSockets

...

1. 
   For non-versioned APIs or APIs

...

1. versioned differently (e.g. z/OSMF), use the following formats: 
            - api/{serviceId}

...

1.  reserved for REST APIs

...

1. 
            - ui/{serviceId}

...

1.  reserved for UIs
            

...

1. - ws/{serviceId}

...

1.  reserved for WebSockets

...

(required)

• API DocumentationSelect all that apply:
   
  1. Documentation is Swagger/Open API 2.0 compliant
   
  1. . (required)
  2. Every public resource is documented with a description of each resource
   
  1. . (required)
  2. Every method of each REST endpoint is documented
   
  1. . (required)
  2. Every method of each REST endpoint is demonstrated by an example
   
  1. . (required)
  2. Every parameter (headers, query parameters, payload, cookies, etc.) is documented with definitions of all possible values and their associated meanings. (required)
   
  1. Every error code, including errors returned in the payload is documented

  Comments:

  4)
  1. . (required)
  1. API naming and addressing 

     Select all that apply:

     1. Encoded slash is not used
      
     1. . (required)
     2. The service interprets values independent of their URL encoding
      
     1. . (required)
     2. lowerCamelCase is used for names of resources, parameters, and JSON properties
     (preferred)

     Comments:

     5)
     1. .
     1. Service requests and responses
        Select all that apply:
        1. API -
         
        1. Request and response payloads are in JSON or binary data format
        (preferred) 
        1. .
        2. API - In JSON format, links are relative, and must not contain the schema, hostname, and port. (required)
        3. WebSocket -
         
        1. Service URIs contained in WebSocket messages payload are addressed through the API ML Gateway. (required)
        2. UI -
         
        1. UI uses relative links and does not contain the schema, hostname, and port

                         Comments:

        6)
        1. . (required)
     2. Authentication and AuthorizationSelect all that apply:
         
        1. Resources are protected by mainframe credentials
         
        1. . (required)
        2. Services accept basic authentication (minimum requirement)
         
        1. . (required)
        2. Services accept Zowe JWT token in the cookie
        (preferred)

        Comments:

        7)
        1. .
        1. Versioning and Support
           Select all that apply:
            
           1. Service implementation follows the semantic versioning model
           (preferred) The service provider agrees that at least the last
           1. .
           2. Last two major versions are supported by API services
           •  The service provider agrees to support the major service version for at least two years from its release

           Comments:

           8) UI

            
           1. . (required)
           1. UI
              1. UI uses only relative URLs

                              Comments:

              9) WebSocket Services

              Select all that apply:

               
              1. . (required)
           2. WebSocket Services
              1. WebSocket connection creation, all subsequent communication between WebSocket client, and server is routed through the API ML Gateway. (required)
               
              1. WebSocket connections are closed by the initiator through API ML Gateway.

                            Comments

              10) Zowe Version Compatibility

              •  

                The service provider agrees to re-certify when a new version of the conformance criteria is released within 60 days

                                                                                                                                              

              1. (required)

Zowe CLI - 2019

• Please verify and comment where needed that the participating offering has achieved the conformance criteria for Zowe Command Line Interface Conformance Criteria: Test Evaluation Guide

  Summary:

  1) Infrastructure 

  Select all that apply:

  1. Plug-in is constructed on the Imperative CLI Framework
   
  1. . (required)
  2. Plug-in is NOT run as a standalone CLI
   
  1. . (required)
  2. Plug-in commands write to stdout or stderr via Imperative Framework response.console APIs

  Comments:

  2) Installation

  Select all that apply:

   
  1. . (required)
  1. Installation
     1. Plug-in is installable with the zowe plugins install command.
      
     1. (required)
     2. Plug-in is installable into the @lts-incremental version of the core Zowe CLI and follows semantic versioning
      
     1. . (required)
     2. Plug-in is uninstallable via the zowe plugins uninstall command

     Comments:

     3)
     1. . (required)
  2. Naming
      
     1. If the plug-in introduces a command group name, it does not conflict with existing conformant plug-in group names.

     Comments:

     4) Profiles

     Select all that apply:

      
     1. (required)
     1. Profiles 
        1. If the plug-in has unique connection details, it introduces a profile that lets users store these details for repeated use.
                
        1. (
        Preferred
        1. required)
        2. Plug-in users are able to override all profile settings via the command line and/or environment variables.
        Comments:

                                                                                                                                        

Zowe App Framework

...

Summary:

1) Packaging:

Select all that apply:

...

– 2019

• Packaging
  1. Every plugin must have a unique ID. The ID format follows java package naming conventions. The Zowe project reserves org.zowe.
              
  1. (required)
  2. Every plugin and each of its services must have a version.
   
  1. (required)
  2. Directory layout adheres to the ZLUX App filesystem structure.
   
  1. (required)
  2. Source code layout is recommended adheres to the ZLUX App filesystem structure for tooling consistency
  (preferred)                

  Comments:

  2)
  1. .
• Web UIs ALL:
   3)
  1. All Apps must contain an icon image file to represent it, located at web/assets/icon.png within the App's package.

  Comments:

  1. (required)
  1. Web UI IFrame:
      4)
     1. IFrame Apps (apps with framework type "iframe") which embed a top-level iframe within (example: https://github.com/zowe/api-layer/blob/master/zlux-api-catalog/web/index.html) must use the ID "zluxIframe" for that element. This is required for the app to be a recipient of app to app communication.

     Comments:

     1. (required)
     1. Web UI Non-IFrame:Select all that apply:
         
        1. DOM elements originating from your App should always be a child of the Zowe viewport DOM element, "com-rs-mvd-viewport".
         
        1. (required)
        2. Network requests to the Zowe App Server must never be done without the use of the URI Broker.
         
        1. (required)
        2. Access to resources outside the App Server should also be made through the URI Broker whenever possible
        (Preferred)
        1. .
         
        1. Apps must not pollute the global namespace with regards Javascript, HTML, and CSS
         
        1. . (required)
        2. When using a library present in the Zowe App Framework core, you must depend on the same version.
         
        1. (required)
        2. Web apps should extend the framework's default build scripts for webpack and typescript
        (Preferred)
        1. .
        Comments:
        1. 5) UI Design: Apps
            
           1. Apps should follow the UI Design guidelines
           (Preferred).
           

           Comments:

           6)
           1. at https://github.com/zowe/zlc/blob/master/process/UI_GUIDELINES.md
           1. Localization and Internationalization (I10n and I18n): 

              non-IFrame:

              Select all that apply:

              1. The active language to be used for string selection must be retrieved using ZoweZLUX.globalization.getLanguage(), which determines language by multiple factors.
               
              1. (required)
              2. No strings visible in a UI should be hard-coded, rather resource strings must be used in accordance with one of the existing internationalization support mechanisms
              (Preferred)
              1. .
              Comments:
              1. 7) App Server:Select all that apply:
                  
                 1. Data services should be written such that all synchronous and asynchronous errors are caught. Utilize try-catch and check the existence of error objects from asynchronous calls. Uncaught exceptions effect server responsiveness and disrupt clients.
                 
                 

                 Comments:

                 8) Documentation:

                 Select all that apply:

                  
                 1. (required)
                 1. Documentation
                    1. Every HTTP API must be documented in swagger 2.0. The swagger document must be stored in doc/swagger
                     
                    1. . (required)
                    2. In addition, it is recommended to have documentation about the format of any Websocket APIs, to be placed within doc
                    (Preferred)

                    Comments:

                    9) Logging

                    Select all that apply:

                     
                    1. .
                 2. Logging
                    1. An Apps non-IFrame web components, or App Framework dataservices (eg Javascript and Typescript) must log only through the "zlux" logger
                     
                    1. . (required)
                    2. ZSS services log only through the Zowe ZSS Logger
                     
                    1. . (required)
                    2. Passwords must never be logged
                     
                    1. . (required)
                    2. Error reporting should follow the standard tooling
                    (Preferred)

                    Comments:

                    10) Storage

                     
                    1. .
                 3. Storage
                    1. User preferences, if applicable to a plugin, must be stored through the configuration data service.

                    Comments:

                                                                                                                                   

...

• 1. (required)