Skip to content

Commit 509e7a5

Browse files
committed
Add notes
1 parent b80f4cd commit 509e7a5

2 files changed

Lines changed: 22 additions & 22 deletions

File tree

README.ja.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ NGSI-LD サブスクリプション・リクエストの `type` は常に `type=
235235
Context Broker 自体への GET リクエストと同じように機能します。フラグが設定されていない場合、デフォルトで `@context`
236236
を含む完全な NGSI-LD レスポンスが返され、さらに制限を追加することでペイロードを削減および修正できます。
237237
238-
#### :one: リクエスト:
238+
#### 1️⃣ リクエスト:
239239
240240
```console
241241
curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \
@@ -266,7 +266,7 @@ curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \
266266
します。`notification.format=normalized` および `notification.endpoint.accept=application/ld+json` は、通知リクエストの
267267
ボディで `@context` が渡され、ペイロードが展開されたエンティティで構成されることを保証します。
268268

269-
#### :two: リクエスト:
269+
#### 2️⃣ リクエスト:
270270

271271
```console
272272
curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \
@@ -297,7 +297,7 @@ curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \
297297
サブスクリプション CRUD アクションは、以前と同じ HTTP 動詞に引き続きマップされます。`Accept:application/json` を追加
298298
すると、レスポンスボディから`@context` 要素が削除されます。
299299

300-
#### :three: リクエスト:
300+
#### 3️⃣ リクエスト:
301301

302302
```console
303303
curl -L -X GET 'http://localhost:1026/ngsi-ld/v1/subscriptions/'
@@ -468,7 +468,7 @@ Context Broker A にレジストレーションする循環依存関係を回避
468468
- NGSI-v2 属性は、`properties``relationships` の個別の配列に分割されました
469469
- NGSI-v2 `provider.url``endpoint` に移動しました
470470

471-
#### :four: リクエスト:
471+
#### 4️⃣ リクエスト:
472472

473473
```console
474474
curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/csourceRegistrations/' \
@@ -505,7 +505,7 @@ curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/csourceRegistrations/' \
505505
レジストレーションの詳細を取得するには、GETリクエストを `/ngsi-ld/v1/csourceRegistrations/` エンドポイントに送信し、
506506
`Link` ヘッダの適切な JSON-LD コンテキストとフィルタリングするエンティティの `type` を指定します。
507507

508-
#### :five: リクエスト:
508+
#### 5️⃣ リクエスト:
509509

510510
```console
511511
curl -G -iX GET 'http://localhost:1026/ngsi-ld/v1/csourceRegistrations/' \
@@ -552,7 +552,7 @@ curl -G -iX GET 'http://localhost:1026/ngsi-ld/v1/csourceRegistrations/' \
552552
レジストレーションされたエンドポイントにプロキシされます。部分的なレジストレーションの場合、プロパティと
553553
レジストレーションは Context Broker 内に保持されている既存のエンティティに追加されます。
554554

555-
#### :six: リクエスト:
555+
#### 6️⃣ リクエスト:
556556

557557
```console
558558
curl -iX GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building:store001' \
@@ -650,7 +650,7 @@ curl -iX GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building:sto
650650

651651
レジストレーションされた属性を照会するときに、同じリクエストが Context Broker 自体によって行われます。
652652

653-
#### :seven: リクエスト:
653+
#### 7️⃣ リクエスト:
654654

655655
```console
656656
curl -L -X GET 'http://localhost:3000/static/tweets/ngsi-ld/v1/entities/urn:ngsi-ld:Building:store001?attrs=tweets' \
@@ -688,7 +688,7 @@ curl -L -X GET 'http://localhost:3000/static/tweets/ngsi-ld/v1/entities/urn:ngsi
688688
読み取り/書き込みインターフェースの場合、関連する `ngsi-ld/v1/entities/<entity-id>/attrs` エンドポイントに PATCH
689689
リクエストを行うことで、コンテキスト・データを修正することもできます。
690690

691-
#### :eight: リクエスト:
691+
#### 8️⃣ リクエスト:
692692

693693
```console
694694
curl -L -X PATCH 'http://localhost:3000/static/tweets/ngsi-ld/v1/entities/urn:ngsi-ld:Building:store001/attrs' \
@@ -706,7 +706,7 @@ curl -L -X PATCH 'http://localhost:3000/static/tweets/ngsi-ld/v1/entities/urn:ng
706706
}'
707707
```
708708

709-
#### :nine: リクエスト:
709+
#### 9️⃣ リクエスト:
710710

711711
レジストレーションされた属性が Context Broker からリクエストされた場合、
712712
`http://tutorial:3000/static/tweets/ngsi-ld/v1/entities/urn:ngsi-ld:Building:store001`
@@ -746,7 +746,7 @@ curl -L -X GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building:s
746746

747747
### フォワード更新 (Forwarded-update)
748748

749-
#### :one::zero: リクエスト:
749+
#### 1️⃣0️⃣ リクエスト:
750750

