diff options
| author | Roman Chvanikov <chvanikoff@pm.me> | 2020-08-05 19:16:48 +0300 | 
|---|---|---|
| committer | Roman Chvanikov <chvanikoff@pm.me> | 2020-08-05 19:16:48 +0300 | 
| commit | 4672b61106044c3772f58b02d39531b015ad8cca (patch) | |
| tree | 0c0844bab5eae07265965b2b6dbd914afc55f9d6 /lib/pleroma/web/api_spec/operations/admin | |
| parent | 3116a75e80144dff79232c8676bd28ed285a14d9 (diff) | |
| parent | 7755f49e281e4990db5317b33d6b8e0d12982e0c (diff) | |
| download | pleroma-4672b61106044c3772f58b02d39531b015ad8cca.tar.gz pleroma-4672b61106044c3772f58b02d39531b015ad8cca.zip | |
Merge branch 'develop' into command-available-check
Diffstat (limited to 'lib/pleroma/web/api_spec/operations/admin')
7 files changed, 26 insertions, 7 deletions
| diff --git a/lib/pleroma/web/api_spec/operations/admin/config_operation.ex b/lib/pleroma/web/api_spec/operations/admin/config_operation.ex index 7b38a2ef4..3a8380797 100644 --- a/lib/pleroma/web/api_spec/operations/admin/config_operation.ex +++ b/lib/pleroma/web/api_spec/operations/admin/config_operation.ex @@ -26,6 +26,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.ConfigOperation do            %Schema{type: :boolean, default: false},            "Get only saved in database settings"          ) +        | admin_api_params()        ],        security: [%{"oAuth" => ["read"]}],        responses: %{ @@ -41,6 +42,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.ConfigOperation do        summary: "Update config settings",        operationId: "AdminAPI.ConfigController.update",        security: [%{"oAuth" => ["write"]}], +      parameters: admin_api_params(),        requestBody:          request_body("Parameters", %Schema{            type: :object, @@ -73,6 +75,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.ConfigOperation do        summary: "Get JSON with config descriptions.",        operationId: "AdminAPI.ConfigController.descriptions",        security: [%{"oAuth" => ["read"]}], +      parameters: admin_api_params(),        responses: %{          200 =>            Operation.response("Config Descriptions", "application/json", %Schema{ diff --git a/lib/pleroma/web/api_spec/operations/admin/invite_operation.ex b/lib/pleroma/web/api_spec/operations/admin/invite_operation.ex index d3af9db49..801024d75 100644 --- a/lib/pleroma/web/api_spec/operations/admin/invite_operation.ex +++ b/lib/pleroma/web/api_spec/operations/admin/invite_operation.ex @@ -20,6 +20,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.InviteOperation do        summary: "Get a list of generated invites",        operationId: "AdminAPI.InviteController.index",        security: [%{"oAuth" => ["read:invites"]}], +      parameters: admin_api_params(),        responses: %{          200 =>            Operation.response("Invites", "application/json", %Schema{ @@ -51,6 +52,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.InviteOperation do        summary: "Create an account registration invite token",        operationId: "AdminAPI.InviteController.create",        security: [%{"oAuth" => ["write:invites"]}], +      parameters: admin_api_params(),        requestBody:          request_body("Parameters", %Schema{            type: :object, @@ -71,6 +73,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.InviteOperation do        summary: "Revoke invite by token",        operationId: "AdminAPI.InviteController.revoke",        security: [%{"oAuth" => ["write:invites"]}], +      parameters: admin_api_params(),        requestBody:          request_body(            "Parameters", @@ -97,6 +100,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.InviteOperation do        summary: "Sends registration invite via email",        operationId: "AdminAPI.InviteController.email",        security: [%{"oAuth" => ["write:invites"]}], +      parameters: admin_api_params(),        requestBody:          request_body(            "Parameters", diff --git a/lib/pleroma/web/api_spec/operations/admin/media_proxy_cache_operation.ex b/lib/pleroma/web/api_spec/operations/admin/media_proxy_cache_operation.ex index 0358cfbad..20d033f66 100644 --- a/lib/pleroma/web/api_spec/operations/admin/media_proxy_cache_operation.ex +++ b/lib/pleroma/web/api_spec/operations/admin/media_proxy_cache_operation.ex @@ -33,6 +33,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.MediaProxyCacheOperation do            %Schema{type: :integer, default: 50},            "Number of statuses to return"          ) +        | admin_api_params()        ],        responses: %{          200 => success_response() @@ -46,6 +47,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.MediaProxyCacheOperation do        summary: "Remove a banned MediaProxy URL from Cachex",        operationId: "AdminAPI.MediaProxyCacheController.delete",        security: [%{"oAuth" => ["write:media_proxy_caches"]}], +      parameters: admin_api_params(),        requestBody:          request_body(            "Parameters", @@ -71,6 +73,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.MediaProxyCacheOperation do        summary: "Purge and optionally ban a MediaProxy URL",        operationId: "AdminAPI.MediaProxyCacheController.purge",        security: [%{"oAuth" => ["write:media_proxy_caches"]}], +      parameters: admin_api_params(),        requestBody:          request_body(            "Parameters", diff --git a/lib/pleroma/web/api_spec/operations/admin/oauth_app_operation.ex b/lib/pleroma/web/api_spec/operations/admin/oauth_app_operation.ex index fbc9f80d7..a75f3e622 100644 --- a/lib/pleroma/web/api_spec/operations/admin/oauth_app_operation.ex +++ b/lib/pleroma/web/api_spec/operations/admin/oauth_app_operation.ex @@ -36,6 +36,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.OAuthAppOperation do            %Schema{type: :integer, default: 50},            "Number of apps to return"          ) +        | admin_api_params()        ],        responses: %{          200 => @@ -72,6 +73,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.OAuthAppOperation do        summary: "Create OAuth App",        operationId: "AdminAPI.OAuthAppController.create",        requestBody: request_body("Parameters", create_request()), +      parameters: admin_api_params(),        security: [%{"oAuth" => ["write"]}],        responses: %{          200 => Operation.response("App", "application/json", oauth_app()), @@ -85,7 +87,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.OAuthAppOperation do        tags: ["Admin", "oAuth Apps"],        summary: "Update OAuth App",        operationId: "AdminAPI.OAuthAppController.update", -      parameters: [id_param()], +      parameters: [id_param() | admin_api_params()],        security: [%{"oAuth" => ["write"]}],        requestBody: request_body("Parameters", update_request()),        responses: %{ @@ -103,7 +105,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.OAuthAppOperation do        tags: ["Admin", "oAuth Apps"],        summary: "Delete OAuth App",        operationId: "AdminAPI.OAuthAppController.delete", -      parameters: [id_param()], +      parameters: [id_param() | admin_api_params()],        security: [%{"oAuth" => ["write"]}],        responses: %{          204 => no_content_response(), diff --git a/lib/pleroma/web/api_spec/operations/admin/relay_operation.ex b/lib/pleroma/web/api_spec/operations/admin/relay_operation.ex index 7672cb467..67ee5eee0 100644 --- a/lib/pleroma/web/api_spec/operations/admin/relay_operation.ex +++ b/lib/pleroma/web/api_spec/operations/admin/relay_operation.ex @@ -19,6 +19,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.RelayOperation do        summary: "List Relays",        operationId: "AdminAPI.RelayController.index",        security: [%{"oAuth" => ["read"]}], +      parameters: admin_api_params(),        responses: %{          200 =>            Operation.response("Response", "application/json", %Schema{ @@ -41,6 +42,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.RelayOperation do        summary: "Follow a Relay",        operationId: "AdminAPI.RelayController.follow",        security: [%{"oAuth" => ["write:follows"]}], +      parameters: admin_api_params(),        requestBody:          request_body("Parameters", %Schema{            type: :object, @@ -64,6 +66,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.RelayOperation do        summary: "Unfollow a Relay",        operationId: "AdminAPI.RelayController.unfollow",        security: [%{"oAuth" => ["write:follows"]}], +      parameters: admin_api_params(),        requestBody:          request_body("Parameters", %Schema{            type: :object, diff --git a/lib/pleroma/web/api_spec/operations/admin/report_operation.ex b/lib/pleroma/web/api_spec/operations/admin/report_operation.ex index 15e78bfaf..3bb7ec49e 100644 --- a/lib/pleroma/web/api_spec/operations/admin/report_operation.ex +++ b/lib/pleroma/web/api_spec/operations/admin/report_operation.ex @@ -48,6 +48,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.ReportOperation do            %Schema{type: :integer, default: 50},            "Number number of log entries per page"          ) +        | admin_api_params()        ],        responses: %{          200 => @@ -71,7 +72,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.ReportOperation do        tags: ["Admin", "Reports"],        summary: "Get an individual report",        operationId: "AdminAPI.ReportController.show", -      parameters: [id_param()], +      parameters: [id_param() | admin_api_params()],        security: [%{"oAuth" => ["read:reports"]}],        responses: %{          200 => Operation.response("Report", "application/json", report()), @@ -86,6 +87,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.ReportOperation do        summary: "Change the state of one or multiple reports",        operationId: "AdminAPI.ReportController.update",        security: [%{"oAuth" => ["write:reports"]}], +      parameters: admin_api_params(),        requestBody: request_body("Parameters", update_request(), required: true),        responses: %{          204 => no_content_response(), @@ -100,7 +102,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.ReportOperation do        tags: ["Admin", "Reports"],        summary: "Create report note",        operationId: "AdminAPI.ReportController.notes_create", -      parameters: [id_param()], +      parameters: [id_param() | admin_api_params()],        requestBody:          request_body("Parameters", %Schema{            type: :object, @@ -124,6 +126,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.ReportOperation do        parameters: [          Operation.parameter(:report_id, :path, :string, "Report ID"),          Operation.parameter(:id, :path, :string, "Note ID") +        | admin_api_params()        ],        security: [%{"oAuth" => ["write:reports"]}],        responses: %{ diff --git a/lib/pleroma/web/api_spec/operations/admin/status_operation.ex b/lib/pleroma/web/api_spec/operations/admin/status_operation.ex index 745399b4b..c105838a4 100644 --- a/lib/pleroma/web/api_spec/operations/admin/status_operation.ex +++ b/lib/pleroma/web/api_spec/operations/admin/status_operation.ex @@ -55,6 +55,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.StatusOperation do            %Schema{type: :integer, default: 50},            "Number of statuses to return"          ) +        | admin_api_params()        ],        responses: %{          200 => @@ -71,7 +72,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.StatusOperation do        tags: ["Admin", "Statuses"],        summary: "Show Status",        operationId: "AdminAPI.StatusController.show", -      parameters: [id_param()], +      parameters: [id_param() | admin_api_params()],        security: [%{"oAuth" => ["read:statuses"]}],        responses: %{          200 => Operation.response("Status", "application/json", status()), @@ -85,7 +86,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.StatusOperation do        tags: ["Admin", "Statuses"],        summary: "Change the scope of an individual reported status",        operationId: "AdminAPI.StatusController.update", -      parameters: [id_param()], +      parameters: [id_param() | admin_api_params()],        security: [%{"oAuth" => ["write:statuses"]}],        requestBody: request_body("Parameters", update_request(), required: true),        responses: %{ @@ -100,7 +101,7 @@ defmodule Pleroma.Web.ApiSpec.Admin.StatusOperation do        tags: ["Admin", "Statuses"],        summary: "Delete an individual reported status",        operationId: "AdminAPI.StatusController.delete", -      parameters: [id_param()], +      parameters: [id_param() | admin_api_params()],        security: [%{"oAuth" => ["write:statuses"]}],        responses: %{          200 => empty_object_response(), | 
