Skip to content

Commit

Permalink
Minor corrections to the links
Browse files Browse the repository at this point in the history
  • Loading branch information
@jonginter
jonginter committed Apr 26, 2018
1 parent 2c86008 commit 265a39c
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 35 deletions.
8 changes: 4 additions & 4 deletions versions/general-0.0.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,31 +114,31 @@ Here is an example of a properly formatted timestamp…
# Common Structures
Many concepts use the same data structures to report their essential information. Those structures are listed here.

## Info
## Info Data
| Name | Description | Unit |
| ----------- | ----------------------------------------------- | ---- |
| id | ID of the entity | uid |
| zone | ID of the zone containing this entity | uid |
| compartment | ID of the compartment that contains this entity | uid |
| facility | ID of the facility that contains this entity | uid |

## Version
## Version Data
| Name | Description | Unit |
| ------- | ------------------------------------------ | ---- |
| id | unique id of the device | uid |
| make | Name of the company that makes this device | text |
| model | Model number of this device | text |
| version | Version number of this device | text |

## Location
## Location Data
| Name | Description | Unit |
| ---- | ------------------------------------------------------- | ---- |
| id | Unique id of this entity | uid |
| x | x coordinate of this entity within its parent container | m |
| y | y coordinate of this entity within its parent container | m |
| z | z coordinate of this entity within its parent container | m |

## Dimensions
## Dimension Data
| Name | Description | Unit |
| ------ | ----------------------- | ---- |
| id | Unique id of the entity | uid |
Expand Down
36 changes: 18 additions & 18 deletions versions/light-0.0.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S
```
GET http://[domain:port]/agroapi/[version]/lights/sensors/[sensorid]/info
```
Returns [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info)
Returns [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info-data)

