Document server-sent events of streaming

This commit is contained in:
tusooa 2023-04-01 16:07:27 -04:00
parent 844d1a14e0
commit dcef33f5f0
No known key found for this signature in database
GPG Key ID: 42AEC43D48433C51

View File

@ -7,6 +7,10 @@ defmodule Pleroma.Web.ApiSpec.StreamingOperation do
alias OpenApiSpex.Response alias OpenApiSpex.Response
alias OpenApiSpex.Schema alias OpenApiSpex.Schema
alias Pleroma.Web.ApiSpec.Helpers alias Pleroma.Web.ApiSpec.Helpers
alias Pleroma.Web.ApiSpec.NotificationOperation
alias Pleroma.Web.ApiSpec.Schemas.Chat
alias Pleroma.Web.ApiSpec.Schemas.Conversation
alias Pleroma.Web.ApiSpec.Schemas.FlakeID
alias Pleroma.Web.ApiSpec.Schemas.Status alias Pleroma.Web.ApiSpec.Schemas.Status
@spec open_api_operation(atom) :: Operation.t() @spec open_api_operation(atom) :: Operation.t()
@ -22,6 +26,7 @@ defmodule Pleroma.Web.ApiSpec.StreamingOperation do
summary: "Establish streaming connection", summary: "Establish streaming connection",
description: "Receive statuses in real-time via WebSocket.", description: "Receive statuses in real-time via WebSocket.",
security: [%{"oAuth" => ["read:statuses", "read:notifications"]}], security: [%{"oAuth" => ["read:statuses", "read:notifications"]}],
operationId: "WebsocketHandler.streaming",
parameters: [ parameters: [
Operation.parameter(:connection, :header, %Schema{type: :string}, "connection header", Operation.parameter(:connection, :header, %Schema{type: :string}, "connection header",
required: true required: true
@ -72,6 +77,11 @@ defmodule Pleroma.Web.ApiSpec.StreamingOperation do
oneOf: [ oneOf: [
update_event(), update_event(),
status_update_event(), status_update_event(),
notification_event(),
chat_update_event(),
follow_relationships_update_event(),
conversation_event(),
delete_event(),
pleroma_respond_event() pleroma_respond_event()
] ]
} }
@ -158,6 +168,102 @@ defmodule Pleroma.Web.ApiSpec.StreamingOperation do
server_sent_event_helper("Edit", "A status that was just edited", "status.update", Status) server_sent_event_helper("Edit", "A status that was just edited", "status.update", Status)
end end
defp notification_event do
server_sent_event_helper(
"Notification",
"A new notification.",
"notification",
NotificationOperation.notification()
)
end
defp follow_relationships_update_event do
server_sent_event_helper(
"Follow relationships update",
"An update to follow relationships.",
"pleroma:follow_relationships_update",
%Schema{
type: :object,
title: "Follow relationships update",
required: [:state, :follower, :following],
properties: %{
state: %Schema{
type: :string,
description: "Follow state of the relationship.",
enum: ["follow_pending", "follow_accept", "follow_reject", "unfollow"]
},
follower: %Schema{
type: :object,
description: "Information about the follower.",
required: [:id, :follower_count, :following_count],
properties: %{
id: FlakeID,
follower_count: %Schema{type: :integer},
following_count: %Schema{type: :integer}
}
},
following: %Schema{
type: :object,
description: "Information about the following person.",
required: [:id, :follower_count, :following_count],
properties: %{
id: FlakeID,
follower_count: %Schema{type: :integer},
following_count: %Schema{type: :integer}
}
}
},
example: %{
"state" => "follow_pending",
"follower" => %{
"id" => "someUser1",
"follower_count" => 1,
"following_count" => 1
},
"following" => %{
"id" => "someUser2",
"follower_count" => 1,
"following_count" => 1
}
}
}
)
end
defp chat_update_event do
server_sent_event_helper(
"Chat update",
"A new chat message.",
"pleroma:chat_update",
Chat
)
end
defp conversation_event do
server_sent_event_helper(
"Conversation",
"An update about a conversation",
"conversation",
Conversation
)
end
defp delete_event do
server_sent_event_helper(
"Delete",
"A status that was just deleted.",
"delete",
%Schema{
type: :string,
title: "Status id",
description: "Id of the deleted status",
allOf: [FlakeID],
example: "some-opaque-id"
},
payload_type: :string
)
end
defp pleroma_respond_event do defp pleroma_respond_event do
server_sent_event_helper( server_sent_event_helper(
"Server response", "Server response",