Skip to content

Commit

Permalink
Merge pull request #4169 from fisuda/patch
Browse files Browse the repository at this point in the history
(JP) ADD doc about custom notification extra macro (#4166)
  • Loading branch information
fgalan authored Jul 12, 2022
2 parents c6fef64 + 9c4160d commit c92ba18
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
19 changes: 19 additions & 0 deletions doc/manuals.jp/user/ngsiv2_implementation_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
* [異なる属性型間の順序付け](#ordering-between-different-attribute-value-types)
* [Oneshot サブスクリプション](#oneshot-subscriptions)
* [変更タイプ (alteration type) に基づくサブスクリプション](#subscriptions-based-in-alteration-type)
* [カスタム通知の追加マクロ](#custom-notification-extra-macros)
* [JSON ペイロードを使用したカスタム通知](#custom-notification-with-json-payload)
* [ペイロードなしのカスタム通知](#custom-notifications-without-payload)
* [MQTT 通知](#mqtt-notifications)
Expand Down Expand Up @@ -466,6 +467,24 @@ Orionは `alterationTypes` フィールドをサポートして、サブスク

[トップ](#top)

<a name="custom-notification-extra-macros"></a>
## カスタム通知の追加マクロ

NGSIv2 仕様の "カスタム通知" セクションで説明されている `${...}` マクロとは別に、
次のマクロを使用できます:

* `${service}` は、サブスクリプションをトリガーする更新リクエストのサービス (つまり、
`fiware-service` ヘッダ値) に置き換えられます
* `${servicePath}` は、サブスクリプションをトリガーする更新リクエストのサービス・パス (つまり、
`fiware-servicepath` ヘッダ値) に置き換えられます
* `${authToken}` は、サブスクリプションをトリガーする更新リクエストの認証トークン (つまり、
`x-auth-token` ヘッダ値) に置き換えられます

まれに、属性が上記と同じ方法で名前が付けられた場合 (たとえば、名前が `service` である属性)、
属性値が優先されます。

[トップ](#top)

<a name="custom-notification-with-json-payload"></a>
## JSON ペイロードを使用したカスタム通知

Expand Down
6 changes: 3 additions & 3 deletions doc/manuals/user/ngsiv2_implementation_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ The particular validations that Orion implements on NGSIv2 subscription payloads

## `alterationType` attribute

Appart from the attributes described in the "Builtin Attributes" section in the NGSIv2 specification,
Apart from the attributes described in the "Builtin Attributes" section in the NGSIv2 specification,
Orion implements the `alterationType` attribute.

This attribute can be used only in notifications (in queries such `GET /v2/entities?attrs=alterationType`
Expand Down Expand Up @@ -413,7 +413,7 @@ supported upon completion of [this issue](https://github.com/telefonicaid/fiware

## `ignoreType` metadata

Appart from the metadata described in the "Builtin metadata" section in the NGSIv2 specification,
Apart from the metadata described in the "Builtin metadata" section in the NGSIv2 specification,
Orion implements the `ignoreType` metadata.

When `ignoreType` with value `true` is added to an attribute, Orion will ignore the
Expand Down Expand Up @@ -500,7 +500,7 @@ Please find details in [this specific documentation](subscriptions_alttype.md)

## Custom notification extra macros

Appart from the `${...}` macros described in "Custom Notifications" section in the NGSIv2
Apart from the `${...}` macros described in "Custom Notifications" section in the NGSIv2
specification, the following ones can be used:

* `${service}` is replaced by the service (i.e. `fiware-service` header value) in the
Expand Down

0 comments on commit c92ba18

Please sign in to comment.