| api(spec) |
<p>Decorate the given Controller constructor with metadata describing the HTTP/REST API the Controller implements/provides.</p><p>@api can be applied to controller classes.</p> |
| createEmptyApiSpec() |
Create an empty OpenApiSpec object that’s still a valid openapi document. |
| del(path, spec) |
Expose a Controller method as a REST API operation mapped to DELETE request method. |
| deprecated(isDeprecated) |
<p>Marks an api path as deprecated. When applied to a class, this decorator marks all paths as deprecated.</p><p>You can optionally mark all controllers in a class as deprecated, but use @deprecated(false) on a specific method to ensure it is not marked as deprecated in the specification.</p> |
| get(path, spec) |
Expose a Controller method as a REST API operation mapped to GET request method. |
| getControllerSpec(constructor) |
Get the controller spec for the given class |
| getFilterSchemaFor(modelCtor, options) |
<p>Build an OpenAPI schema describing the format of the “filter” object used to query model instances.</p><p>Note we don’t take the model properties into account yet and return a generic json schema allowing any “where” condition.</p> |
| getModelSchemaRef(modelCtor, options) |
Describe the provided Model as a reference to a definition shared by multiple endpoints. The definition is included in the returned schema. |
| getWhereSchemaFor(modelCtor) |
<p>Build a OpenAPI schema describing the format of the “where” object used to filter model instances to query, update or delete.</p><p>Note we don’t take the model properties into account yet and return a generic json schema allowing any “where” condition.</p> |
| jsonOrBooleanToJSON(jsonOrBool) |
Helper function used to interpret boolean values as JSON Schemas. See http://json-schema.org/draft-06/json-schema-release-notes.html |
| jsonToSchemaObject(json, visited) |
Converts JSON Schemas into a SchemaObject |
| mergeOpenAPISpec(currentSpec, patchSpec) |
<p>The default merge function to patch the current OpenAPI spec. It leverages module json-merge-patch’s merge API to merge two json objects. It returns a new merged object without modifying the original one.</p><p>A list of merging rules can be found in test file: https://github.com/pierreinglebert/json-merge-patch/blob/master/test/lib/merge.js</p> |
| mergeSecuritySchemeToSpec(spec, schemeName, schemeSpec) |
Security scheme merge helper function to patch the current OpenAPI spec. It provides a direct route to add a security schema to the specs components. It returns a new merged object without modifying the original one. |
| operation(verb, path, spec) |
Expose a Controller method as a REST API operation. |
| param(paramSpec) |
<p>Describe an input parameter of a Controller method.</p><p>@param must be applied to parameters.</p> |
| patch(path, spec) |
Expose a Controller method as a REST API operation mapped to PATCH request method. |
| post(path, spec) |
Expose a Controller method as a REST API operation mapped to POST request method. |
| put(path, spec) |
Expose a Controller method as a REST API operation mapped to PUT request method. |
| requestBody(requestBodySpec) |
<p>Describe the request body of a Controller method parameter.</p><p>A typical OpenAPI requestBody spec contains property: - description - required - content.</p> |
| response(responseCode, responseModelOrSpec) |
Add response object to a path spec. |
| tags(tagNames) |
Add tags for an endpoint. When applied to a class, this decorator adds the tags to all endpoints. |
| visibility(visibilityType) |
<p>Marks an api path with the specfied visibility. When applied to a class, this decorator marks all paths with the specified visibility.</p><p>You can optionally mark all controllers in a class with @visibility('undocumented'), but use @visibility('documented') on a specific method to ensure it is not marked as undocumented.</p> |