security_tools/tools/microsoft/cvrf/ruby-client

openapi_client

OpenapiClient - the Ruby gem for the Microsoft Security Updates API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build openapi_client.gemspec

Then either install the gem locally:

gem install ./openapi_client-1.0.0.gem

(for development, run gem install --dev ./openapi_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'openapi_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https:///YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'openapi_client', :git => 'https:///YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'openapi_client'

api_instance = OpenapiClient::DefaultApi.new
api_version = 'api_version_example' # String | 
api_key = 'api_key_example' # String | 
id = 'id_example' # String | 

begin
  result = api_instance.cvrf_id_get(api_version, api_key, id)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling DefaultApi->cvrf_id_get: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.msrc.microsoft.com

Class	Method	HTTP request	Description
OpenapiClient::DefaultApi	cvrf_id_get	GET /cvrf/{id}
OpenapiClient::DefaultApi	updates_get	GET /Updates
OpenapiClient::DefaultApi	updates_id_get	GET /Updates('{id}')

Documentation for Models

• OpenapiClient::CvrfReturnTypes200
• OpenapiClient::CvrfReturnTypes200Acknowledgements
• OpenapiClient::CvrfReturnTypes200AffectedFiles
• OpenapiClient::CvrfReturnTypes200CVSSScoreSets
• OpenapiClient::CvrfReturnTypes200DocumentNotes
• OpenapiClient::CvrfReturnTypes200DocumentPublisher
• OpenapiClient::CvrfReturnTypes200DocumentTitle
• OpenapiClient::CvrfReturnTypes200DocumentTracking
• OpenapiClient::CvrfReturnTypes200DocumentTrackingIdentification
• OpenapiClient::CvrfReturnTypes200DocumentTrackingRevisionHistory
• OpenapiClient::CvrfReturnTypes200Notes
• OpenapiClient::CvrfReturnTypes200ProductStatuses
• OpenapiClient::CvrfReturnTypes200ProductTree
• OpenapiClient::CvrfReturnTypes200ProductTreeBranch
• OpenapiClient::CvrfReturnTypes200ProductTreeItems
• OpenapiClient::CvrfReturnTypes200ProductTreeItems1
• OpenapiClient::CvrfReturnTypes200Remediations
• OpenapiClient::CvrfReturnTypes200Threats
• OpenapiClient::CvrfReturnTypes200Vulnerability
• OpenapiClient::CvrfReturnTypes200Xml
• OpenapiClient::CvrfReturnTypes200XmlCvrfdoc
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocDocumentNotes
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocDocumentPublisher
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocDocumentTracking
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocDocumentTrackingIdentification
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocDocumentTrackingRevisionHistory
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocDocumentTrackingRevisionHistoryRevision
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocNote
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocProductTree
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocProductTreeBranch
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocProductTreeBranch1
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocProductTreeFullProductName
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocProductTreeFullProductName1
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocVulnerability
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocVulnerabilityAcknowledgements
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocVulnerabilityAffectedFiles
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocVulnerabilityCVSSScoreSets
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocVulnerabilityNotes
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocVulnerabilityNotesNote
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocVulnerabilityProductStatuses
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocVulnerabilityRemediations
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocVulnerabilityRevisionHistory
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocVulnerabilityThreat
• OpenapiClient::CvrfReturnTypes200XmlCvrfdocVulnerabilityThreats
• OpenapiClient::UpdatesReturnTypes200
• OpenapiClient::UpdatesReturnTypes200Value

Documentation for Authorization

All endpoints do not require authorization.