```
GET http://[domain:port]/agroapi/[version]/lights/sensors/[sensorid]/version
```
Returns [Version](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#version)
Returns [Version](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#version-data)

```
GET http://[domain:port]/agroapi/[version]/lights/sensors/[sensorid]/location
```
Returns [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location)
Returns [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location-data)

```
GET http://[domain:port]/agroapi/[version]/lights/sensors/[sensorid]/ppf
Expand All @@ -42,17 +42,17 @@ Returns [Light PPFD](https://github.com/open-ag-tech/api-spec/blob/master/versio
```
GET http://[domain:port]/agroapi/[version]/lights/sensors/info
```
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info)
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info-data)

```
GET http://[domain:port]/agroapi/[version]/lights/sensors/version
```
Returns an array of [Version](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#version)
Returns an array of [Version](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#version-data)

```
GET http://[domain:port]/agroapi/[version]/lights/sensors/location
```
Returns an array of [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location)
Returns an array of [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location-data)

```
GET http://[domain:port]/agroapi/[version]/lights/sensors/ppf
Expand All @@ -68,17 +68,17 @@ Returns an array of [Light PPFD](https://github.com/open-ag-tech/api-spec/blob/m
```
GET http://[domain:port]/agroapi/[version]/zones/[zoneid]/lights/sensors/info
```
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info)
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info-data)

```
GET http://[domain:port]/agroapi/[version]/zones/[zoneid]/lights/sensors/version
```
Returns an array of [Version](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#version)
Returns an array of [Version](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#version-data)

```
GET http://[domain:port]/agroapi/[version]/zones/[zoneid]/lights/sensors/location
```
Returns an array of [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location)
Returns an array of [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location-data)

```
GET http://[domain:port]/agroapi/[version]/zones/[zoneid]/lights/sensors/ppf
Expand Down Expand Up @@ -121,17 +121,17 @@ Returns an array of [Light PPFD](https://github.com/open-ag-tech/api-spec/blob/m
```
GET http://[domain:port]/agroapi/[version]/lights/fixtures/[fixtureid]/info
```
Returns [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info)
Returns [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info-data)

```
GET http://[domain:port]/agroapi/[version]/lights/fixtures/[fixtureid]/version
```
Returns [Version](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#version)
Returns [Version](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#version-data)

```
GET http://[domain:port]/agroapi/[version]/lights/fixtures/[fixtureid]/location
```
Returns [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location)
Returns [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location-data)

```
GET http://[domain:port]/agroapi/[version]/lights/fixtures/[fixtureid]/config
Expand All @@ -147,17 +147,17 @@ Returns [Fixture Power](https://github.com/open-ag-tech/api-spec/blob/master/ver
```
GET http://[domain:port]/agroapi/[version]/lights/fixtures/info
```
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info)
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info-data)

```
GET http://[domain:port]/agroapi/[version]/lights/fixtures/version
```
Returns an array of [Version](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#version)
Returns an array of [Version](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#version-data)

```
GET http://[domain:port]/agroapi/[version]/lights/fixtures/location
```
Returns an array of [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location)
Returns an array of [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location-data)

```
GET http://[domain:port]/agroapi/[version]/lights/fixtures/config
Expand All @@ -173,17 +173,17 @@ Returns an array of [Fixture Power](https://github.com/open-ag-tech/api-spec/blo
```
GET http://[domain:port]/agroapi/[version]/zones/[zoneid]/lights/fixtures/info
```
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info)
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info-data)

```
GET http://[domain:port]/agroapi/[version]/zones/[zoneid]/lights/fixture/[fixtureid]/version
```
Returns an array of [Version](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#version)
Returns an array of [Version](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#version-data)

```
GET http://[domain:port]/agroapi/[version]/zones/[zoneid]/lights/fixtures/location
```
Returns an array of [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location)
Returns an array of [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location-data)

```
GET http://[domain:port]/agroapi/[version]/zones/[zoneid]/lights/fixtures/config
Expand Down
26 changes: 13 additions & 13 deletions versions/plan-0.0.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,71 +41,71 @@ Returns an array of Compartment IDs
```
GET http://[domain:port]/agroapi/[version]/plan/compartments/info
```
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info)
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info-data)

```
GET http://[domain:port]/agroapi/[version]/plan/compartments/location
```
Returns an array of [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location)
Returns an array of [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location-data)
```
GET http://[domain:port]/agroapi/[version]/plan/compartments/dimensions
```
Returns an array of [Dimensions](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#dimensions)
Returns an array of [Dimensions](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#dimension-data)


### Single compartment
```
GET http://[domain:port]/agroapi/[version]/plan/compartments/[compartmentid]/info
```
Returns [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info)
Returns [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info-data)

```
GET http://[domain:port]/agroapi/[version]/plan/compartments/[compartmentid]/location
```
Returns [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location)
Returns [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location-data)

```
GET http://[domain:port]/agroapi/[version]/plan/compartments/[compartmentid]/dimensions
```
Returns [Dimensions](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#dimensions)
Returns [Dimensions](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#dimension-data)

```
GET http://[domain:port]/agroapi/[version]/plan/compartment/[compartmentid]/zones
```
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info)
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info-data)

## Zones
### All zones
```
GET http://[domain:port]/agroapi/[version]/plan/zones/info
```
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info)
Returns an array of [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info-data)

```
GET http://[domain:port]/agroapi/[version]/plan/zones/location
```
Returns an array of [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location)
Returns an array of [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location-data)

```
GET http://[domain:port]/agroapi/[version]/plan/zones/dimensions
```
Returns an array of [Dimensions](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#dimensions)
Returns an array of [Dimensions](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#dimension-data)

### Single zone
```
GET http://[domain:port]/agroapi/[version]/plan/zones/[zoneid]/info
```
Returns [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info)
Returns [Info](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#info-data)

```
GET http://[domain:port]/agroapi/[version]/plan/zones/[zoneid]/location
```
Returns [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location)
Returns [Location](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#location-data)

```
GET http://[domain:port]/agroapi/[version]/plan/zones/[zoneid]/dimensions
```
Returns [Dimensions](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#dimensions)
Returns [Dimensions](https://github.com/open-ag-tech/api-spec/blob/master/versions/general-0.0.1.md#dimension-data)

```
GET http://[domain:port]/agroapi/[version]/plan/zones/[zoneid]/zones
Expand Down

0 comments on commit 265a39c

Please sign in to comment.