Skip to content

Commit

Permalink
Merge pull request #26 from jiridostal/master
Browse files Browse the repository at this point in the history
Update vulnerability prod client
  • Loading branch information
jiridostal authored Jul 4, 2019
2 parents 1e5ee16 + 1cdd04e commit 812cea3
Show file tree
Hide file tree
Showing 16 changed files with 873 additions and 55 deletions.
721 changes: 708 additions & 13 deletions packages/vulnerabilities/api.ts

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/vulnerabilities/apiSpec.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/vulnerabilities/configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Vulnerability Engine Manager
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* OpenAPI spec version: 0.11
* OpenAPI spec version: latest
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
73 changes: 70 additions & 3 deletions packages/vulnerabilities/doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ API documentation
* [BaseAPI](classes/baseapi.md)
* [Configuration](classes/configuration.md)
* [DefaultApi](classes/defaultapi.md)
* [InternalApi](classes/internalapi.md)
* [RequiredError](classes/requirederror.md)

### Interfaces
Expand All @@ -92,13 +93,17 @@ API documentation
* [MetaAffectedSystems](interfaces/metaaffectedsystems.md)
* [MetaCves](interfaces/metacves.md)
* [MetaSystems](interfaces/metasystems.md)
* [MetaVulnerabilitiesOut](interfaces/metavulnerabilitiesout.md)
* [RequestArgs](interfaces/requestargs.md)
* [StatusIn](interfaces/statusin.md)
* [StatusListOut](interfaces/statuslistout.md)
* [StatusListOutData](interfaces/statuslistoutdata.md)
* [StatusListOutMeta](interfaces/statuslistoutmeta.md)
* [SystemCvesOut](interfaces/systemcvesout.md)
* [SystemDetailsOut](interfaces/systemdetailsout.md)
* [SystemDetailsOutData](interfaces/systemdetailsoutdata.md)
* [SystemListOut](interfaces/systemlistout.md)
* [VersionOut](interfaces/versionout.md)
* [VulnerabilitiesOut](interfaces/vulnerabilitiesout.md)

