From a78d3322c979c1c5d695e5aefa2bdc80205396e3 Mon Sep 17 00:00:00 2001 From: Raphael Nestler Date: Sat, 28 Dec 2024 23:03:06 +0100 Subject: [PATCH 1/2] Update docs to v15 --- content/docs/contents.lr | 433 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 403 insertions(+), 30 deletions(-) diff --git a/content/docs/contents.lr b/content/docs/contents.lr index e0ec164..091ca93 100644 --- a/content/docs/contents.lr +++ b/content/docs/contents.lr @@ -1,6 +1,6 @@ _model: page --- -title: Schema Documentation v14 +title: Schema Documentation v15 --- body: @@ -39,7 +39,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
Nested array items:
string
Required item values:
-

The array must contain the value 14.

+

The array must contain the value 15.

@@ -79,12 +79,15 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
  • location(object) -required
    Details
    -

    Position data such as a postal address or geographic coordinates

    +

    Position data such as a postal address or geographic coordinates. May be omitted for spaces without a fixed physical location.

    +
    +
    Minimum number of properties:
    +
    1
    +

    Nested object properties

    • @@ -100,23 +103,29 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    • lat(number) -required
      Details

      Latitude of your space location, in degree with decimal places. Use positive values for locations north of the equator, negative values for locations south of equator.

      +
      +
      Requires other fields:
      +
      lon
      +
    • lon(number) -required
      Details

      Longitude of your space location, in degree with decimal places. Use positive values for locations east of Greenwich, and negative values for locations west of Greenwich.

      +
      +
      Requires other fields:
      +
      lat
      +
    • @@ -133,6 +142,94 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    • +
  • +
    +country_code(string) +
    +
    +Details +
    +

    Country code in ISO 3166 alpha-2 format

    +
    +
    Examples:
    +
    CH, DE, UA
    +
    +
    +
    • +
  • +
    +hint(string) +
    +
    +Details +
    +

    Information that can be used to describe how to access your space, if it is not trivial to find when standing at the address

    +
    +
    Examples:
    +
    Ring the doorbell marked with HACKSPACE, Knock three times, say Shibboleet and follow the white rabbit
    +
    +
    +
    • +
  • +
    +areas(array of object) +
    +
    +Details +
    +

    A list of areas in your space. Must include at least 1 area if defined.

    +
    +
    Minimum number of items:
    +
    1
    +
    +

    Nested array items

    +
      +
    • +
      +name(string) +
      +
      +Details +
      +

      The name of this area

      +
      +
      Examples:
      +
      Hackerspace, Kitchen, Workshop
      +
      +
      +
      • +
    • +
      +description(string) +
      +
      +Details +
      +

      A description of this area

      +
      +
      Examples:
      +
      Our hackerspace area, Woodworking machines and power tools
      +
      +
      +
      • +
    • +
      +square_meters(number) +required +
      +
      +Details +
      +

      The size of this area in square meters

      +
      +
      Examples:
      +
      23.23, 42
      +
      +
      +
      • +
    +
    +
    • @@ -202,12 +299,11 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
  • open(boolean) -nullable
    Details
    -

    A flag which indicates whether the space is currently open or closed. The state 'undefined' can be achieved by omitting this field. A missing 'open' property carries the semantics of a temporary unavailability of the state, whereas the absence of the 'state' property itself means the state is generally not implemented for this space. This field is also allowed to explicitly have the value null for backwards compatibility with older schema versions, but this is deprecated and will be removed in a future version.

    +

    A flag which indicates whether the space is currently open or closed. The state 'undefined' can be achieved by omitting this field. A missing 'open' property carries the semantics of a temporary unavailability of the state, whereas the absence of the 'state' property itself means the state is generally not implemented for this space.

  • @@ -217,7 +313,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    The Unix timestamp when the space status changed most recently

    +

    The Unix timestamp (in seconds) when the space status changed most recently

  • @@ -227,7 +323,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    The person who lastly changed the state e.g. opened or closed the space

    +

    The person who lastly changed the state e.g. opened or closed the space.

  • @@ -318,7 +414,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    Unix timestamp when the event occurred

    +

    The Unix timestamp (in seconds) when the event occurred.

  • @@ -342,7 +438,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    Contact information about your space

    +

    Contact information about your space. You must define at least one which is in the list of allowed values of the issue_report_channels field.

    Nested object properties

    • @@ -428,7 +524,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
      Details
      -

      Email address which can be base64 encoded

      +

      Email address which can be base64 encoded.

    • @@ -535,7 +631,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
      Details
      -

      Facebook account URL

      +

      Facebook account URL.

    • @@ -555,7 +651,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
      Details
      -

      Foursquare ID, in the form 4d8a9114d85f3704eab301dc

      +

      Foursquare ID, in the form 4d8a9114d85f3704eab301dc.

    • @@ -682,7 +778,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
      Details
      -

      The unit of the sensor value

      +

      The unit of the sensor value.

      Valid values:
      °C | °F | K | °De | °N | °R | °Ré | °Rø
      @@ -724,6 +820,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

      An extra field that you can use to attach some additional information to this sensor instance

      • +
    • +
      +lastchange(number) +
      +
      +Details +
      +

      The Unix timestamp (in seconds) when the sensor value changed most recently

      +
      +
    • @@ -734,7 +840,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    Sensor type to indicate if a certain door is locked

    +

    Sensor type to indicate if a certain door is locked.

    Nested array items

    • @@ -783,6 +889,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

      An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -815,10 +931,10 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    The unit of pressure used by your sensor
    Note: The hPA unit is deprecated and should not be used anymore. Use the correct hPa unit instead.

    +

    The unit of pressure used by your sensor

    Valid values:
    -
    hPa | hPA
    +
    hPa
    @@ -857,6 +973,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -960,6 +1086,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -1053,6 +1189,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -1146,6 +1292,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -1239,6 +1395,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -1274,7 +1440,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.

    +

    The humidity unit

    Valid values:
    %
    @@ -1316,6 +1482,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -1389,6 +1565,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -1421,10 +1607,10 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.

    +

    The power unit

    Valid values:
    -
    mW | W | VA
    +
    W | VA
    @@ -1463,6 +1649,100 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • + + + +
  • +
    +power_generation(array of object) +
    +
    +Details +
    +

    The power generation of a specific device or of your whole space

    +

    Nested array items

    +
      +
    • +
      +value(number) +required +
      +
      +Details +
      +

      The sensor value

      +
      +
      • +
    • +
      +unit(string) +required +
      +
      +Details +
      +

      The unit of the sensor value.

      +
      +
      Valid values:
      +
      W | VA
      +
      +
      +
      • +
    • +
      +location(string) +required +
      +
      +Details +
      +

      The location of your sensor

      +
      +
      Examples:
      +
      Room 1, Lab
      +
      +
      +
      • +
    • +
      +name(string) +
      +
      +Details +
      +

      This field is an additional field to give your sensor a name. This can be useful if you have multiple sensors in the same location.

      +
      +
      • +
    • +
      +description(string) +
      +
      +Details +
      +

      An extra field that you can use to attach some additional information to this sensor instance

      +
      +
      • +
    • +
      +lastchange(number) +
      +
      +Details +
      +

      The Unix timestamp (in seconds) when the sensor value changed most recently

      +
      +
    • @@ -1517,7 +1797,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.

    +

    The wind speed unit

    Valid values:
    m/s | km/h | kn
    @@ -1557,7 +1837,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.

    +

    The gust speed unit

    Valid values:
    m/s | km/h | kn
    @@ -1597,7 +1877,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.

    +

    The direction unit

    Valid values:
    °
    @@ -1637,7 +1917,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    The unit of the sensor value. You should always define the unit though if the sensor is a flag of a boolean type then you can of course omit it.

    +

    The elevation unit

    Valid values:
    m
    @@ -1685,6 +1965,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -1791,6 +2081,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -1856,6 +2156,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -1910,6 +2220,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -1982,6 +2302,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -2100,6 +2430,16 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    An extra field that you can use to attach some additional information to this sensor instance

    +
  • +
    +lastchange(number) +
    +
    +Details +
    +

    The Unix timestamp (in seconds) when the sensor value changed most recently

    +
    +
    • @@ -2303,7 +2643,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    The link name

    +

    The link name.

  • @@ -2324,7 +2664,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    The URL

    +

    The URL.

    • @@ -2392,7 +2732,7 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t

    How often is the membership billed? If you select other, please specify in the description what your billing interval is.

    Valid values:
    -
    yearly | monthly | weekly | daily | hourly | other
    +
    yearly | quarterly | monthly | weekly | daily | hourly | other
    @@ -2403,7 +2743,40 @@ You can use the [SpaceAPI validator](/validator/) to verify that you implement t
    Details
    -

    A free form string

    +

    A free form string.

    +
    + + + + +
  • +
    +linked_spaces(array of object) +
    +
    +Details +
    +

    A list of spaces you know and feel connected too.

    +

    Nested array items

    +
      +
    • +
      +endpoint(string) +
      +
      +Details +
      +

      The SpaceAPI endpoint of the space

      +
      +
      • +
    • +
      +website(string) +
      +
      +Details +
      +

      The website of the space

    From c102b0bf1bc24ce63e04f29dd6cfa0bd8754bb35 Mon Sep 17 00:00:00 2001 From: Raphael Nestler Date: Sat, 28 Dec 2024 23:03:11 +0100 Subject: [PATCH 2/2] Update example to be v14 and v15 compatible --- content/contents.lr | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/contents.lr b/content/contents.lr index 5598d77..4d4fc9d 100644 --- a/content/contents.lr +++ b/content/contents.lr @@ -13,12 +13,11 @@ The directory is a curated list of places providing a JSON file based on the [Sc A standardized JSON file that can be used to expose information about hackerspaces, makerspaces, fablabs, chaostreffs and the like across the world to web apps or any other application. The specification uses [JSON Schema](https://json-schema.org/). -The following example shows how it looks like (compatible with both version 0.13 and 14): +The following example shows how it looks like (compatible with both version 14 and 15): ```json { - "api": "0.13", - "api_compatibility": ["14"], + "api_compatibility": ["14", "15"], "space": "Shackspace", "logo": "http://rescue.shackspace.de/images/logo_shack_brightbg_highres.png", "url": "http://shackspace.de",