The eMASS client repository (emass_client) maintains the Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) specifications and executables. The executables packages currently provided are: RubyGem, TypeScript Node, and Python.
NOTE: A CLI tool called emasser, has been developed that makes use of the emass_client RubyGem. Additionally, the SAF CLI implements the emass_client npm package.
The eMASS API is documented in YAML and can be viewed utilizing a multitude of visualization tools. Included is a dependency-free (and nice looking) rendering tool for viewing the API specification. The documentation is automatically generated using a Continuos Integration (CI) action redoc-cli command line tool.
This repository allows anyone to visualize and interact with the API’s resources without having any of the implementation logic in place, via hosted or local mock servers. Please reference Developers Instruction on how to setup a local mock server
The executable packages (APIs) generated are used to access eMASS data and functionality by external third-party developers, business partners, or internal departments.
The following emass_client executable packages are generated by this repository:
-
Ruby - The ruby package is hosted and available in the RubyGems.
-
Typescript - The typescript package is hosted and available in the NpmRegistry.
-
Python - The python package is hosted and available in the PyPIRegistry.
Changes to the eMASS clients are made by modifying the eMASS API specification file eMASSRestOpenApi.yaml. Modification to this file triggers the clients' generation actions where all client packages are generated, and published to the appropriate repositories when the PR branch is merged into the main branch.
After either forking or creating a branch for the main repository update the code via a pull request (PR) or directly on the branch.
The proper process for making client code updates are as follows:
-
Step 1 Update the eMASS API specification file
eMASSRestOpenApi.yaml -
Step 2 Make the necessary changes (update the version field) to the clients generation configuration files:
- Ruby (src/openapi/templates/ruby/ruby-generator-config.json)
- Typescript(src/openapi/templates/typescript/typescript-generator-config.json)
- Python (src/openapi/templates/python/python-generator-config.json)
-
Step 3 Push the content to the repository
-
Step 4 Once all test pass merge the pull request
For detail information on how-to generating eMASS clients for other programming languages reference Developers Instructions
The process provided by this repository is depicted by the architecture diagram below. In a nutshell, it hosts the eMAASS API specification, documentation, interactive visualization tools, and generates clients for the following languages: ruby, typescript, and python.
The emass_client executable packages can be included in other projects, or used to generate CLI tools that require access to an eMASS instance as demonstrated by the diagram below.
© 2020 The MITRE Corporation.
Approved for Public Release; Distribution Unlimited. Case Number 18-3678.
MITRE hereby grants express written permission to use, reproduce, distribute, modify, and otherwise leverage this software to the extent permitted by the licensed terms provided in the LICENSE.md file included with this project.
This software was produced for the U. S. Government under Contract Number HHSM-500-2012-00008I, and is subject to Federal Acquisition Regulation Clause 52.227-14, Rights in Data-General.
No other use other than that granted to the U. S. Government, or to those acting on behalf of the U. S. Government under that Clause is authorized without the express written permission of The MITRE Corporation.
For further information, please contact The MITRE Corporation, Contracts Management Office, 7515 Colshire Drive, McLean, VA 22102-7539, (703) 983-6000.