751751
Context Broker への PATCH リクエスト (`ngsi-ld/v1/entities/<entity-id>/` または
752752
`ngsi-ld/v1/entities/<entity-id>/attrs`) は、レジストレーションが見つかった場合、レジストレーションされたコンテキスト
@@ -771,7 +771,7 @@ curl -L -X PATCH 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building
771771
} '
772772
```
773773

774-
#### :one::one: リクエスト:
774+
#### 1️⃣1️⃣ リクエスト:
775775

776776
前の操作の結果は、GET リクエストを使用してエンティティ全体を取得することで確認できます。
777777

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ lost, it is merely passed as a `Link` header. In summary, all of the flags withi
218218
as a GET request to the context broker itself. If no flags are set, a full NGSI-LD response including the `@context` is
219219
returned by default, and the payload can be reduced and amended by adding in further restrictions.
220220
221-
#### :one: Request:
221+
#### 1️⃣ Request:
222222
223223
```console
224224
curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \
@@ -248,7 +248,7 @@ This second request fires notifications to a different endpoint (URL
248248
`notification.endpoint.accept=application/ld+json` will ensure that the `@context` is passed in the body of the
249249
notification request and that the payload will consist of the expanded entities.
250250

251-
#### :two: Request:
251+
#### 2️⃣ Request:
252252

253253
```console
254254
curl -L -X POST 'http://localhost:1026/ngsi-ld/v1/subscriptions/' \
@@ -277,7 +277,7 @@ Subscription details can be read by making a GET request to the `/ngsi-ld/v1/sub
277277
actions continue to be mapped to the same HTTP verbs as before. Adding the `Accept: application/json` will remove the
278278
`@context` element from the response body.
279279

280-
#### :three: Request:
280+
#### 3️⃣ Request:
281281

282282
```console
283283
curl -L -X GET 'http://localhost:1026/ngsi-ld/v1/subscriptions/'
@@ -481,7 +481,7 @@ The body of the request is similar to the **NGSI-v2** equivalent with the follow
481481
special key which fires a JSON-LD expansion/compaction operation to ensure that the attribute names within the request
482482
match the expected **NGSI-v2** attribute names.
483483

484-
#### :four: Request:
484+
#### 4️⃣ Request:
485485

486486
```console
487487
curl -iX POST 'http://localhost:1026/ngsi-ld/v1/csourceRegistrations/' \
@@ -525,7 +525,7 @@ curl -iX POST 'http://localhost:1026/ngsi-ld/v1/csourceRegistrations/' \
525525
Retrieving the registration details can be made by sending a GET request to the `/ngsi-ld/v1/csourceRegistrations/`
526526
endpoint, along with an appropriate JSON-LD context in the `Link` header and the `type` of entity to filter
527527

528-
#### :five: Request:
528+
#### 5️⃣ Request:
529529

530530
```console
531531
curl -G -iX GET 'http://localhost:1026/ngsi-ld/v1/csourceRegistrations/' \
@@ -580,7 +580,7 @@ returned when an requested entity is requested. For simple registrations, a requ
580580
proxied to the registered `endpoint`, for partial registrations the `properties` and `relationships` are added to the
581581
existing entity held within the context broker.
582582

583-
#### :six: Request:
583+
#### 6️⃣ Request:
584584

585585
```console
586586
curl -iX GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building:store001' \
@@ -677,7 +677,7 @@ in this case a request is merely returning the full `tweets` attribute.
677677

678678
The same request is made by the context broker itself when querying for registered attributes
679679

680-
#### :seven: Request:
680+
#### 7️⃣ Request:
681681

682682
```console
683683
curl -L -X GET 'http://localhost:3000/static/tweets/ngsi-ld/v1/entities/urn:ngsi-ld:Building:store001?attrs=tweets' \
@@ -715,7 +715,7 @@ the response resembles any standard NGSI-LD request.
715715
For a read-write interface it is also possible to amend context data by making a PATCH request to the relevant
716716
`ngsi-ld/v1/entities/<entity-id>/attrs` endpoint.
717717

718-
#### :eight: Request:
718+
#### 8️⃣ Request:
719719

720720
```console
721721
curl -L -X PATCH 'http://localhost:3000/static/tweets/ngsi-ld/v1/entities/urn:ngsi-ld:Building:store001/attrs' \
@@ -733,7 +733,7 @@ curl -L -X PATCH 'http://localhost:3000/static/tweets/ngsi-ld/v1/entities/urn:ng
733733
}'
734734
```
735735

736-
#### :nine: Request:
736+
#### 9️⃣ Request:
737737

738738
If the regisitered attribute is requested from the context broker, it returns the _updated_ values obtained from
739739
`http://tutorial:3000/static/tweets/ngsi-ld/v1/entities/urn:ngsi-ld:Building:store001` - i.e. the forwarding endpoint.
@@ -771,7 +771,7 @@ The context broker is therefore able to return a complete holistic picture of th
771771

772772
### Forwarded Update
773773

774-
#### :one::zero: Request:
774+
#### 1️⃣0️⃣ Request:
775775

776776
A PATCH request to the context broker ( either `ngsi-ld/v1/entities/<entity-id>/` or
777777
`ngsi-ld/v1/entities/<entity-id>/attrs`) will be forwarded to the registered context provider if a registration is
@@ -795,7 +795,7 @@ curl -L -X PATCH 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building
795795
} '
796796
```
797797

798-
#### :one::one: Request:
798+
#### 1️⃣1️⃣ Request:
799799

800800
The result of the previous operation can be seen by retrieving the whole entity using a GET request.
801801

0 commit comments

Comments
 (0)