search

papinet / papiNet-API

papiNet is a global paper, forest products and bioproducts industry e-Business initiative.
http://www.papinet.org/
Apache License 2.0
9 stars 3 forks source link

The additional explanations/constraints on properties, such as the `...DateTime` ones, should be in the `description` property instead of YAML comments #110

Closed patricekrakow closed 2 months ago

patricekrakow commented 6 months ago

We should also make this a design rule within papiNet-JSON-Style-Guide.md.

patricekrakow commented 5 months ago

Change done in commit 4245aef.

I will create another issue #124 for the update papiNet JSON Style Guide.

patricekrakow commented 5 months ago

The description should be updated with the following text:

It MUST be a local date-time expressed using **ISO 8601-1:2019** in the extended format (excluding the basic format) without decimal fraction, and preferably without explicit time-zone, such as following examples:
  - 2023-08-16T13:00
  - 2023-08-16

excluding duration alone, but including intervals such as the following examples:
  - 2023-08-16T13:00/2023-08-18T13:00
  - 2023-08-16/2023-08-18
  - 2023-08-16T13:00/P2D
  - 2023-08-16/P2D
  - P2D/2023-08-18T13:00
  - P2D/2023-08-18

Reminder: we MUST have minLength: 4 for all ...DateTime.

patricekrakow commented 2 months ago

We forgot to close this issue, it has been fixed, see commit above.