Commit Graph

23 Commits (d33956a21c21a184395f001ba70740dc12479690)

Author SHA1 Message Date
Rosi 0fee8ff11c
spelling corrections (#1998)
Signed-off-by: Rosi2143 <Schrott.Micha@web.de>
Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
2023-02-06 10:08:51 +01:00
J-N-K 1d7bc424a1
Websocket documentation (#1952)
* Websocket documentation

Signed-off-by: Jan N. Klug <github@klug.nrw>

* fix

Signed-off-by: Jan N. Klug <github@klug.nrw>

* markdown fixes

Signed-off-by: Jan N. Klug <github@klug.nrw>

* markdown and sidebar

Signed-off-by: Jan N. Klug <github@klug.nrw>

* fix links

Signed-off-by: Jan N. Klug <github@klug.nrw>

* fix

Signed-off-by: Jan N. Klug <github@klug.nrw>

* Update configuration/websocket.md

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

Signed-off-by: Jan N. Klug <github@klug.nrw>
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
Co-authored-by: Jerome Luckenbach <email@jerome-luckenbach.de>
2022-12-11 22:03:31 +01:00
Wouter Born 4c19576ebc
Fix topic subscription example (#1951)
This seems to have been overlooked in #1313

Signed-off-by: Wouter Born <github@maindrain.net>

Signed-off-by: Wouter Born <github@maindrain.net>
2022-12-11 18:27:35 +01:00
Jerome Luckenbach ae9bdd76ec
Fix Markdown. Remove Jenkins base tags. (#1497)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2021-02-24 21:08:19 +01:00
mueller-ma 4db5920b03
Fix typo in restdocs (#1463) 2021-01-27 21:15:59 +01:00
Jerome Luckenbach 8e18bc0674
Replace local urls with inline code. Change one occurence to openhabian. (#1450)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2021-01-13 21:12:34 +01:00
Jerome Luckenbach c1903fed52
Revert #1428 (#1436)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2021-01-10 16:12:53 +01:00
Jerome Luckenbach e737d718ed
Fix linter errors 🔧(#1435)
* Fix errros for the addon folder.
* Fix errros for the administration folder.
* Fix errros for the concepts folder.
* Fix errros for the configuration folder.
* Improved and synced markdown linting rules.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2021-01-10 16:01:56 +01:00
Jerome Luckenbach d509fe56d6
Apply bulk automated corrections. 🔧(#1433)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2021-01-10 13:50:59 +01:00
spacemanspiff2007 2a76002097
Add info how to disable authentication 🔑 (#1428)
* Add info how to disable authentication


Signed-off-by: Sebastian Gerber <github@sgerber.com>

* replaced userdata with wildcard
2021-01-10 12:03:55 +01:00
Christoph Thiede b8c8ca28fc
Add section about Authentication to restdocs (#1395)
* Add section about Authentication to restdocs

Closes #1391.

* Fix markdown for code fences

Signed-off-by: Christoph Thiede <christoph.thiede@outlook.de>

* Update configuration/restdocs.md

#singoff

Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
2020-12-29 14:02:52 +01:00
Jerome Luckenbach b168c60800
Add Restdocs again (#1382)
* Bringing back rest api docs without rest docs ui paragraph.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Added som Explorer explanation.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2020-12-26 14:56:57 +01:00
Wouter Born a0816a331d
Update docs for SmartHome namespace change (#1313)
* Update docs for SmartHome namespace change

Also removes pages for the "IoT Marktplace" and "REST Docs" add-ons which no longer exists in OH3.

Signed-off-by: Wouter Born <github@maindrain.net>

* More fixes

Signed-off-by: Wouter Born <github@maindrain.net>

* Fix collateral damage

Signed-off-by: Wouter Born <github@maindrain.net>
2020-12-19 17:01:06 +01:00
Jerome Luckenbach ab36fb90f4
OH3 preparations (1/x) (#1305)
* Replace esh namespace with org.openhab in several locations

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Add armbian warning.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Adress needed installation/index changes

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Adress needed installation/rasppi changes

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Adress needed installation/docker changes

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Additional improvements for the linux article.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Additional improvements for the linux article.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Additional improvements for the linux article.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Additional improvements and renamings.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2020-12-12 12:27:08 +01:00
cvdenzen 77695884b6 Update restdocs.md (#1143)
Install REST documentation is under USER INTERFACES tab, not under Misc tab
2020-01-20 19:19:36 +01:00
Christoph Weitkamp 96c0e79195 Update restdocs.md (#1050)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2019-09-30 12:54:47 +02:00
Holger Friedrich 02448ef218 Update restdocs.md (#1019)
Added documentation for updating the state of contact items using a PUT request. POST does not work for Contact items.

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
2019-07-28 11:23:15 +02:00
Gabriel Klein 0c1331cbf1 Added some documentation on how to have access to the REST API documentation. (#595)
Signed-off-by: Gabriel Klein <gabriel.klein@nuage.ch> (github: gabrielklein)
2017-12-19 10:08:52 -05:00
Markus Lipp 813eb59f30 [REST API] Add full article, fixes #490 (#508)
* describe REST API 

describe the value of the REST API and showcase the possibilities; replacing entire current content;

Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)

* addressing review comments

Addressing all review comments:
- changed generic ip
- adapted opening sentence
- linked to OH2 security chapter 
- re-added comment on push-service
various editorial edits
Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)

* typos and grammar fixes from review

Fixed typos and grammar mistakes; added sentence that all curl and other commands are displayed in REST API as a response to "Try me out" 
Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)

* more typo, style and grammar fixes

Missed some typos, re-arranged a few sentences for better flow; fixed punctuation (hopefully)

* intro more concise; review comments addressed

Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)
2017-09-21 23:55:30 +02:00
Thomas Dietrich f18348d0f2 Correct linter warnings for configuration articles (#444)
* Correct linter warning ins config articles, part 1

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Finish configuration linter corrections

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-07-20 18:47:28 +02:00
Isaac I.Y. Saito 38ab13f154 [restdoc] Elaborate installation of local rest api doc. (#406)
Being new to OpenHAB, I had to spend half an hour to find how I can install and where I can see the rest api doc.
2017-07-06 17:44:16 +02:00
Thomas Dietrich 9afbbec26b Update restdocs.md
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich cde493073d Add REST API article
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00