we should probably use ||

[akkoma] / lib / pleroma / web / api_spec.ex

diff --git a/lib/pleroma/web/api_spec.ex b/lib/pleroma/web/api_spec.ex
index 81b7bc9e843049b66f8979b4f8142cf8089ec8a6..26fed1eef3cc7eec544adaafeb3404e4942a45e7 100644 (file)
--- a/lib/pleroma/web/api_spec.ex
+++ b/lib/pleroma/web/api_spec.ex
@@ -23,21 +23,22 @@ defmodule Pleroma.Web.ApiSpec do
           []
         end,
       info: %OpenApiSpex.Info{
           []
         end,
       info: %OpenApiSpex.Info{

-        title: "Pleroma API",
+        title: "Akkoma API",

         description: """
         description: """

-        This is documentation for client Pleroma API. Most of the endpoints and entities come
+        This is documentation for the Akkoma API. Most of the endpoints and entities come

         from Mastodon API and have custom extensions on top.
 
         from Mastodon API and have custom extensions on top.
 

-        While this document aims to be a complete guide to the client API Pleroma exposes,
-        the details are still being worked out. Some endpoints may have incomplete or poorly worded documentation.
+        While this document aims to be a complete guide to the client API Akkoma exposes,
+        it may not be complete. Some endpoints may have incomplete or poorly worded documentation.

         You might want to check the following resources if something is not clear:
         - [Legacy Pleroma-specific endpoint documentation](https://docs-develop.pleroma.social/backend/development/API/pleroma_api/)
         - [Mastodon API documentation](https://docs.joinmastodon.org/client/intro/)
         You might want to check the following resources if something is not clear:
         - [Legacy Pleroma-specific endpoint documentation](https://docs-develop.pleroma.social/backend/development/API/pleroma_api/)
         - [Mastodon API documentation](https://docs.joinmastodon.org/client/intro/)

-        - [Differences in Mastodon API responses from vanilla Mastodon](https://docs-develop.pleroma.social/backend/development/API/differences_in_mastoapi_responses/)
+        - [Differences in Mastodon API responses from vanilla Mastodon](https://docs.akkoma.dev/stable/development/API/differences_in_mastoapi_responses/)

 
 

-        Please report such occurences on our [issue tracker](https://git.pleroma.social/pleroma/pleroma/-/issues). Feel free to submit API questions or proposals there too!
+        Please report such occurrences on our [issue tracker](https://akkoma.dev/AkkomaGang/akkoma). Feel free to submit API questions or proposals there too!

         """,
         """,

-        version: Application.spec(:pleroma, :vsn) |> to_string(),
+        # Strip environment from the version
+        version: Application.spec(:pleroma, :vsn) |> to_string() |> String.replace(~r/\+.*$/, ""),

         extensions: %{
           # Logo path should be picked so that the path exists both on Pleroma instances and on api.pleroma.social
           "x-logo": %{"url" => "/static/logo.svg", "altText" => "Pleroma logo"}
         extensions: %{
           # Logo path should be picked so that the path exists both on Pleroma instances and on api.pleroma.social
           "x-logo": %{"url" => "/static/logo.svg", "altText" => "Pleroma logo"}


@@ -78,22 +79,22 @@ defmodule Pleroma.Web.ApiSpec do
         "x-tagGroups": [
           %{
             "name" => "Accounts",
         "x-tagGroups": [
           %{
             "name" => "Accounts",

-            "tags" => ["Account actions", "Retrieve account information", "Scrobbles"]
+            "tags" => ["Account actions", "Retrieve account information"]

           },
           %{
             "name" => "Administration",
             "tags" => [
           },
           %{
             "name" => "Administration",
             "tags" => [

-              "Chat administration",
-              "Emoji packs",
+              "Emoji pack administration",

               "Frontend managment",
               "Instance configuration",
               "Instance documents",
               "Invites",
               "MediaProxy cache",
               "OAuth application managment",
               "Frontend managment",
               "Instance configuration",
               "Instance documents",
               "Invites",
               "MediaProxy cache",
               "OAuth application managment",

-              "Report managment",

               "Relays",
               "Relays",

-              "Status administration"
+              "Report managment",
+              "Status administration",
+              "User administration"

             ]
           },
           %{"name" => "Applications", "tags" => ["Applications", "Push subscriptions"]},
             ]
           },
           %{"name" => "Applications", "tags" => ["Applications", "Push subscriptions"]},


@@ -112,7 +113,6 @@ defmodule Pleroma.Web.ApiSpec do
             ]
           },
           %{"name" => "Instance", "tags" => ["Custom emojis"]},
             ]
           },
           %{"name" => "Instance", "tags" => ["Custom emojis"]},

-          %{"name" => "Messaging", "tags" => ["Chats", "Conversations"]},

           %{
             "name" => "Statuses",
             "tags" => [
           %{
             "name" => "Statuses",
             "tags" => [


@@ -126,7 +126,7 @@ defmodule Pleroma.Web.ApiSpec do
               "Status actions"
             ]
           },
               "Status actions"
             ]
           },

-          %{"name" => "Miscellaneous", "tags" => ["Reports", "Suggestions"]}
+          %{"name" => "Miscellaneous", "tags" => ["Emoji packs", "Reports", "Suggestions"]}

         ]
       }
     }
         ]
       }
     }