### Variables
Expand All @@ -110,6 +115,9 @@ API documentation
* [DefaultApiAxiosParamCreator](#defaultapiaxiosparamcreator)
* [DefaultApiFactory](#defaultapifactory)
* [DefaultApiFp](#defaultapifp)
* [InternalApiAxiosParamCreator](#internalapiaxiosparamcreator)
* [InternalApiFactory](#internalapifactory)
* [InternalApiFp](#internalapifp)

### Object literals

Expand Down Expand Up @@ -137,7 +145,7 @@ ___

**DefaultApiAxiosParamCreator**(configuration?: *[Configuration](classes/configuration.md)*): `object`

*Defined in [api.ts:731](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L731)*
*Defined in [api.ts:883](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L883)*

DefaultApi - axios parameter creator

Expand All @@ -156,7 +164,7 @@ ___

**DefaultApiFactory**(configuration?: *[Configuration](classes/configuration.md)*, basePath?: *`string`*, axios?: *`AxiosInstance`*): `object`

*Defined in [api.ts:1521](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1521)*
*Defined in [api.ts:1795](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1795)*

DefaultApi - factory interface

Expand All @@ -177,7 +185,7 @@ ___

**DefaultApiFp**(configuration?: *[Configuration](classes/configuration.md)*): `object`

*Defined in [api.ts:1347](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1347)*
*Defined in [api.ts:1593](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1593)*

DefaultApi - functional programming interface

Expand All @@ -189,6 +197,65 @@ DefaultApi - functional programming interface

**Returns:** `object`

___
<a id="internalapiaxiosparamcreator"></a>

### `<Const>` InternalApiAxiosParamCreator

**InternalApiAxiosParamCreator**(configuration?: *[Configuration](classes/configuration.md)*): `object`

*Defined in [api.ts:2133](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L2133)*

InternalApi - axios parameter creator

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` configuration | [Configuration](classes/configuration.md) |

**Returns:** `object`

___
<a id="internalapifactory"></a>

### `<Const>` InternalApiFactory

**InternalApiFactory**(configuration?: *[Configuration](classes/configuration.md)*, basePath?: *`string`*, axios?: *`AxiosInstance`*): `object`

*Defined in [api.ts:2402](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L2402)*

InternalApi - factory interface

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` configuration | [Configuration](classes/configuration.md) |
| `Optional` basePath | `string` |
| `Optional` axios | `AxiosInstance` |

**Returns:** `object`

___
<a id="internalapifp"></a>

### `<Const>` InternalApiFp

**InternalApiFp**(configuration?: *[Configuration](classes/configuration.md)*): `object`

*Defined in [api.ts:2336](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L2336)*

InternalApi - functional programming interface

**Parameters:**

| Name | Type |
| ------ | ------ |
| `Optional` configuration | [Configuration](classes/configuration.md) |

**Returns:** `object`

___

## Object literals
Expand Down
2 changes: 2 additions & 0 deletions packages/vulnerabilities/doc/classes/baseapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

[DefaultApi](defaultapi.md)

[InternalApi](internalapi.md)

## Index

### Constructors
Expand Down
80 changes: 67 additions & 13 deletions packages/vulnerabilities/doc/classes/defaultapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,13 @@ DefaultApi - object-oriented interface

### Methods

* [deleteSystem](defaultapi.md#deletesystem)
* [getAffectedSystemsByCve](defaultapi.md#getaffectedsystemsbycve)
* [getCveDetails](defaultapi.md#getcvedetails)
* [getCveList](defaultapi.md#getcvelist)
* [getCveListBySystem](defaultapi.md#getcvelistbysystem)
* [getStatusList](defaultapi.md#getstatuslist)
* [getSystemDetails](defaultapi.md#getsystemdetails)
* [getSystemsList](defaultapi.md#getsystemslist)
* [getVersion](defaultapi.md#getversion)
* [setStatus](defaultapi.md#setstatus)
Expand Down Expand Up @@ -104,13 +106,39 @@ ___

## Methods

<a id="deletesystem"></a>

### deleteSystem

**deleteSystem**(inventoryId: *`string`*, options?: *`any`*): `AxiosPromise`<`Response`>

*Defined in [api.ts:1964](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1964)*

Deletes system from database.

*__summary__*: Delete system.

*__throws__*: {RequiredError}

*__memberof__*: DefaultApi

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| inventoryId | `string` | Inventory ID. |
| `Optional` options | `any` |

**Returns:** `AxiosPromise`<`Response`>

___
<a id="getaffectedsystemsbycve"></a>

### getAffectedSystemsByCve

**getAffectedSystemsByCve**(cveId: *`string`*, filter?: *`string`*, limit?: *`number`*, offset?: *`number`*, page?: *`number`*, pageSize?: *`number`*, sort?: *`string`*, statusId?: *`string`*, dataFormat?: *`string`*, options?: *`any`*): `AxiosPromise`<[AffectedSystemsOut](../interfaces/affectedsystemsout.md)>

*Defined in [api.ts:1678](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1678)*
*Defined in [api.ts:1984](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1984)*

Report of affected systems for a given CVE.

Expand Down Expand Up @@ -144,7 +172,7 @@ ___

**getCveDetails**(cveId: *`string`*, options?: *`any`*): `AxiosPromise`<[CveDetailOut](../interfaces/cvedetailout.md)>

*Defined in [api.ts:1690](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1690)*
*Defined in [api.ts:1996](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1996)*

Show all information about given CVE.

Expand All @@ -170,7 +198,7 @@ ___

**getCveList**(filter?: *`string`*, limit?: *`number`*, offset?: *`number`*, page?: *`number`*, pageSize?: *`number`*, sort?: *`string`*, cvssFrom?: *`number`*, cvssTo?: *`number`*, publicFrom?: *`string`*, publicTo?: *`string`*, severity?: *`string`*, dataFormat?: *`string`*, showAll?: *`boolean`*, options?: *`any`*): `AxiosPromise`<[VulnerabilitiesOut](../interfaces/vulnerabilitiesout.md)>

*Defined in [api.ts:1714](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1714)*
*Defined in [api.ts:2020](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L2020)*

Overview of vulnerabilities across whole host inventory.

Expand Down Expand Up @@ -208,7 +236,7 @@ ___

**getCveListBySystem**(inventoryId: *`string`*, filter?: *`string`*, limit?: *`number`*, offset?: *`number`*, page?: *`number`*, pageSize?: *`number`*, sort?: *`string`*, cvssFrom?: *`number`*, cvssTo?: *`number`*, publicFrom?: *`string`*, publicTo?: *`string`*, severity?: *`string`*, statusId?: *`string`*, dataFormat?: *`string`*, options?: *`any`*): `AxiosPromise`<[SystemCvesOut](../interfaces/systemcvesout.md)>

*Defined in [api.ts:1739](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1739)*
*Defined in [api.ts:2045](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L2045)*

Shows detailed infomation about all CVEs the system is exposed to.

Expand All @@ -222,7 +250,7 @@ Shows detailed infomation about all CVEs the system is exposed to.

| Name | Type | Description |
| ------ | ------ | ------ |
| inventoryId | `string` | Inventory ID of the host to be opted in/out. |
| inventoryId | `string` | Inventory ID. |
| `Optional` filter | `string` |
| `Optional` limit | `number` |
| `Optional` offset | `number` |
Expand All @@ -247,7 +275,7 @@ ___

**getStatusList**(options?: *`any`*): `AxiosPromise`<[StatusListOut](../interfaces/statuslistout.md)>

*Defined in [api.ts:1750](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1750)*
*Defined in [api.ts:2056](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L2056)*

Returns available status and status\_id pairs where status\_id is internal ID of the status.

Expand All @@ -265,14 +293,40 @@ Returns available status and status\_id pairs where status\_id is internal ID of

**Returns:** `AxiosPromise`<[StatusListOut](../interfaces/statuslistout.md)>

___
<a id="getsystemdetails"></a>

### getSystemDetails

**getSystemDetails**(inventoryId: *`string`*, options?: *`any`*): `AxiosPromise`<[SystemDetailsOut](../interfaces/systemdetailsout.md)>

*Defined in [api.ts:2068](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L2068)*

Provides details of a system, e.g. it's opt out status.

*__summary__*: System details.

*__throws__*: {RequiredError}

*__memberof__*: DefaultApi

**Parameters:**

| Name | Type | Description |
| ------ | ------ | ------ |
| inventoryId | `string` | Inventory ID. |
| `Optional` options | `any` |

**Returns:** `AxiosPromise`<[SystemDetailsOut](../interfaces/systemdetailsout.md)>

___
<a id="getsystemslist"></a>

### getSystemsList

**getSystemsList**(filter?: *`string`*, limit?: *`number`*, offset?: *`number`*, page?: *`number`*, pageSize?: *`number`*, sort?: *`string`*, dataFormat?: *`string`*, optOut?: *`boolean`*, options?: *`any`*): `AxiosPromise`<[SystemListOut](../interfaces/systemlistout.md)>

*Defined in [api.ts:1769](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1769)*
*Defined in [api.ts:2087](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L2087)*

List systems visible to logged in account with basic information related to vulnerabilities.

Expand Down Expand Up @@ -303,9 +357,9 @@ ___

### getVersion

**getVersion**(options?: *`any`*): `AxiosPromise`<`Object`>
**getVersion**(options?: *`any`*): `AxiosPromise`<[VersionOut](../interfaces/versionout.md)>

*Defined in [api.ts:1780](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1780)*
*Defined in [api.ts:2098](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L2098)*

Get application version.

Expand All @@ -321,7 +375,7 @@ Get application version.
| ------ | ------ |
| `Optional` options | `any` |

**Returns:** `AxiosPromise`<`Object`>
**Returns:** `AxiosPromise`<[VersionOut](../interfaces/versionout.md)>

___
<a id="setstatus"></a>
Expand All @@ -330,7 +384,7 @@ ___

**setStatus**(statusIn: *[StatusIn](../interfaces/statusin.md)*, options?: *`any`*): `AxiosPromise`<`Response`>

*Defined in [api.ts:1792](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1792)*
*Defined in [api.ts:2110](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L2110)*

Sets status for given host and CVE.

Expand All @@ -356,7 +410,7 @@ ___

**setSystemOptOut**(inventoryId: *`string`*, value: *`boolean`*, options?: *`any`*): `AxiosPromise`<`Response`>

*Defined in [api.ts:1805](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L1805)*
*Defined in [api.ts:2123](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L2123)*

Opts in/out a systems. Opted out system is not shown and manageable by the vulnerability application.

Expand All @@ -370,7 +424,7 @@ Opts in/out a systems. Opted out system is not shown and manageable by the vulne

| Name | Type | Description |
| ------ | ------ | ------ |
| inventoryId | `string` | Inventory ID of the host to be opted in/out. |
| inventoryId | `string` | Inventory ID. |
| value | `boolean` | opt\_out setting of the host. |
| `Optional` options | `any` |

Expand Down
6 changes: 3 additions & 3 deletions packages/vulnerabilities/doc/classes/requirederror.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ ___

*Inherited from Error.message*

*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964*
*Defined in node_modules/typescript/lib/lib.es5.d.ts:964*

___
<a id="name"></a>
Expand All @@ -94,7 +94,7 @@ ___

*Overrides Error.stack*

*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965*
*Defined in node_modules/typescript/lib/lib.es5.d.ts:965*

___
<a id="error"></a>
Expand All @@ -103,7 +103,7 @@ ___

**● Error**: *`ErrorConstructor`*

*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974*
*Defined in node_modules/typescript/lib/lib.es5.d.ts:974*

___

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Vulnerability Engine Manager No description provided (generated by Openapi Generator [https://github.com/openapitools/openapi-generator](https://github.com/openapitools/openapi-generator))

OpenAPI spec version: 0.11
OpenAPI spec version: latest

NOTE: This class is auto generated by OpenAPI Generator ([https://openapi-generator.tech)](https://openapi-generator.tech)). [https://openapi-generator.tech](https://openapi-generator.tech) Do not edit the class manually.

Expand Down
6 changes: 3 additions & 3 deletions packages/vulnerabilities/doc/interfaces/statusin.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

**● cve**: *`string`*

*Defined in [api.ts:579](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L579)*
*Defined in [api.ts:671](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L671)*

CVE name.

Expand All @@ -43,7 +43,7 @@ ___

**● inventoryId**: *`string`*

*Defined in [api.ts:585](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L585)*
*Defined in [api.ts:677](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L677)*

Host ID.

Expand All @@ -58,7 +58,7 @@ ___

**● statusId**: *`number`*

*Defined in [api.ts:591](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L591)*
*Defined in [api.ts:683](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/vulnerabilities/api.ts#L683)*

Status ID to be set, obtained by GET method.

Expand Down
Loading

0 comments on commit 812cea3

Please sign in to comment.