LemmyNet/lemmy-docs
2
0
Fork 0
mirror of https://github.com/LemmyNet/lemmy-docs.git synced 2024-11-22 04:11:09 +00:00
Code Issues Projects Releases Wiki Activity

Removing version from API calls. (#139)

Browse source 
* Removing version from API calls.

* Adding a link to the current API version.
This commit is contained in:
Dessalines 2022-06-13 14:55:51 -04:00 committed by GitHub
parent 28219623e7
commit 76b397aac7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/en/administration/from_scratch.md
View file

@ -62,7 +62,7 @@ NoNewPrivileges=true
WantedBy=multi-user.target WantedBy=multi-user.target
``` ```
If you did everything right, the Lemmy logs from `journalctl -u lemmy` should show "Starting http server at 127.0.0.1:8536". You can also run `curl localhost:8536/api/v3/site` which should give a successful response, looking like `{"site_view":null,"admins":[],"banned":[],"online":0,"version":"unknown version","my_user":null,"federated_instances":null}`. If you did everything right, the Lemmy logs from `journalctl -u lemmy` should show "Starting http server at 127.0.0.1:8536". You can also run `curl localhost:8536/api/{version}/site` which should give a successful response, looking like `{"site_view":null,"admins":[],"banned":[],"online":0,"version":"unknown version","my_user":null,"federated_instances":null}`.
### Install lemmy-ui (web frontend) ### Install lemmy-ui (web frontend)

6
src/en/client_development/http_api_extras.md
View file

@ -18,8 +18,10 @@ This contains extras not in the [API docs](/api).
**GET example** **GET example**
The current api `{version}` is [here](https://github.com/LemmyNet/lemmy-js-client/blob/main/src/interfaces/others.ts#L1).
``` ```
curl "http://localhost:8536/api/v2/community/list?sort=Hot"` curl "http://localhost:8536/api/{version}/community/list?sort=Hot"`
``` ```
**POST example** **POST example**
@ -33,7 +35,7 @@ curl -i -H \
"score": 1, "score": 1,
"auth": eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MiwiaXNzIjoidGVzdC5sZW1teS5tbCJ9.P77RX_kpz1a_geY5eCp29sl_5mAm-k27Cwnk8JcIZJk "auth": eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MiwiaXNzIjoidGVzdC5sZW1teS5tbCJ9.P77RX_kpz1a_geY5eCp29sl_5mAm-k27Cwnk8JcIZJk
}' \ }' \
http://localhost:8536/api/v2/comment/like http://localhost:8536/api/{version}/comment/like
``` ```
## HTTP API exclusive features ## HTTP API exclusive features