Skip to content

Commit

Permalink
chore(release): 3.0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
SkeLLLa committed Dec 6, 2020
1 parent 2d9ed4d commit 4e58c5d
Show file tree
Hide file tree
Showing 77 changed files with 2,408 additions and 2,357 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### [3.0.4](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.3...v3.0.4) (2020-12-06)

### Bug Fixes

- bump swagger-ui-dist to 3.36.1 ([9fecca7](https://gitlab.com/m03geek/fastify-oas/commit/9fecca7e05d74f23427a7d3e1c9a7205c0d72502))
- bump swagger-ui-dist to 3.37.2 ([a8d9119](https://gitlab.com/m03geek/fastify-oas/commit/a8d91190095f5b4ffba198d1d859b197afb234d5))
- children.length type error ([c579091](https://gitlab.com/m03geek/fastify-oas/commit/c579091d572b1c4e4456ef64366e5bcdbcf5eaef))
- redoc complains on csp violation ([6460989](https://gitlab.com/m03geek/fastify-oas/commit/6460989e45bba9f3d3379802086388eee5c85faa))
- strip item objects of non-allowed props ([2be1b07](https://gitlab.com/m03geek/fastify-oas/commit/2be1b07ccface79f630ba4dbd701a1ff600b303c)), closes [#54](https://gitlab.com/m03geek/fastify-oas/issues/54)

### Misc

- **deps:** bump ([2d9ed4d](https://gitlab.com/m03geek/fastify-oas/commit/2d9ed4d3b30e0196b885a335bb9fa62466d16c84))

### [3.0.3](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.2...v3.0.3) (2020-08-25)

### Style
Expand Down
236 changes: 112 additions & 124 deletions docs/README.md

Large diffs are not rendered by default.

86 changes: 42 additions & 44 deletions docs/classes/server.md
Original file line number Diff line number Diff line change
@@ -1,95 +1,93 @@
[fastify-oas](../README.md)[Server](server.md)
**[fastify-oas](../README.md)**

> [Globals](../README.md) / Server
# Class: Server

## Hierarchy

* **Server**
- **Server**

## Implements

* [ServerObject](../interfaces/serverobject.md)
- [ServerObject](../interfaces/serverobject.md)

## Index

### Constructors

* [constructor](server.md#constructor)
- [constructor](server.md#constructor)

### Properties

* [description](server.md#optional-description)
* [url](server.md#url)
* [variables](server.md#variables)
- [description](server.md#description)
- [url](server.md#url)
- [variables](server.md#variables)

### Methods

* [addVariable](server.md#addvariable)
- [addVariable](server.md#addvariable)

## Constructors

### constructor
### constructor

\+ **new Server**(`url`: string, `desc?`: string): *[Server](server.md)*
\+ **new Server**(`url`: string, `desc?`: string): [Server](server.md)

Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:7
_Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:7_

**Parameters:**
#### Parameters:

Name | Type |
------ | ------ |
`url` | string |
`desc?` | string |
| Name | Type |
| ------- | ------ |
| `url` | string |
| `desc?` | string |

**Returns:** *[Server](server.md)*
**Returns:** [Server](server.md)

## Properties

### `Optional` description

**description**? : *string*

*Implementation of [ServerObject](../interfaces/serverobject.md).[description](../interfaces/serverobject.md#optional-description)*
### description

Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:4
`Optional` **description**: string

___
_Implementation of [ServerObject](../interfaces/serverobject.md).[description](../interfaces/serverobject.md#description)_

### url
_Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:4_

**url**: *string*
---

*Implementation of [ServerObject](../interfaces/serverobject.md).[url](../interfaces/serverobject.md#url)*
### url

Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:3
**url**: string

___
_Implementation of [ServerObject](../interfaces/serverobject.md).[url](../interfaces/serverobject.md#url)_

### variables
_Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:3_

**variables**: *object*
---

*Implementation of [ServerObject](../interfaces/serverobject.md).[variables](../interfaces/serverobject.md#optional-variables)*
### variables

Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:5
**variables**: { [v:string]: [ServerVariable](servervariable.md); }

#### Type declaration:
_Implementation of [ServerObject](../interfaces/serverobject.md).[variables](../interfaces/serverobject.md#variables)_

* \[ **v**: *string*\]: [ServerVariable](servervariable.md)
_Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:5_

## Methods

### addVariable
### addVariable

**addVariable**(`name`: string, `variable`: [ServerVariable](servervariable.md)): *void*
**addVariable**(`name`: string, `variable`: [ServerVariable](servervariable.md)): void

Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:9
_Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:9_

**Parameters:**
#### Parameters:

Name | Type |
------ | ------ |
`name` | string |
`variable` | [ServerVariable](servervariable.md) |
| Name | Type |
| ---------- | ----------------------------------- |
| `name` | string |
| `variable` | [ServerVariable](servervariable.md) |

**Returns:** *void*
**Returns:** void
64 changes: 33 additions & 31 deletions docs/classes/servervariable.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,73 @@
[fastify-oas](../README.md)[ServerVariable](servervariable.md)
**[fastify-oas](../README.md)**

> [Globals](../README.md) / ServerVariable
# Class: ServerVariable

## Hierarchy

* **ServerVariable**
- **ServerVariable**

## Implements

* [ServerVariableObject](../interfaces/servervariableobject.md)
- [ServerVariableObject](../interfaces/servervariableobject.md)

## Index

### Constructors

* [constructor](servervariable.md#constructor)
- [constructor](servervariable.md#constructor)

### Properties

* [default](servervariable.md#default)
* [description](servervariable.md#optional-description)
* [enum](servervariable.md#optional-enum)
- [default](servervariable.md#default)
- [description](servervariable.md#description)
- [enum](servervariable.md#enum)

## Constructors

### constructor
### constructor

\+ **new ServerVariable**(`defaultValue`: any, `enums?`: any, `description?`: string): *[ServerVariable](servervariable.md)*
\+ **new ServerVariable**(`defaultValue`: any, `enums?`: any, `description?`: string): [ServerVariable](servervariable.md)

Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:14
_Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:14_

**Parameters:**
#### Parameters:

Name | Type |
------ | ------ |
`defaultValue` | any |
`enums?` | any |
`description?` | string |
| Name | Type |
| -------------- | ------ |
| `defaultValue` | any |
| `enums?` | any |
| `description?` | string |

**Returns:** *[ServerVariable](servervariable.md)*
**Returns:** [ServerVariable](servervariable.md)

## Properties

### default
### default

**default**: *string | boolean | number*
**default**: string \| boolean \| number

*Implementation of [ServerVariableObject](../interfaces/servervariableobject.md).[default](../interfaces/servervariableobject.md#default)*
_Implementation of [ServerVariableObject](../interfaces/servervariableobject.md).[default](../interfaces/servervariableobject.md#default)_

Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:13
_Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:13_

___
---

### `Optional` description
### description

**description**? : *string*
`Optional` **description**: string

*Implementation of [ServerVariableObject](../interfaces/servervariableobject.md).[description](../interfaces/servervariableobject.md#optional-description)*
_Implementation of [ServerVariableObject](../interfaces/servervariableobject.md).[description](../interfaces/servervariableobject.md#description)_

Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:14
_Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:14_

___
---

### `Optional` enum
### enum

**enum**? : *string[] | boolean[] | number[]*
`Optional` **enum**: string[] \| boolean[] \| number[]

*Implementation of [ServerVariableObject](../interfaces/servervariableobject.md).[enum](../interfaces/servervariableobject.md#optional-enum)*
_Implementation of [ServerVariableObject](../interfaces/servervariableobject.md).[enum](../interfaces/servervariableobject.md#enum)_

Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:12
_Defined in node_modules/openapi3-ts/dist/model/Server.d.ts:12_
82 changes: 42 additions & 40 deletions docs/classes/specificationextension.md
Original file line number Diff line number Diff line change
@@ -1,83 +1,85 @@
[fastify-oas](../README.md)[SpecificationExtension](specificationextension.md)
**[fastify-oas](../README.md)**

> [Globals](../README.md) / SpecificationExtension
# Class: SpecificationExtension

## Hierarchy

* **SpecificationExtension**
- **SpecificationExtension**

## Implements

* [ISpecificationExtension](../interfaces/ispecificationextension.md)
- [ISpecificationExtension](../interfaces/ispecificationextension.md)

## Indexable

* \[ **extensionName**: *string*\]: any
[extensionName: string]: any

## Index

### Methods

* [addExtension](specificationextension.md#addextension)
* [getExtension](specificationextension.md#getextension)
* [listExtensions](specificationextension.md#listextensions)
* [isValidExtension](specificationextension.md#static-isvalidextension)
- [addExtension](specificationextension.md#addextension)
- [getExtension](specificationextension.md#getextension)
- [listExtensions](specificationextension.md#listextensions)
- [isValidExtension](specificationextension.md#isvalidextension)

## Methods

### addExtension
### addExtension

**addExtension**(`extensionName`: string, `payload`: any): *void*
**addExtension**(`extensionName`: string, `payload`: any): void

Defined in node_modules/openapi3-ts/dist/model/SpecificationExtension.d.ts:8
_Defined in node_modules/openapi3-ts/dist/model/SpecificationExtension.d.ts:8_

**Parameters:**
#### Parameters:

Name | Type |
------ | ------ |
`extensionName` | string |
`payload` | any |
| Name | Type |
| --------------- | ------ |
| `extensionName` | string |
| `payload` | any |

**Returns:** *void*
**Returns:** void

___
---

### getExtension
### getExtension

**getExtension**(`extensionName`: string): *any*
**getExtension**(`extensionName`: string): any

Defined in node_modules/openapi3-ts/dist/model/SpecificationExtension.d.ts:7
_Defined in node_modules/openapi3-ts/dist/model/SpecificationExtension.d.ts:7_

**Parameters:**
#### Parameters:

Name | Type |
------ | ------ |
`extensionName` | string |
| Name | Type |
| --------------- | ------ |
| `extensionName` | string |

**Returns:** *any*
**Returns:** any

___
---

### listExtensions
### listExtensions

**listExtensions**(): *string[]*
**listExtensions**(): string[]

Defined in node_modules/openapi3-ts/dist/model/SpecificationExtension.d.ts:9
_Defined in node_modules/openapi3-ts/dist/model/SpecificationExtension.d.ts:9_

**Returns:** *string[]*
**Returns:** string[]

___
---

### `Static` isValidExtension
### isValidExtension

**isValidExtension**(`extensionName`: string): *boolean*
`Static`**isValidExtension**(`extensionName`: string): boolean

Defined in node_modules/openapi3-ts/dist/model/SpecificationExtension.d.ts:6
_Defined in node_modules/openapi3-ts/dist/model/SpecificationExtension.d.ts:6_

**Parameters:**
#### Parameters:

Name | Type |
------ | ------ |
`extensionName` | string |
| Name | Type |
| --------------- | ------ |
| `extensionName` | string |

**Returns:** *boolean*
**Returns:** boolean
Loading

0 comments on commit 4e58c5d

Please sign in to comment.