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 8a8bf05 commit 86557ed
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 28 deletions.
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ EXPOSED_PORT=1026

# Orion LD variables
ORION_LD_PORT=1026
ORION_LD_VERSION=1.5.0-pre-1533
ORION_LD_VERSION=1.5.0-pre-1549

# Scorpio variables
SCORPIO_PORT=9090
Expand Down
24 changes: 12 additions & 12 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ git checkout NGSI-LD
通常どおり、公開されたポートに HTTP リクエストを送信することで、Orion Context Broker が実行されているかどうかを
確認できます:

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

```console
curl -X GET \
Expand Down Expand Up @@ -356,7 +356,7 @@ curl -X GET \
`/ngsi-ld/v1/entities` エンドポイントに POST リクエストを行い、構造化された **NGSI-LD** データとともに `@context`
を提供することで、新しいコンテキスト・データ・エンティティを作成できます。

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

```console
curl -iX POST 'http://localhost:1026/ngsi-ld/v1/entities/' \
Expand Down Expand Up @@ -417,7 +417,7 @@ Context Broker は `@context` で示されているすべてのファイルを

Core`@context`が**最後**に処理されるため、以前に同じ `@ id` で定義された用語を上書きします。

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

後続の各エンティティには、指定された `type` に対して一意の `id` が必要です。

