mirrors/pleroma
1
0
Fork 0
mirror of https://git.pleroma.social/pleroma/pleroma.git synced 2024-12-23 08:36:29 +00:00
Code Issues Projects Releases Wiki Activity

Add meta-info and query strings to streaming doc

Browse source
This commit is contained in:
tusooa 2023-04-01 17:00:35 -04:00
parent f393a15dd1
commit c13f0a8460
No known key found for this signature in database
GPG key ID: 42AEC43D48433C51
1 changed files with 61 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

89
lib/pleroma/web/api_spec/operations/streaming_operation.ex
View file

@ -25,31 +25,46 @@ defmodule Pleroma.Web.ApiSpec.StreamingOperation do
%Operation{ %Operation{
tags: ["Timelines"], tags: ["Timelines"],
summary: "Establish streaming connection", summary: "Establish streaming connection",
description: "Receive statuses in real-time via WebSocket.", description: """
Receive statuses in real-time via WebSocket.
You can specify the access token on the query string or through the `sec-websocket-protocol` header. Using
the query string to authenticate is considered unsafe and should not be used unless you have to (e.g. to maintain
your client's compatibility with Mastodon).
You may specify a stream on the query string. If you do so and you are connecting to a stream that requires logged-in users,
you must specify the access token at the time of the connection (i.e. via query string or header).
Otherwise, you have the option to authenticate after you have established the connection through client-sent events.
The "Request body" section below describes what events clients can send through WebSocket, and the "Responses" section
describes what events server will send through WebSocket.
""",
security: [%{"oAuth" => ["read:statuses", "read:notifications"]}], security: [%{"oAuth" => ["read:statuses", "read:notifications"]}],
operationId: "WebsocketHandler.streaming", operationId: "WebsocketHandler.streaming",
parameters: [ parameters:
Operation.parameter(:connection, :header, %Schema{type: :string}, "connection header", [
required: true Operation.parameter(:connection, :header, %Schema{type: :string}, "connection header",
), required: true
Operation.parameter(:upgrade, :header, %Schema{type: :string}, "upgrade header", ),
required: true Operation.parameter(:upgrade, :header, %Schema{type: :string}, "upgrade header",
), required: true
Operation.parameter( ),
:"sec-websocket-key", Operation.parameter(
:header, :"sec-websocket-key",
%Schema{type: :string}, :header,
"sec-websocket-key header", %Schema{type: :string},
required: true "sec-websocket-key header",
), required: true
Operation.parameter( ),
:"sec-websocket-version", Operation.parameter(
:header, :"sec-websocket-version",
%Schema{type: :string}, :header,
"sec-websocket-version header", %Schema{type: :string},
required: true "sec-websocket-version header",
) required: true
], )
] ++ stream_params() ++ access_token_params(),
requestBody: request_body("Client-sent events", client_sent_events()), requestBody: request_body("Client-sent events", client_sent_events()),
responses: %{ responses: %{
101 => switching_protocols_response(), 101 => switching_protocols_response(),
@ -63,6 +78,20 @@ defmodule Pleroma.Web.ApiSpec.StreamingOperation do
} }
end end
defp stream_params do
stream_specifier()
|> Enum.map(fn {name, schema} ->
Operation.parameter(name, :query, schema, get_schema(schema).description)
end)
end
defp access_token_params do
[
Operation.parameter(:access_token, :query, token(), token().description),
Operation.parameter(:"sec-websocket-protocol", :header, token(), token().description)
]
end
defp switching_protocols_response do defp switching_protocols_response do
%Response{ %Response{
description: "Switching protocols", description: "Switching protocols",
@ -379,16 +408,20 @@ defmodule Pleroma.Web.ApiSpec.StreamingOperation do
"Authenticate via an access token.", "Authenticate via an access token.",
"pleroma:authenticate", "pleroma:authenticate",
%{ %{
token: %Schema{ token: token()
type: :string,
description: "An OAuth access token with corresponding permissions.",
example: "some token"
}
}, },
required: [:token] required: [:token]
) )
end end
defp token do
%Schema{
type: :string,
description: "An OAuth access token with corresponding permissions.",
example: "some token"
}
end
defp stream_specifier do defp stream_specifier do
%{ %{
stream: %Schema{ stream: %Schema{