Skip to content

Commit

Permalink
Add Notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jason-fox committed Dec 18, 2023
1 parent af0b4c7 commit aa86457
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 23 deletions.
22 changes: 11 additions & 11 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ Mintaka が実行されたら、公開されたポートの `info` エンドポ
できます。構成には `ENDPOINTS_INFO_ENABLED=true`と `ENDPOINTS_INFO_SENSITIVE=false` が含まれているため、エンドポイント
はレスポンスを返す必要があります。

#### :one: リクエスト:
#### 1️⃣ リクエスト:

```console
curl -L -X GET \
Expand Down Expand Up @@ -367,7 +367,7 @@ curl -L -X GET \

この `lastN` パラメータは、結果を N 個に制限します。

#### :one: リクエスト:
#### 1️⃣ リクエスト:

```console
curl -G -X GET 'http://localhost:8080/temporal/entities/urn:ngsi-ld:Animal:cow002' \
Expand Down Expand Up @@ -497,7 +497,7 @@ Mintaka 実装によって暗示されるため、他の Context Broker と連

この例は、エンティティ `urn:ngsi-ld:Animal:cow002` から `heartRate` の最後の3つの変更のみを示しています。

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

```console
curl -G -X GET 'http://localhost:8080/temporal/entities/urn:ngsi-ld:Animal:cow001' \
Expand Down Expand Up @@ -565,7 +565,7 @@ curl -G -X GET 'http://localhost:8080/temporal/entities/urn:ngsi-ld:Animal:cow00

簡略化された時間表現は、次のように `options` パラメータを追加することでリクエストできます:

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

```console
curl -G -X GET 'http://localhost:8080/temporal/entities/urn:ngsi-ld:Animal:cow001' \
Expand Down Expand Up @@ -612,7 +612,7 @@ curl -G -X GET 'http://localhost:8080/temporal/entities/urn:ngsi-ld:Animal:cow00
使用して静的属性に対して作成し、クエリの時間インデックスを切り替えて、`modifiedAt` に対してルックアップを作成することも
できます。

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

次のクエリは、群れ内の雄牛に関するデータをリクエストしています。`sex` 属性は変更されないため、`timeproperty=modifiedAt`
を使用する必要があります。
Expand Down Expand Up @@ -751,7 +751,7 @@ UTC 形式で表された日時です。秒とミリ秒はオプションです

同等の簡略化された形式は、`options=temporalValues` を設定することで取得できます。

#### :five: リクエスト:
#### 5️⃣ リクエスト:

次のクエリは、群れ内の雄牛に関するデータを要求しています。`sex` 属性は変更されないため、`timeproperty=modifiedAt`
を使用する必要があります。
Expand Down Expand Up @@ -822,7 +822,7 @@ curl -G -X GET 'http://localhost:8080/temporal/entities/' \
テンポラル操作は非常に大きなペイロードを返す可能性があるため、リクエストの範囲を縮小することができます。この
`pageSize=2` パラメータは、2つのエンティティのみが返されることを意味します。

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

```console
curl -G -I -X GET 'http://localhost:8080/temporal/entities/' \
Expand Down Expand Up @@ -867,7 +867,7 @@ connection: keep-alive

追加の `pageAnchor` パラメータを使用して同じリクエストを行うと、次の2つのエンティティが取得されます:

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

```console
curl -G -X GET 'http://localhost:8080/temporal/entities/' \
Expand Down Expand Up @@ -952,7 +952,7 @@ connection: keep-alive
動物の首輪などのデバイスは、IoT Anget を介してそのデータを Context Broker に送信します。対応するエンティティは
Context Broker に保存されます。

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

```console
curl -L -X GET \
Expand Down Expand Up @@ -1030,7 +1030,7 @@ curl -L -X GET \
次のリクエストは、動物の状態が `FORAGING` (採餌) として記述されているときに登録された `heartRate` を返し、それを身に
付けている関連する Animal エンティティも返します。

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

```console
curl -G -X GET 'http://localhost:8080/temporal/entities/' \
Expand Down Expand Up @@ -1103,7 +1103,7 @@ curl -G -X GET 'http://localhost:8080/temporal/entities/' \
次のリクエストは、動物の状態が定点から800メートル未満のときに登録された `heartRate` を返し、それを身に付けている
関連する動物エンティティも返します。

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

