Skip to content

Commit

Permalink
Add notes
Browse files Browse the repository at this point in the history
  • Loading branch information
@jason-fox
jason-fox committed Dec 18, 2023
1 parent beee0fd commit d8fce04
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 19 deletions.
18 changes: 9 additions & 9 deletions README.ja.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ git checkout NGSI-v2
ドポイントに POST リクエストを行うことで、新しいサブスクリプションを追加できます
:
#### :one: リクエスト :
#### 1️⃣ リクエスト :
```console
curl -iX POST \
Expand Down Expand Up @@ -341,7 +341,7 @@ function broadcastEvents(req, item, types) {
ビールのボトルの価格を 0.89 ユーロに下げましょう。これはプログラムではまだできま
せんので、次のように curl コマンドを使用して実行する必要があります :

#### :two: リクエスト :
#### 2️⃣ リクエスト :

```console
curl -iX PUT \
Expand Down Expand Up @@ -403,7 +403,7 @@ curl -iX PUT \
以下で、アイテムがストア 001 にあることをテストします。これは、他のストアが通知
によって邪魔されないようにビジネス・ロジックを設定できることを意味します。

#### :three: リクエスト :
#### 3️⃣ リクエスト :

次のコマンドは、ストア 001 の在庫不足通知です :

Expand All @@ -429,7 +429,7 @@ curl -iX POST \
}'
```

#### :four: リクエスト :
#### 4️⃣ リクエスト :

次のコマンドは、ストア 002 の在庫不足通知です :

Expand Down Expand Up @@ -522,7 +522,7 @@ POST レスポンスのヘッダに返されると自動的に生成されます
POST リクエストが `http://tutorial:3000/subscription/price-change endpoint` エン
ドポイントに送信されることが記載されています。
#### :five: リクエスト :
#### 5️⃣ リクエスト :
```console
curl -iX POST \
Expand Down Expand Up @@ -558,7 +558,7 @@ curl -iX POST \
サブスクリプションは、`/v2/subscriptions/<subscription-id>` エンドポイントに
DELETE リクエストを行うことで削除できます。

#### :six: リクエスト :
#### 6️⃣ リクエスト :

```console
curl -X DELETE \
Expand All @@ -575,7 +575,7 @@ curl -X DELETE \
サブスクリプションを更新して、`/v2/subscriptions/<subscription-id>` エンドポイン
トへの PATCH リクエストを行うことができます。

#### :seven: リクエスト :
#### 7️⃣ リクエスト :

```console
curl -iX PATCH \
Expand All @@ -601,7 +601,7 @@ curl -iX PATCH \
各サブスクリプションの通知セクションには、サブスクリプションの条件が最後に満たさ
れた時刻、および POST アクションが成功したかどうかが含まれます。

#### :eight: リクエスト :
#### 8️⃣ リクエスト :

```console
curl -X GET \
Expand All @@ -621,7 +621,7 @@ curl -X GET \
サブスクリプションの詳細は、`/v2/subscriptions/<subscription-id>` エンドポイント
に GET リクエストを行うことで読み取ることができます。

#### :nine: リクエスト :
#### 9️⃣ リクエスト :

```console
curl -X GET \
Expand Down
21 changes: 11 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,8 @@ git checkout NGSI-v2
This command will also import seed data from the previous
[Stock Management example](https://github.com/FIWARE/tutorials.Context-Providers) on startup.

> :information_source: **Note:** If you want to clean up and start over again you can do so with the following command:
> [!NOTE]
> If you want to clean up and start over again you can do so with the following command:
>
> ```console
> ./services stop
Expand Down Expand Up @@ -210,7 +211,7 @@ frequently so this would be a waste of resources and create a lot of unnecessary
The alternative is to create a subscription which will POST a payload to a "well-known" URL whenever a price has
changed. A new subscription can be added by making a POST request to the `/v2/subscriptions/` endpoint as shown below:
#### :one: Request:
#### 1️⃣ Request:
```console
curl -iX POST \
Expand Down Expand Up @@ -278,7 +279,7 @@ the product prices remain the same - for example apples remain at 0.99€
Let's reduce the price of apples to 0.89€. This can't be done programmatically yet, so it has to be done with a curl
command as shown:

#### :two: Request:
#### 2️⃣ Request:

```console
curl -iX PUT \
Expand Down Expand Up @@ -328,7 +329,7 @@ The subscription is tested whenever the `shelfCount` of an **InventoryItem** is
`"q": "shelfCount<10;refStore==urn:ngsi-ld:Store:001` tests that the `shelfCount` is below ten and that the item is in
store 001. This means that we can set up our business logic so that other stores wont be bothered by notifications.

#### :three: Request:
#### 3️⃣ Request:

The following command is a low stock notification for Store 001

Expand All @@ -354,7 +355,7 @@ curl -iX POST \
}'
```

#### :four: Request:
#### 4️⃣ Request:

The following command is a low stock notification for Store 002

Expand Down Expand Up @@ -435,7 +436,7 @@ Product entity is altered.
The notification section of the body states that a POST request containing all affected entities will be sent to the
`http://tutorial:3000/subscription/price-change` endpoint.
#### :five: Request:
#### 5️⃣ Request:
```console
curl -iX POST \
Expand Down Expand Up @@ -467,7 +468,7 @@ This example deletes the Subscription with `id=5ae079b86e4f353c5163c939` from th

Subscriptions can be deleted by making a DELETE request to the `/v2/subscriptions/<subscription-id>` endpoint.

#### :six: Request:
#### 6️⃣ Request:

```console
curl -X DELETE \
Expand All @@ -480,7 +481,7 @@ This example amends an existing subscription with the ID `5ae07c7e6e4f353c5163c9

Subscriptions can be updated making a PATCH request to the `/v2/subscriptions/<subscription-id>` endpoint.

#### :seven: Request:
#### 7️⃣ Request:

```console
curl -iX PATCH \
Expand All @@ -503,7 +504,7 @@ This example lists all subscriptions by making a GET request to the `/v2/subscri
The notification section of each subscription will also include the last time the conditions of the subscription were
met, and whether associated the POST action was successful.

#### :eight: Request:
#### 8️⃣ Request:

```console
curl -X GET \
Expand All @@ -519,7 +520,7 @@ subscription were met, and whether associated the POST action was successful.

Subscription details can be read by making a GET request to the `/v2/subscriptions/<subscription-id>` endpoint.

#### :nine: Request:
#### 9️⃣ Request:

```console
curl -X GET \
Expand Down

0 comments on commit d8fce04

Please sign in to comment.