Expand Down Expand Up @@ -522,7 +522,7 @@ UN/CEFACT [Common Codes](http://wiki.goodrelations-vocabulary.org/Documentation/
NGSI-LD に必須であり、レスポンスのフィルタリングに使用されます。Accept HTTP ヘッダは、レスポンス・ボディの
JSON-LD コンテンツを取得するために必要です。

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

```console
curl -G -X GET \
Expand Down Expand Up @@ -637,7 +637,7 @@ Link: <http://context/json-context.jsonld>; rel="http://www.w3.org/ns/json-ld#co
標準の HTTP `Link` ヘッダを使用すると、当のリソースに実際に触れることなくメタデータ (この場合は `@context`)
を渡すことができます。NGSI-LD の場合、メタデータは `application/ld+json` 形式のファイルです。

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

```console
curl -L -X GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building:farm001' \
Expand Down Expand Up @@ -705,7 +705,7 @@ Core `@context` が含まれることは常に暗示されることに注意し
返します。`type` パラメータを使用すると、レスポンスが `Building` エンティティのみに制限されます。
`options=keyValues` クエリ・パラメータを使用すると、レスポンスが標準の JSON-LD になります。

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

```console
curl -G -X GET \
Expand Down Expand Up @@ -776,7 +776,7 @@ curl -G -X GET \
`"` = `%22` で保持できます。`options=keyValues` が送信されるため、これによりペイロードの構造に影響を与えるため、
別の `@context` ファイル - `json-context.jsonld` を提供する必要があります。

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

```console
curl -G -X GET \
Expand Down Expand Up @@ -847,7 +847,7 @@ curl -G -X GET \
`alternate-context.jsonld` は、さまざまな属性の名前をドイツ語の対応する属性にマッピングします。リクエストで提供されている
場合、代替の短い名前を使用してクエリを作成できます (たとえば、`type=Building` は `type=Gebäude` になります)。

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

```console
curl -G -X GET \
Expand Down Expand Up @@ -901,7 +901,7 @@ curl -G -X GET \
文字列を含む `category` 属性を持つすべての `Building` エンティティを返します。フィルタリングは、`q`
パラメータを使用して、許容値をカンマで区切って行うことができます。

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

```console
curl -G -X GET \
Expand Down Expand Up @@ -951,7 +951,7 @@ curl -G -X GET \
フィルタリングは `q` パラメータを使用して行うことができます - サブ属性は、`q=address[addressLocality]=="Tiergarten"`
などのブラケット構文を使用して注釈が付けられます。

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

```console
curl -G -X GET 'http://localhost:1026/ngsi-ld/v1/entities/' \
Expand Down Expand Up @@ -1021,7 +1021,7 @@ curl -G -X GET 'http://localhost:1026/ngsi-ld/v1/entities/' \
メタデータ・クエリ (プロパティのプロパティなど) は、ドット構文を使用して注釈が付けられます
(例: `q=address.verified==true`)。

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

```console
curl -G -X GET \
Expand Down Expand Up @@ -1090,7 +1090,7 @@ curl -G -X GET \
これはデフォルトで NGSI-LD に指定されているため、デフォルトではジオ・クエリが `location` 属性に適用されることに
注意してください。別の属性を使用する場合は、追加の `geoproperty` パラメーターが必要です。

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

```console
curl -G -X GET \
Expand Down
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,8 @@ git checkout NGSI-LD
./services [orion|scorpio|stellio]
```

> **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:
>
> ```
> ./services stop
Expand Down Expand Up @@ -307,7 +308,7 @@ of the same model is also available, and would be use to generate code stubs in

As usual, you can check if the Orion Context Broker is running by making an HTTP request to the exposed port:

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

```console
curl -X GET \
Expand Down Expand Up @@ -340,9 +341,10 @@ work with the requests defined below.
New context data entities can be created by making a POST request to the `/ngsi-ld/v1/entities` endpoint and supply an
`@context` along with structured **NGSI-LD** data.

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

> **Note:** This entity is being created using the default **normalized** NGSI-LD format, which is the Gold Standard for
> [!NOTE]
> This entity is being created using the default **normalized** NGSI-LD format, which is the Gold Standard for
> data exchange between context brokers. NGSI-LD supports two lossless data formats
> [normalized](https://github.com/FIWARE/tutorials.CRUD-Operations/tree/NGSI-LD) and
> [concise](https://github.com/FIWARE/tutorials.Concise-Format/tree/NGSI-LD).
Expand Down Expand Up @@ -421,7 +423,7 @@ This means that the actual `@context` is:
with the core `@context` being processed **last** and therefore overriding any terms previously defined with the same
`@id`.

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

Each subsequent entity must have a unique `id` for the given `type`

Expand Down Expand Up @@ -484,7 +486,8 @@ The `type` of a _property_ attribute must be one of the following:
- For time-based values, `"Property"` shall be used as well, but the property value should be Date, Time or DateTime
strings encoded in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) - e.g. `YYYY-MM-DDThh:mm:ssZ`

> **Note:** that for simplicity, this data entity has no relationships defined. Relationships must be given the
> [!NOTE]
> Note that for simplicity, this data entity has no relationships defined. Relationships must be given the
> `type=Relationship`. Relationships will be discussed in a subsequent tutorial.

### Defining Properties-of-Properties within the NGSI-LD entity definition
Expand Down Expand Up @@ -516,7 +519,7 @@ This example returns the data of all `Building` entities within the context data
NGSI-LD and is used to filter the response. The Accept HTTP header is needed to retrieve JSON-LD content in the response
body.

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

```console
curl -G -X GET \
Expand Down Expand Up @@ -629,7 +632,7 @@ Link: <https://fiware.github.io/data-models/context.jsonld>; rel="http://www.w3.
The standard HTTP `Link` header allows metadata (in this case the `@context`) to be passed in without actually touching
the resource in question. In the case of NGSI-LD, the metadata is a file in `application/ld+json` format.

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

```console
curl -L -X GET 'http://localhost:1026/ngsi-ld/v1/entities/urn:ngsi-ld:Building:farm001' \
Expand Down Expand Up @@ -695,7 +698,7 @@ specific `type` of data. For example, the request below returns the data of all
data. Use of the `type` parameter limits the response to `Building` entities only, use of the `options=keyValues` query
parameter reduces the response down to standard JSON-LD.

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

```console
curl -G -X GET \
Expand Down Expand Up @@ -764,7 +767,7 @@ This example returns all `Building` entities with the `name` attribute _Big Red
Since `options=keyValues` is sent, this will effect the structure of the payload and we will need to supply a different
`@context` file - `json-context.jsonld`

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

```console
curl -G -X GET \
Expand Down Expand Up @@ -833,7 +836,7 @@ data_ using a different set of short names.
The `alternate-context.jsonld` maps the names of various attributes to their equivalents in German. If it is supplied in
the request a query can be made using alternate short names (e.g. `type=Building` becomes `type=Gebäude`)

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

```console
curl -G -X GET \
Expand Down Expand Up @@ -885,7 +888,7 @@ Within the standard `Building` model, the `category` attribute refers to an arra
`Building` entities with a `category` attribute which contains either `commercial` or `office` strings. Filtering can be
done using the `q` parameter, comma separating the acceptable values.

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

```console
curl -G -X GET \
Expand Down Expand Up @@ -933,7 +936,7 @@ This example returns all stores found in the Tiergarten District.
Filtering can be done using the `q` parameter - sub-attributes are annotated using the bracket syntax e.g.
`q=address[addressLocality]=="Tiergarten"`.

#### :one::zero: Request:
#### 1️⃣0️⃣ Request:

```console
curl -G -X GET 'http://localhost:1026/ngsi-ld/v1/entities/' \
Expand Down Expand Up @@ -1000,7 +1003,7 @@ of a _Property-of-a-Property_

Metadata queries (i.e. Properties of Properties) are annotated using the dot syntax e.g. `q=address.verified==true`.

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

```console
curl -G -X GET \
Expand Down Expand Up @@ -1067,7 +1070,7 @@ brackets.
Note that by default the geo-query will be applied to the `location` attribute, as this is default specified in NGSI-LD.
If another attribute is to be used, an additional `geoproperty` parameter is required.

#### :one::two: Request:
#### 1️⃣2️⃣ Request:

```console
curl -G -X GET \
Expand Down

0 comments on commit 86557ed

Please sign in to comment.