From 7fa5dce966034fa8e73895ed2c3f2a0e0e83176d Mon Sep 17 00:00:00 2001 From: Jason Fox Date: Mon, 18 Dec 2023 11:33:00 +0100 Subject: [PATCH] Add notes --- README.ja.md | 8 ++++---- README.md | 14 ++++++++------ 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.ja.md b/README.ja.md index c1cbe99..6337e37 100644 --- a/README.ja.md +++ b/README.ja.md @@ -589,7 +589,7 @@ Core NGSI-LD の `@context` は、`name` = `https://uri.etsi.org/ngsi-ld/name` > **注**: 比較のために、標準のチュートリアル JSON-LD `@context` ファイルはこちらにあります。: > `https://fiware.github.io/tutorials.Step-by-Step/tutorials-context.jsonld` -#### :one: リクエスト: +#### 1️⃣ リクエスト: データ・エンティティを作成する際、日本語の JSON-LD `@context` にマッピングされたすべての URI の短縮名は、リクエストの ペイロードで自由に使用できます。 @@ -640,7 +640,7 @@ JSON-LD `@context` ファイルは、**Building** エンティティに使用さ `@context` で指定された短縮名を使用して返すことができます。これは、`Link` ヘッダは、tutorial JSON-LD の`@context` ファイルを指しています。 -#### :two: リクエスト: +#### 2️⃣ リクエスト: ```bash curl -L -X GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building:store005' \ @@ -691,7 +691,7 @@ curl -L -X GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building:s 既存の **Building** エンティティを読み取り、日本語の `@context` を適用できます。使用する `@context` は、`Link` ヘッダで 提供されます。 -#### :three: リクエスト: +#### 3️⃣ リクエスト: ```bash curl -L -X GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building:store003' \ @@ -770,7 +770,7 @@ function translateRequest(req, res) { } ``` -#### :four: リクエスト: +#### 4️⃣ リクエスト: リクエストを Context Broker に転送してから展開/圧縮操作を適用する `/japanese` エンドポイントが作成されました。 diff --git a/README.md b/README.md index 9f15ec1..6a2fd9d 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,8 @@ application runs on the following URLs: - `http://localhost:3000/app/store/urn:ngsi-ld:Building:store003` - `http://localhost:3000/app/store/urn:ngsi-ld:Building:store004` -> :information_source: **Tip** Additionally, you can also watch the status of recent requests yourself by following the +> [!TIP] +> Additionally, you can also watch the status of recent requests yourself by following the > container logs or viewing information on `localhost:3000/app/monitor` on a web browser. > > ![FIWARE Monitor](https://fiware.github.io/tutorials.Working-with-Linked-Data/img/monitor.png) @@ -569,10 +570,11 @@ An alternative Japanese JSON-LD `@context` file has been created and published t found here: `https://fiware.github.io/tutorials.Step-by-Step/japanese-context.jsonld`. Alternate data mappings can be found for all attribute names used within the tutorials. -> :information_source: **Note**: For comparison the standard tutorial JSON-LD `@context` file can be found here: +> [!NOTE] +> For comparison the standard tutorial JSON-LD `@context` file can be found here: > `https://fiware.github.io/tutorials.Step-by-Step/tutorials-context.jsonld` -#### :one: Request: +#### 1️⃣ Request: When creating a data entity, short names for all of the URIs mapped in the Japanese JSON-LD `@context` can be used freely in the payload of the request. @@ -623,7 +625,7 @@ Therefore it is possible to request the new **Building** (created using the Japa using the short names specified in the standard tutorial JSON-LD `@context`, this is done by supplying the `Link` header is pointing to the tutorial JSON-LD `@context` file. -#### :two: Request: +#### 2️⃣ Request: ```console curl -L -X GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building:store005' \ @@ -672,7 +674,7 @@ With one exception, there is no hierarchy defined within NGSI-LD `@context` file possible to read any of the existing **Building** entities and apply the Japanese `@context`. The `@context` to used is supplied in the `Link` header. -#### :three: Request: +#### 3️⃣ Request: ```console curl -L -X GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building:store003' \ @@ -751,7 +753,7 @@ function translateRequest(req, res) { } ``` -#### :four: Request: +#### 4️⃣ Request: A `/japanese` endpoint has been created which forwards a request to the context broker and then applies an expansion/compaction operation.