```console
curl -G -X GET 'http://localhost:8080/temporal/entities/' \
Expand Down
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,8 @@ repository:
./services [orion|scorpio|stellio]
```

> :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 @@ -278,7 +279,7 @@ Once Mintaka is running, you can check the status by making an HTTP request to t
Since the configuration includes `ENDPOINTS_INFO_ENABLED=true` and `ENDPOINTS_INFO_SENSITIVE=false` the endpoint should
return a response

#### :one: Request:
#### 1️⃣ Request:

```console
curl -L -X GET \
Expand Down Expand Up @@ -348,7 +349,7 @@ To obtain temporal data of a context entity attribute, send a GET request to `..

The `lastN` parameter restricts the result to N values.

#### :one: Request:
#### 1️⃣ Request:

```console
curl -G -X GET 'http://localhost:8080/temporal/entities/urn:ngsi-ld:Animal:cow002' \
Expand Down Expand Up @@ -477,7 +478,7 @@ receive.

This example shows just the last 3 changes of `heartRate` from the entity `urn:ngsi-ld:Animal:cow002`.

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

```console
curl -G -X GET 'http://localhost:8080/temporal/entities/urn:ngsi-ld:Animal:cow001' \
Expand Down Expand Up @@ -543,7 +544,7 @@ In much the same manner as the `options=keyValues` parameter reduces entities to

The simplified temporal representation can be requested by adding the `options` parameter as shown:

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

```console
curl -G -X GET 'http://localhost:8080/temporal/entities/urn:ngsi-ld:Animal:cow001' \
Expand Down Expand Up @@ -589,7 +590,7 @@ Temporal Operations rely heavily on the use of the `observedAt` _property of a p
against static attributes using the `timeproperty` parameter to switch the time index for the query to make a look-up
against `modifiedAt`

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

The following query is requesting data about the bulls within the herd. Because the `sex` attribute is unchanging,
`timeproperty=modifiedAt` must be used.
Expand Down Expand Up @@ -728,7 +729,7 @@ from an Array of one element down to an object because this is the format specif

The equivalent simplified format can be retrieved by setting `options=temporalValues`

#### :five: Request:
#### 5️⃣ Request:

The following query is requesting data about the bulls within the herd. Because the `sex` attribute is unchanging,
`timeproperty=modifiedAt` must be used.
Expand Down Expand Up @@ -797,7 +798,7 @@ timestamp represents the `modifiedAt` property.
Because temporal operations can end up returning very large payloads, it is possible to reduce the scope of the request,
the `pageSize=2` parameter means that only two entities are returned:

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

```console
curl -G -I -X GET 'http://localhost:8080/temporal/entities/' \
Expand Down Expand Up @@ -842,7 +843,7 @@ the farm and that the next entity to be returned would be `urn:ngsi-ld:Animal:pi

Making the same request with an additional `pageAnchor` parameter will retrieve the next two entities

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

```console
curl -G -X GET 'http://localhost:8080/temporal/entities/' \
Expand Down Expand Up @@ -925,7 +926,7 @@ Content** HTTP Code, indicating further male animals can be found on the farm.
A device such as an animal collar, sends its data to the context broker via an IoT Agent, the corresponding entity is
stored in the context broker.

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

```console
curl -L -X GET \
Expand Down Expand Up @@ -1003,7 +1004,7 @@ can be used as part of the filter for a temporal request
The following request returns the `heartRate` registered when the state of an animal is described as `FORAGING`, and
also returns the associated animal entity that wears it.

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

```console
curl -G -X GET 'http://localhost:8080/temporal/entities/' \
Expand Down Expand Up @@ -1074,7 +1075,7 @@ can be used to trace location over time.
The following request returns the `heartRate` registered when the state of an animal is when it is less than 800 meters
from a fixed point, and also returns the associated animal entity that wears it.

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

```console
curl -G -X GET 'http://localhost:8080/temporal/entities/' \
Expand Down

0 comments on commit aa86457

Please sign in to comment.