ryze/SpaceCache
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

formatting weewoo

Browse source
This commit is contained in:
ryzetech 2023-01-19 10:10:33 +01:00
parent 57b8ad95d4
commit eb64a4448c
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
readme.md
View file

@ -33,11 +33,11 @@ So sieht ein Eintrag in der `spaces.json` aus:
"expected": "public"
}
```
`id` ist eine einfache ID des Spaces. Sollte sich natürlich nicht überschneiden.
`name` ist eine Art Friendly Name. Kann man benutzen damit es schön aussieht.
`endpoint` beschreibt die URL, die der Server anhauen soll.
`path` ist ein JSONPath zum Wert, der beschreibt, ob der Space offen ist. Das ist nur nötig, wenn die API vom SpaceAPI Standard abweicht.
`expected` kann einen Value beschreiben, wenn der Wert sich nicht durch einen Boolean darstellen lässt (also nicht `true`, `"true"`, `1`, usw.). Das sollte auch nur nötig sein, wenn die API vom SpaceAPI Srandard abweicht.
`id` ist eine einfache ID des Spaces. Sollte sich natürlich nicht überschneiden.
`name` ist eine Art Friendly Name. Kann man benutzen damit es schön aussieht.
`endpoint` beschreibt die URL, die der Server anhauen soll.
`path` ist ein JSONPath zum Wert, der beschreibt, ob der Space offen ist. Das ist nur nötig, wenn die API vom SpaceAPI Standard abweicht.
`expected` kann einen Value beschreiben, wenn der Wert sich nicht durch einen Boolean darstellen lässt (also nicht `true`, `"true"`, `1`, usw.). Das sollte auch nur nötig sein, wenn die API vom SpaceAPI Srandard abweicht.
Die `config.json` ist eigentlich selbsterklärend.