Skip to content

Commit

Permalink
Continuous Integration Build Artifacts (eMASS Clients)
Browse files Browse the repository at this point in the history
  • Loading branch information
georgedias committed Oct 7, 2022
1 parent 6b59323 commit e1c24e6
Show file tree
Hide file tree
Showing 251 changed files with 282 additions and 305 deletions.
2 changes: 1 addition & 1 deletion src/ruby_client/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
6.1.1-SNAPSHOT
6.2.1-SNAPSHOT
2 changes: 1 addition & 1 deletion src/ruby_client/.travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ script:
- bundle install --path vendor/bundle
- bundle exec rspec
- gem build emass_client.gemspec
- gem install ./emass_client-3.4.0.gem
- gem install ./emass_client-3.4.1.gem
8 changes: 4 additions & 4 deletions src/ruby_client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ To establish an account with eMASS and/or acquire an api-key/user-uid, contact o
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v3.4
- Package version: 3.4.0
- Package version: 3.4.1
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
For more information, please visit [https://www.dcsa.mil/is/emass/](https://www.dcsa.mil/is/emass/)

Expand All @@ -71,16 +71,16 @@ gem build emass_client.gemspec
Then either install the gem locally:

```shell
gem install ./emass_client-3.4.0.gem
gem install ./emass_client-3.4.1.gem
```

(for development, run `gem install --dev ./emass_client-3.4.0.gem` to install the development dependencies)
(for development, run `gem install --dev ./emass_client-3.4.1.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

gem 'emass_client', '~> 3.4.0'
gem 'emass_client', '~> 3.4.1'

### Install from Git

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/docs/RegisterData.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
require 'emass_client'

instance = EmassClient::RegisterData.new(
apikey: f32516cc-57d3-43f5-9e16-8f86780a4cce
apikey: f0126b6b-f232-45c9-a8de-01d5f003deda
)
```

17 changes: 7 additions & 10 deletions src/ruby_client/docs/RegistrationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ All URIs are relative to *http://localhost:4010*

## register_user

> <Register> register_user(register_user_request_post_body)
> <Register> register_user
Register user certificate and obtain an API key

Returns the api-key - This API key must be provided in the request header for all endpoint calls (api-key).
Returns the API Key (api-key) that must be provided in the request header for all endpoint calls.

### Examples

Expand All @@ -39,11 +39,10 @@ EmassClient.configure do |config|
end

api_instance = EmassClient::RegistrationApi.new
register_user_request_post_body = EmassClient::RegisterUserRequestPostBody.new({user_uid: 'MY.USERUUID.KEY'}) # RegisterUserRequestPostBody | Register certificate provided by eMASS.

begin
# Register user certificate and obtain an API key
result = api_instance.register_user(register_user_request_post_body)
result = api_instance.register_user
p result
rescue EmassClient::ApiError => e
puts "Error when calling RegistrationApi->register_user: #{e}"
Expand All @@ -54,12 +53,12 @@ end

This returns an Array which contains the response data, status code and headers.

> <Array(<Register>, Integer, Hash)> register_user_with_http_info(register_user_request_post_body)
> <Array(<Register>, Integer, Hash)> register_user_with_http_info
```ruby
begin
# Register user certificate and obtain an API key
data, status_code, headers = api_instance.register_user_with_http_info(register_user_request_post_body)
data, status_code, headers = api_instance.register_user_with_http_info
p status_code # => 2xx
p headers # => { ... }
p data # => <Register>
Expand All @@ -70,9 +69,7 @@ end

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **register_user_request_post_body** | [**RegisterUserRequestPostBody**](RegisterUserRequestPostBody.md) | Register certificate provided by eMASS. | |
This endpoint does not need any parameter.

### Return type

Expand All @@ -84,6 +81,6 @@ end

### HTTP request headers

- **Content-Type**: application/json
- **Content-Type**: Not defined
- **Accept**: application/json

5 changes: 3 additions & 2 deletions src/ruby_client/emass_client.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand All @@ -23,7 +23,8 @@ Gem::Specification.new do |s|
s.email = ["disa.meade.id.mbx.emass-tier-iii-support@mail.mil"]
s.homepage = "https://openapi-generator.tech"
s.summary = "Enterprise Mission Assurance Support Service (eMASS) Ruby Gem"
s.description = "The Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API requires a client certificate (SSL/TLS, DoD PKI only). Use the `Registration` endpoint to register the client certificate.</br></br> Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key. The API key must be provided in the request header for all endpoint calls (api-key). If the service receives an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br> <strong>Available Request Headers</strong></br> <table> <tr> <th align=left>key</th> <th align=left>Example Value</th> <th align=left>Description</th> </tr> <tr> <td>`api-key`</td> <td>api-key-provided-by-emass</td> <td>This API key must be provided in the request header for all endpoint calls</td> </tr> <tr> <td>`user-uid`</td> <td>USER.UID.KEY</td> <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td> </tr> <tr> <td></td><td></td> <td> Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC </td> </tr> </table> </br><strong>Approve API Client for Actionable Requests</strong></br> Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions. Please note that leaving a field parameter blank (for PUT/POST requests) has the potential to clear information in the active eMASS records. To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC: "
# s.description = "The Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API requires a client certificate (SSL/TLS, DoD PKI only). Use the `Registration` endpoint to register the client certificate.</br></br> Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key. The API key must be provided in the request header for all endpoint calls (api-key). If the service receives an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br> <strong>Available Request Headers</strong></br> <table> <tr> <th align=left>key</th> <th align=left>Example Value</th> <th align=left>Description</th> </tr> <tr> <td>`api-key`</td> <td>api-key-provided-by-emass</td> <td>This API key must be provided in the request header for all endpoint calls</td> </tr> <tr> <td>`user-uid`</td> <td>USER.UID.KEY</td> <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td> </tr> <tr> <td></td><td></td> <td> Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC </td> </tr> </table> </br><strong>Approve API Client for Actionable Requests</strong></br> Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions. Please note that leaving a field parameter blank (for PUT/POST requests) has the potential to clear information in the active eMASS records. To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC: "
s.description = "The emass_client is a ruby gem that implements the Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) specifications"
s.license = "Apache-2.0"
s.required_ruby_version = ">= 2.4"

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api/artifacts_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api/cac_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api/containers_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api/controls_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api/dashboards_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api/milestones_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api/pac_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api/poam_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
25 changes: 7 additions & 18 deletions src/ruby_client/lib/emass_client/api/registration_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand All @@ -20,28 +20,22 @@ def initialize(api_client = ApiClient.default)
@api_client = api_client
end
# Register user certificate and obtain an API key
# Returns the api-key - This API key must be provided in the request header for all endpoint calls (api-key).
# @param register_user_request_post_body [RegisterUserRequestPostBody] Register certificate provided by eMASS.
# Returns the API Key (api-key) that must be provided in the request header for all endpoint calls.
# @param [Hash] opts the optional parameters
# @return [Register]
def register_user(register_user_request_post_body, opts = {})
data, _status_code, _headers = register_user_with_http_info(register_user_request_post_body, opts)
def register_user(opts = {})
data, _status_code, _headers = register_user_with_http_info(opts)
data
end

# Register user certificate and obtain an API key
# Returns the api-key - This API key must be provided in the request header for all endpoint calls (api-key).
# @param register_user_request_post_body [RegisterUserRequestPostBody] Register certificate provided by eMASS.
# Returns the API Key (api-key) that must be provided in the request header for all endpoint calls.
# @param [Hash] opts the optional parameters
# @return [Array<(Register, Integer, Hash)>] Register data, response status code and response headers
def register_user_with_http_info(register_user_request_post_body, opts = {})
def register_user_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RegistrationApi.register_user ...'
end
# verify the required parameter 'register_user_request_post_body' is set
if @api_client.config.client_side_validation && register_user_request_post_body.nil?
fail ArgumentError, "Missing the required parameter 'register_user_request_post_body' when calling RegistrationApi.register_user"
end
# resource path
local_var_path = '/api/api-key'

Expand All @@ -52,17 +46,12 @@ def register_user_with_http_info(register_user_request_post_body, opts = {})
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
content_type = @api_client.select_header_content_type(['application/json'])
if !content_type.nil?
header_params['Content-Type'] = content_type
end

# form parameters
form_params = opts[:form_params] || {}

# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(register_user_request_post_body)
post_body = opts[:debug_body]

# return_type
return_type = opts[:debug_return_type] || 'Register'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api/system_roles_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api/systems_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api/test_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api/test_results_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api_client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/api_error.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/configuration.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
2 changes: 1 addition & 1 deletion src/ruby_client/lib/emass_client/models/artifacts_get.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The version of the OpenAPI document: v3.4
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.1.1-SNAPSHOT
OpenAPI Generator version: 6.2.1-SNAPSHOT
=end

Expand Down
Loading

0 comments on commit e1c24e6

Please sign in to comment.