git.squeep.com Git - akkoma/blob - lib/pleroma/web/api_spec/operations/domain_block_operation.ex

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Pleroma.Web.ApiSpec.DomainBlockOperation do
   6   alias OpenApiSpex.Operation
   7   alias OpenApiSpex.Schema
   8   import Pleroma.Web.ApiSpec.Helpers
   9
  10   def open_api_operation(action) do
  11     operation = String.to_existing_atom("#{action}_operation")
  12     apply(__MODULE__, operation, [])
  13   end
  14
  15   def index_operation do
  16     %Operation{
  17       tags: ["domain_blocks"],
  18       summary: "Fetch domain blocks",
  19       description: "View domains the user has blocked.",
  20       security: [%{"oAuth" => ["follow", "read:blocks"]}],
  21       operationId: "DomainBlockController.index",
  22       responses: %{
  23         200 =>
  24           Operation.response("Domain blocks", "application/json", %Schema{
  25             description: "Response schema for domain blocks",
  26             type: :array,
  27             items: %Schema{type: :string},
  28             example: ["google.com", "facebook.com"]
  29           })
  30       }
  31     }
  32   end
  33
  34   def create_operation do
  35     %Operation{
  36       tags: ["domain_blocks"],
  37       summary: "Block a domain",
  38       description: """
  39       Block a domain to:
  40
  41       - hide all public posts from it
  42       - hide all notifications from it
  43       - remove all followers from it
  44       - prevent following new users from it (but does not remove existing follows)
  45       """,
  46       operationId: "DomainBlockController.create",
  47       requestBody: domain_block_request(),
  48       security: [%{"oAuth" => ["follow", "write:blocks"]}],
  49       responses: %{200 => empty_object_response()}
  50     }
  51   end
  52
  53   def delete_operation do
  54     %Operation{
  55       tags: ["domain_blocks"],
  56       summary: "Unblock a domain",
  57       description: "Remove a domain block, if it exists in the user's array of blocked domains.",
  58       operationId: "DomainBlockController.delete",
  59       requestBody: domain_block_request(),
  60       parameters: [Operation.parameter(:domain, :query, %Schema{type: :string}, "Domain name")],
  61       security: [%{"oAuth" => ["follow", "write:blocks"]}],
  62       responses: %{
  63         200 => Operation.response("Empty object", "application/json", %Schema{type: :object})
  64       }
  65     }
  66   end
  67
  68   defp domain_block_request do
  69     request_body(
  70       "Parameters",
  71       %Schema{
  72         type: :object,
  73         properties: %{
  74           domain: %Schema{type: :string}
  75         }
  76       },
  77       required: false,
  78       example: %{
  79         "domain" => "facebook.com"
  80       }
  81     )
  82   end
  83 end