mirror of
https://github.com/LemmyNet/lemmy-docs.git
synced 2024-12-22 10:51:23 +00:00
Add workaround for external link in sidebar, replace join.lemmy.ml (#85)
* Add workaround to fix external link in sidebar (fixes #84) * Replace join.lemmy.ml with join-lemmy.org
This commit is contained in:
GitHub
parent
95031c483d
commit
6542f1c232
16 changed files with 18 additions and 14 deletions
|
|
@ -20,7 +20,7 @@
|
|||
- [Client Development](client_development/client_development.md)
|
||||
- [Theming Guide](client_development/theming.md)
|
||||
- [API reference](client_development/api_reference.md)
|
||||
- [WebSocket API](https://join.lemmy.ml/api/index.html)
|
||||
- [WebSocket API](client_development/websocket_api.md)
|
||||
- [HTTP API](client_development/http_api.md)
|
||||
- [Creating a Custom Frontend](client_development/custom_frontend.md)
|
||||
- [Contributing](contributing/contributing.md)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# API reference
|
||||
|
||||
Lemmy has two, intertwined APIs:
|
||||
- [WebSocket](https://join.lemmy.ml/api/index.html)
|
||||
- [WebSocket](https://join-lemmy.org/api/index.html)
|
||||
- [HTTP](http_api.md)
|
||||
|
||||
This page describes concepts that are common to both.
|
||||
|
|
|
|||
|
|
@ -2,5 +2,5 @@
|
|||
|
||||
- [Theming Guide](client_development/theming.md)
|
||||
- [API reference](client_development/api_reference.md)
|
||||
- [WebSocket API](https://join.lemmy.ml/api/index.html)
|
||||
- [WebSocket API](https://join-lemmy.org/api/index.html)
|
||||
- [HTTP API](client_development/http_api.md)
|
||||
|
|
@ -20,14 +20,14 @@
|
|||
|
||||
## WebSocket vs HTTP API
|
||||
Lemmy's HTTP API is almost identical to its WebSocket API:
|
||||
- **WebSocket API** needs `let send = { op: userOperation[op], data: form}` as shown in [the WebSocketAPI specification](https://join.lemmy.ml/api/index.html)
|
||||
- **WebSocket API** needs `let send = { op: userOperation[op], data: form}` as shown in [the WebSocketAPI specification](https://join-lemmy.org/api/index.html)
|
||||
- **HTTP API** needs the form (data) at the top level, an HTTP operation (GET, PUT or POST) and endpoint (at `http(s)://host/api/v2/endpoint`). For example:
|
||||
|
||||
> `POST {username_or_email: X, password: X}`
|
||||
|
||||
For more information, see the [http.ts](https://github.com/LemmyNet/lemmy-js-client/blob/main/src/http.ts) file.
|
||||
|
||||
[The WebSocket API](https://join.lemmy.ml/api/index.html) should be regarded as the primary source for the HTTP API since it also provides information about how to form HTTP API calls.
|
||||
[The WebSocket API](https://join-lemmy.org/api/index.html) should be regarded as the primary source for the HTTP API since it also provides information about how to form HTTP API calls.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
1
src/en/client_development/websocket_api.md
Normal file
1
src/en/client_development/websocket_api.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# [WebSocket API](https://join-lemmy.org/api/index.html)
|
||||
|
|
@ -20,7 +20,7 @@
|
|||
- [Client Development](client_development/client_development.md)
|
||||
- [Theming Guide](client_development/theming.md)
|
||||
- [API reference](client_development/api_reference.md)
|
||||
- [WebSocket API](https://join.lemmy.ml/api/index.html)
|
||||
- [WebSocket API](client_development/websocket_api.md)
|
||||
- [HTTP API](client_development/http_api.md)
|
||||
- [Creating a Custom Frontend](client_development/custom_frontend.md)
|
||||
- [Contributing](contributing/contributing.md)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# API reference
|
||||
|
||||
Lemmy has two, intertwined APIs:
|
||||
- [WebSocket](https://join.lemmy.ml/api/index.html)
|
||||
- [WebSocket](https://join-lemmy.org/api/index.html)
|
||||
- [HTTP](http_api.md)
|
||||
|
||||
This page describes concepts that are common to both.
|
||||
|
|
|
|||
|
|
@ -2,5 +2,5 @@
|
|||
|
||||
- [Theming Guide](client_development/theming.md)
|
||||
- [API reference](client_development/api_reference.md)
|
||||
- [WebSocket API](https://join.lemmy.ml/api/index.html)
|
||||
- [WebSocket API](https://join-lemmy.org/api/index.html)
|
||||
- [HTTP API](client_development/http_api.md)
|
||||
|
|
@ -20,14 +20,14 @@
|
|||
|
||||
## WebSocket vs HTTP API
|
||||
Lemmy's HTTP API is almost identical to its WebSocket API:
|
||||
- **WebSocket API** needs `let send = { op: userOperation[op], data: form}` as shown in [the WebSocketAPI specification](https://join.lemmy.ml/api/index.html)
|
||||
- **WebSocket API** needs `let send = { op: userOperation[op], data: form}` as shown in [the WebSocketAPI specification](https://join-lemmy.org/api/index.html)
|
||||
- **HTTP API** needs the form (data) at the top level, an HTTP operation (GET, PUT or POST) and endpoint (at `http(s)://host/api/v2/endpoint`). For example:
|
||||
|
||||
> `POST {username_or_email: X, password: X}`
|
||||
|
||||
For more information, see the [http.ts](https://github.com/LemmyNet/lemmy-js-client/blob/main/src/http.ts) file.
|
||||
|
||||
[The WebSocket API](https://join.lemmy.ml/api/index.html) should be regarded as the primary source for the HTTP API since it also provides information about how to form HTTP API calls.
|
||||
[The WebSocket API](https://join-lemmy.org/api/index.html) should be regarded as the primary source for the HTTP API since it also provides information about how to form HTTP API calls.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
1
src/es/client_development/websocket_api.md
Normal file
1
src/es/client_development/websocket_api.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# [WebSocket API](https://join-lemmy.org/api/index.html)
|
||||
|
|
@ -20,7 +20,7 @@
|
|||
- [Client Development](client_development/client_development.md)
|
||||
- [Theming Guide](client_development/theming.md)
|
||||
- [API reference](client_development/api_reference.md)
|
||||
- [WebSocket API](https://join.lemmy.ml/api/index.html)
|
||||
- [WebSocket API](client_development/websocket_api.md)
|
||||
- [HTTP API](client_development/http_api.md)
|
||||
- [Creating a Custom Frontend](client_development/custom_frontend.md)
|
||||
- [Contributing](contributing/contributing.md)
|
||||
|
|
|
|||
1
src/fr/client_development/websocket_api.md
Normal file
1
src/fr/client_development/websocket_api.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# [WebSocket API](https://join-lemmy.org/api/index.html)
|
||||
|
|
@ -20,7 +20,7 @@
|
|||
- [Разработка Клиентов](client_development/client_development.md)
|
||||
- [Руководство по темам](client_development/theming.md)
|
||||
- [Справочник по API](client_development/api_reference.md)
|
||||
- [WebSocket API](https://join.lemmy.ml/api/index.html)
|
||||
- [WebSocket API](client_development/websocket_api.md)
|
||||
- [HTTP API](client_development/http_api.md)
|
||||
- [Создание пользовательского интерфейса](client_development/custom_frontend.md)
|
||||
- [Вклад](contributing/contributing.md)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Справочник по API
|
||||
|
||||
Lemmy имеет два взаимосвязанных API:
|
||||
- [WebSocket (анг.язык)](https://join.lemmy.ml/api/index.html)
|
||||
- [WebSocket (анг.язык)](https://join-lemmy.org/api/index.html)
|
||||
- [HTTP (анг.язык)](http_api.md)
|
||||
|
||||
На этой странице описаны общие для них концепции.
|
||||
|
|
|
|||
|
|
@ -2,5 +2,5 @@
|
|||
|
||||
- [Тематическое руководство ](client_development/theming.md)
|
||||
- [Справочник по API](client_development/api_reference.md)
|
||||
- [WebSocket API](https://join.lemmy.ml/api/index.html)
|
||||
- [WebSocket API](https://join-lemmy.org/api/index.html)
|
||||
- [HTTP API](client_development/http_api.md)
|
||||
|
|
|
|||
1
src/ru/client_development/websocket_api.md
Normal file
1
src/ru/client_development/websocket_api.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# [WebSocket API](https://join-lemmy.org/api/index.html)
|
||||
Loading…
Reference in a new issue