npm - @rapidrest/service-core - Versions diffs - 1.0.0-rc.9 → 1.1.0 - Mend

@rapidrest/service-core 1.0.0-rc.9 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (380) hide show

package/docs/reference/classes/OpenApiSpec.md DELETED Viewed

@@ -1,892 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / OpenApiSpec
-# Class: OpenApiSpec
-Defined in: [src/OpenApiSpec.ts:19](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L19)
-`OpenApiSpec` is a container for an OpenAPI specification.
-This class wraps the behavior of openapi-ts to make it easier to build an OpenAPI
-specification dynamically at runtime using the server RapidREST information.
-## Author
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-## Constructors
-### Constructor
-> **new OpenApiSpec**(`spec?`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:25](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L25)
-#### Parameters
-##### spec?
-`OpenAPIObject`
-#### Returns
-`OpenApiSpec`
-## Accessors
-### builder
-#### Get Signature
-> **get** **builder**(): `OpenApiBuilder`
-Defined in: [src/OpenApiSpec.ts:29](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L29)
-##### Returns
-`OpenApiBuilder`
-#### Set Signature
-> **set** **builder**(`value`): `void`
-Defined in: [src/OpenApiSpec.ts:33](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L33)
-##### Parameters
-###### value
-`OpenApiBuilder`
-##### Returns
-`void`
-***
-### components
-#### Get Signature
-> **get** **components**(): `ComponentsObject` \| `undefined`
-Defined in: [src/OpenApiSpec.ts:53](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L53)
-##### Returns
-`ComponentsObject` \| `undefined`
-***
-### externalDocs
-#### Get Signature
-> **get** **externalDocs**(): `ExternalDocumentationObject` \| `undefined`
-Defined in: [src/OpenApiSpec.ts:65](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L65)
-##### Returns
-`ExternalDocumentationObject` \| `undefined`
-***
-### info
-#### Get Signature
-> **get** **info**(): `InfoObject`
-Defined in: [src/OpenApiSpec.ts:41](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L41)
-##### Returns
-`InfoObject`
-***
-### openapi
-#### Get Signature
-> **get** **openapi**(): `string`
-Defined in: [src/OpenApiSpec.ts:37](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L37)
-##### Returns
-`string`
-***
-### paths
-#### Get Signature
-> **get** **paths**(): `PathsObject` \| `undefined`
-Defined in: [src/OpenApiSpec.ts:49](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L49)
-##### Returns
-`PathsObject` \| `undefined`
-***
-### security
-#### Get Signature
-> **get** **security**(): `SecurityRequirementObject`[] \| `undefined`
-Defined in: [src/OpenApiSpec.ts:57](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L57)
-##### Returns
-`SecurityRequirementObject`[] \| `undefined`
-***
-### servers
-#### Get Signature
-> **get** **servers**(): `ServerObject`[] \| `undefined`
-Defined in: [src/OpenApiSpec.ts:45](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L45)
-##### Returns
-`ServerObject`[] \| `undefined`
-***
-### tags
-#### Get Signature
-> **get** **tags**(): `TagObject`[] \| `undefined`
-Defined in: [src/OpenApiSpec.ts:61](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L61)
-##### Returns
-`TagObject`[] \| `undefined`
-***
-### webhooks
-#### Get Signature
-> **get** **webhooks**(): `PathsObject` \| `undefined`
-Defined in: [src/OpenApiSpec.ts:69](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L69)
-##### Returns
-`PathsObject` \| `undefined`
-## Methods
-### addCallback()
-> **addCallback**(`name`, `callback`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:264](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L264)
-#### Parameters
-##### name
-`string`
-##### callback
-`ReferenceObject` \| `CallbackObject`
-#### Returns
-`OpenApiSpec`
-***
-### addContact()
-> **addContact**(`contact`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:189](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L189)
-#### Parameters
-##### contact
-`ContactObject`
-#### Returns
-`OpenApiSpec`
-***
-### addDescription()
-> **addDescription**(`description`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:204](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L204)
-#### Parameters
-##### description
-`string`
-#### Returns
-`OpenApiSpec`
-***
-### addExample()
-> **addExample**(`name`, `example`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:239](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L239)
-#### Parameters
-##### name
-`string`
-##### example
-`ReferenceObject` \| `ExampleObject`
-#### Returns
-`OpenApiSpec`
-***
-### addExternalDocs()
-> **addExternalDocs**(`extDoc`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:279](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L279)
-#### Parameters
-##### extDoc
-`ExternalDocumentationObject`
-#### Returns
-`OpenApiSpec`
-***
-### addHeader()
-> **addHeader**(`name`, `header`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:249](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L249)
-#### Parameters
-##### name
-`string`
-##### header
-`ReferenceObject` \| `HeaderObject`
-#### Returns
-`OpenApiSpec`
-***
-### addInfo()
-> **addInfo**(`info`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:184](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L184)
-#### Parameters
-##### info
-`InfoObject`
-#### Returns
-`OpenApiSpec`
-***
-### addLicense()
-> **addLicense**(`license`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:194](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L194)
-#### Parameters
-##### license
-`LicenseObject`
-#### Returns
-`OpenApiSpec`
-***
-### addLink()
-> **addLink**(`name`, `link`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:259](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L259)
-#### Parameters
-##### name
-`string`
-##### link
-`ReferenceObject` \| `LinkObject`
-#### Returns
-`OpenApiSpec`
-***
-### addModel()
-> **addModel**(`name`, `clazz`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:295](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L295)
-Adds a RapidREST model class to the OpenAPI specification as a schema.
-#### Parameters
-##### name
-`string`
-The name of the model to add.
-##### clazz
-`any`
-The class prototype to build the schema from.
-#### Returns
-`OpenApiSpec`
-***
-### addOpenApiVersion()
-> **addOpenApiVersion**(`openApiVersion`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:179](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L179)
-#### Parameters
-##### openApiVersion
-`string`
-#### Returns
-`OpenApiSpec`
-***
-### addParameter()
-> **addParameter**(`name`, `parameter`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:234](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L234)
-#### Parameters
-##### name
-`string`
-##### parameter
-`ReferenceObject` \| `ParameterObject`
-#### Returns
-`OpenApiSpec`
-***
-### addPath()
-> **addPath**(`path`, `pathItem`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:219](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L219)
-#### Parameters
-##### path
-`string`
-##### pathItem
-`PathItemObject`
-#### Returns
-`OpenApiSpec`
-***
-### addRequestBody()
-> **addRequestBody**(`name`, `reqBody`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:244](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L244)
-#### Parameters
-##### name
-`string`
-##### reqBody
-`ReferenceObject` \| `RequestBodyObject`
-#### Returns
-`OpenApiSpec`
-***
-### addResponse()
-> **addResponse**(`name`, `response`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:229](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L229)
-#### Parameters
-##### name
-`string`
-##### response
-`ReferenceObject` \| `ResponseObject`
-#### Returns
-`OpenApiSpec`
-***
-### addRoute()
-> **addRoute**(`name`, `path`, `method`, `metadata`, `docs`, `routeClass`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:311](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L311)
-Adds a RapidREST route handler to the OpenAPI specification.
-#### Parameters
-##### name
-`string`
-The name of the route handler. (e.g. findAll)
-##### path
-`string`
-The complete path of the route handler. (e.g. `/my/resources/:id`)
-##### method
-`string`
-The HTTP verb type that the route handler processes. (e.g. `GET`)
-##### metadata
-`any`
-The object containing all API information about the route handler.
-##### docs
-[`DocumentsData`](../@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md)
-The object containing all documentation information about the route handler.
-##### routeClass
-`any`
-The parent route class that the route handler belongs to.
-#### Returns
-`OpenApiSpec`
-***
-### addSchema()
-> **addSchema**(`name`, `schema`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:224](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L224)
-#### Parameters
-##### name
-`string`
-##### schema
-`SchemaObject` \| `ReferenceObject`
-#### Returns
-`OpenApiSpec`
-***
-### addSecurityScheme()
-> **addSecurityScheme**(`name`, `secScheme`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:254](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L254)
-#### Parameters
-##### name
-`string`
-##### secScheme
-`ReferenceObject` \| `SecuritySchemeObject`
-#### Returns
-`OpenApiSpec`
-***
-### addServer()
-> **addServer**(`server`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:269](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L269)
-#### Parameters
-##### server
-`ServerObject`
-#### Returns
-`OpenApiSpec`
-***
-### addTag()
-> **addTag**(`tag`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:274](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L274)
-#### Parameters
-##### tag
-`TagObject`
-#### Returns
-`OpenApiSpec`
-***
-### addTermsOfService()
-> **addTermsOfService**(`termsOfService`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:209](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L209)
-#### Parameters
-##### termsOfService
-`string`
-#### Returns
-`OpenApiSpec`
-***
-### addTitle()
-> **addTitle**(`title`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:199](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L199)
-#### Parameters
-##### title
-`string`
-#### Returns
-`OpenApiSpec`
-***
-### addVersion()
-> **addVersion**(`version`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:214](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L214)
-#### Parameters
-##### version
-`string`
-#### Returns
-`OpenApiSpec`
-***
-### addWebhook()
-> **addWebhook**(`webhook`, `webhookItem`): `OpenApiSpec`
-Defined in: [src/OpenApiSpec.ts:284](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L284)
-#### Parameters
-##### webhook
-`string`
-##### webhookItem
-`PathItemObject`
-#### Returns
-`OpenApiSpec`
-***
-### createSchemaClass()
-> **createSchemaClass**(`clazz`): `SchemaObject`
-Defined in: [src/OpenApiSpec.ts:590](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L590)
-Creates a new SchemaObject given the specified class prototype.
-#### Parameters
-##### clazz
-`any`
-The class prototype to build a schema object from.
-#### Returns
-`SchemaObject`
-The schema object with all information derived from the given class prototype.
-***
-### createSchemaObject()
-> **createSchemaObject**(`typeInfo`, `defaultValue?`, `description?`, `example?`, `format?`, `identifier?`): `SchemaObject` \| `ReferenceObject`
-Defined in: [src/OpenApiSpec.ts:685](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L685)
-Creates a schema object for the given type.
-#### Parameters
-##### typeInfo
-`any`
-##### defaultValue?
-`any`
-##### description?
-`string`
-##### example?
-`any`
-##### format?
-`string`
-##### identifier?
-`boolean`
-#### Returns
-`SchemaObject` \| `ReferenceObject`
-***
-### getParameterReference()
-> **getParameterReference**(`name`): `ReferenceObject` \| `undefined`
-Defined in: [src/OpenApiSpec.ts:781](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L781)
-Returns a reference to an existing parameter defined in the OpenAPI specification for the given name.
-#### Parameters
-##### name
-`string`
-The name of the parameter to find a reference for.
-#### Returns
-`ReferenceObject` \| `undefined`
-The reference to the parameter with the given name, otherwise `undefined`.
-***
-### getSchemaReference()
-> **getSchemaReference**(`name`): `ReferenceObject` \| `undefined`
-Defined in: [src/OpenApiSpec.ts:797](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L797)
-Returns a reference to an existing schema defined in the OpenAPI specification for the given name.
-#### Parameters
-##### name
-`string`
-The name of the schema to find a reference for.
-#### Returns
-`ReferenceObject` \| `undefined`
-The reference to the schema with the given name, otherwise `undefined`.
-***
-### getSpec()
-> **getSpec**(): `OpenAPIObject`
-Defined in: [src/OpenApiSpec.ts:167](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L167)
-#### Returns
-`OpenAPIObject`
-***
-### getSpecAsJson()
-> **getSpecAsJson**(`replacer?`, `space?`): `string`
-Defined in: [src/OpenApiSpec.ts:171](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L171)
-#### Parameters
-##### replacer?
-(`key`, `value`) => `unknown`
-##### space?
-`string` \| `number`
-#### Returns
-`string`
-***
-### getSpecAsYaml()
-> **getSpecAsYaml**(): `string`
-Defined in: [src/OpenApiSpec.ts:175](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L175)
-#### Returns
-`string`
-***
-### merge()
-> **merge**(`other`): `void`
-Defined in: [src/OpenApiSpec.ts:811](https://github.com/rapidrest/service-core/blob/4c90df5a9a62e99656161ce7b45c7c6781b43869/src/OpenApiSpec.ts#L811)
-Merges a provided OpenAPI specification with this specification.
-#### Parameters
-##### other
-`any`
-The other OpenAPI spec object to merge.
-#### Returns
-`void`