1.31.2 • Published 6 years ago
@4geit/swg-notification-model v1.31.2
@4geit/swg-notification-model
notification model provides data model + endpoints for the notifications menu feature
Installation
- A recommended way to install @4geit/swg-notification-model is through npm package manager using the following command:
npm i @4geit/swg-notification-model --save
Or use yarn
using the following command:
yarn add @4geit/swg-notification-model
- In your swagger file, you need to add a reference to the
SwgNotificationModel
definition under thedefinitions
property (e.g./api/swagger/swagger.yaml
) as below:
swagger: "2.0"
# ...
definitions:
SwgNotificationModel:
$ref: ../../node_modules/@4geit/swg-notification-model/swagger.yaml#/definitions/SwgNotificationModel
# ...
- SwgNotificationModel also comes along with some endpoints you can expose to the API, to do so you will need to add a reference to the
SwgNotificationModel
definition under thepaths
property (e.g./api/swagger/swagger.yaml
) as below:
swagger: "2.0"
# ...
paths:
/notification:
$ref: ../../node_modules/@4geit/swg-notification-model/swagger.yaml#/definitions/NotificationListPath
/notification/{id}:
$ref: ../../node_modules/@4geit/swg-notification-model/swagger.yaml#/definitions/NotificationItemPath
/notification/populate:
$ref: ../../node_modules/@4geit/swg-notification-model/swagger.yaml#/definitions/PopulatePath
# ...
And you will also need to add the path to the controllers
folder of the swg-notification-model
package so that swagger-node will find the relevant controller to use. Edit the file /config/default.yaml
and add two new paths to the properties mockControllersDirs
and controllersDirs
as illustrated below:
swagger:
# ...
bagpipes:
_router:
# ...
mockControllersDirs:
# ...
- node_modules/@4geit/swg-notification-model/mocks
# ...
controllersDirs:
# ...
- node_modules/@4geit/swg-notification-model/controllers
# ...