Expand descriptions of GeoJSON. by jason-fox · Pull Request #1152 · telefonicaid/iotagent-node-lib

jason-fox · 2021-11-22T13:40:42Z

Updates the documentation to explicitly include GeoJSON examples. This means that examples for the following options are now available:

NGSI-LD with legacy - (which still relies on the current conversion function used in NGSI-LD)
NGSI-LD with JEXL
NGSI-v2 with JEXL

Related #1150 , supersedes #1020

mapedraza · 2021-11-23T10:11:01Z

We would suggest to reduce the scope of this PR to only documentation changes (including the examples derived from #1050 and additional fixes).

With regards to code changes, if we have understand correctly, you are just removing old commented codes in the geoproperties autocasting part, but not implementing autocast as in line with PR #1020 (paying special attention to this comment from @fgalan #1020 (comment)). Even though with JEXL you can perform practically all the changes needed for any casting, having a library with certain common changes can be helpful for the users, especially those who have no knowledge of JEXL, as well as simplifying the devices provisioning.

In sum: reduce this PR only to documentation changes and continue the code work in #1020 (or a fresh new PR if that one is to old) towards a JEXL-independent and full-type (i.e. not only geoproperties) autocast feature.

This reverts commit 88f3937.

jason-fox · 2021-11-23T11:13:02Z

Fixed c5e3779 - this is now purely a documentation PR.

doc/expressionLanguage.md

mapedraza · 2021-11-23T14:36:38Z

doc/expressionLanguage.md

+| :------------------------------------------- | :--------------- |
+| `" a "|trim`                                 | `a`              |
+| `name|length`                                | `8`              |
+| `name|indexOf("e")`                          | `1`              |
+| `name|substring(0,name&vert;indexOf("e")+1)` | `"De"`           |

-The following are some expressions not supported by the legacy expression language:
+The following are some examples of **JEXL** expressions not supported by the **legacy** expression language:

-| Expression                                          | Expected outcome                    |
-| :-------------------------------------------------- | :---------------------------------- |
-| `value == 6? true : false`                          | `true`                              |
-| <code>value == 6 && name&vert;indexOf("e")>0</code> | `true`                              |
-| `array[1]+1`                                        | `3`                                 |
-| `object.name`                                       | `"John"`                            |
-| `{type:"Point",coordinates: [value,value]}`         | `{type:"Point",coordinates: [6,6]}` |
+| Expression                                  | Expected outcome                    | Format  |
+| :------------------------------------------ | :---------------------------------- | ------- |
+| `value == 6? true : false`                  | `true`                              | Boolean |
+| `value == 6 && name&vert;indexOf("e")>0`    | `true`                              | Integer |
+| `array[1]+1`                                | `3`                                 | Number  |
+| `object.name`                               | `"John"`                            | String  |
+| `{type:"Point",coordinates: [value,value]}` | `{type:"Point",coordinates: [6,6]}` | Object  |


Problem rendering the simbol | placed into a code block, inside a table. Almost this part need to be reverted using : <code> ... </code> and | for vertical bar |

Fixed 54b1a53 - it looks like GitHub's Markdown parser is less sophisticated than MkDocs/ReadTheDocs

doc/expressionLanguage.md

Co-authored-by: mapedraza <40356341+mapedraza@users.noreply.github.com>

doc/expressionLanguage.md

Co-authored-by: mapedraza <40356341+mapedraza@users.noreply.github.com>

mapedraza

LGTM

fgalan · 2021-11-24T13:31:31Z

doc/advanced-topics.md

+-   [Trusts concept](https://docs.openstack.org/keystone/stein/user/trusts)
+-   [Trusts API](https://docs.openstack.org/keystone/stein/api_curl_examples.html#post-v3-os-trust-trusts)
+
+### NGSI-LD `GeoProperty` support


In the ToC at the beginning of the file I see:

[GeoJSON support NGSI-LD only](#geojson-support-ngsi-ld-only)

So it seems section title and corresponding entry in ToC are not aligned...

Fixed ef3dd11

fgalan · 2021-11-24T13:36:39Z

doc/expressionLanguage.md

+| `${@pressure * 20}`     | `1040`           | Integer |
+| `${trim(@pressure)}`    | `52`             | Integer |
+| `${@consumption * 20}`  | `8.8`            | Float   |
+| `${trim(@consumption)}` | `0.44`           | Integer |


0.44 is not an Integer...

Fixed ef3dd11

fgalan · 2021-11-24T13:36:52Z

doc/expressionLanguage.md

+| `${@pressure * 20}`     | `1040`           | Integer |
+| `${@active * 20}`       | `null`           | None    |
+| `${trim(@active)`       | `null`           | None    |
+| `${trim(@consumption)}` | `0.44`           | Integer |


Fixed ef3dd11

fgalan · 2021-11-24T14:38:19Z

doc/expressionLanguage.md

+| Expression                                  | Expected outcome                    | Format  |
+| :------------------------------------------ | :---------------------------------- | ------- |
+| `value == 6? true : false`                  | `true`                              | Boolean |
+| <code>value == 6 && name&vert;indexOf("e")>0</code> | `true`                              | Integer |


Integer also in true case?

Fixed ef3dd11

fgalan

LGTM. Thanks!

jason-fox added 4 commits November 22, 2021 14:35

Expand descriptions of GeoJSON.

e724a95

Update comment in code.

88f3937

Correct JSON

c47dfc7

Fixing payload

c61a1ed

jason-fox mentioned this pull request Nov 23, 2021

Question: How to properly encode a JEXL Geo:Point #1150

Closed

Revert "Update comment in code."

c5e3779

This reverts commit 88f3937.

mapedraza reviewed Nov 23, 2021

View reviewed changes

jason-fox and others added 6 commits November 23, 2021 15:49

Update doc/expressionLanguage.md

b783e95

Co-authored-by: mapedraza <40356341+mapedraza@users.noreply.github.com>

Update doc/expressionLanguage.md

b6bfffc

Co-authored-by: mapedraza <40356341+mapedraza@users.noreply.github.com>

Update doc/expressionLanguage.md

2023a3c

Co-authored-by: mapedraza <40356341+mapedraza@users.noreply.github.com>

Update doc/expressionLanguage.md

fb73da0

Co-authored-by: mapedraza <40356341+mapedraza@users.noreply.github.com>

Add HTML |

54b1a53

Update expressionLanguage.md

3a9acf0

mapedraza reviewed Nov 24, 2021

View reviewed changes

doc/expressionLanguage.md Outdated Show resolved Hide resolved

Update doc/expressionLanguage.md

e05e4b5

Co-authored-by: mapedraza <40356341+mapedraza@users.noreply.github.com>

mapedraza approved these changes Nov 24, 2021

View reviewed changes

fgalan reviewed Nov 24, 2021

View reviewed changes

Review comments

ef3dd11

fgalan approved these changes Nov 24, 2021

View reviewed changes

fgalan merged commit 735c269 into telefonicaid:master Nov 24, 2021

Conversation

jason-fox commented Nov 22, 2021

Uh oh!

mapedraza commented Nov 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jason-fox commented Nov 23, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mapedraza left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fgalan left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mapedraza commented Nov 23, 2021 •

edited

Loading