From 13e62b4e5190f755cdf11e843216e9af47e31a4f Mon Sep 17 00:00:00 2001
From: Oneric <oneric@oneric.stub>
Date: Wed, 17 Jan 2024 19:12:49 +0000
Subject: [PATCH] Fix schema and docs for status_ttl_days and instance

Fixes misspelling and omission of and example in commit
0cfd5b4e89b02688342345755577e58eece3db0f which added the
status_ttl_property. This was the only place this commit
referred to the property as note_ttl_days.

Partially fixes the omitted schema update of the instance metadata addition
from commit b7e8ce235073ab45db24dfc6c27bc6998b43a200. A proper full schema
for nodeinfo is still missing.
---
 .../API/differences_in_mastoapi_responses.md  |  5 ++++
 lib/pleroma/web/api_spec/schemas/account.ex   | 23 ++++++++++++++++++-
 2 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/docs/docs/development/API/differences_in_mastoapi_responses.md b/docs/docs/development/API/differences_in_mastoapi_responses.md
index 053dc9663..9c822fbfc 100644
--- a/docs/docs/development/API/differences_in_mastoapi_responses.md
+++ b/docs/docs/development/API/differences_in_mastoapi_responses.md
@@ -113,6 +113,11 @@ Has these additional fields under the `pleroma` object:
 - `notification_settings`: object, can be absent. See `/api/v1/pleroma/notification_settings` for the parameters/keys returned.
 - `favicon`: nullable URL string, Favicon image of the user's instance
 
+Has these additional fields under the `akkoma` object:
+
+- `instance`: nullable object with metadata about the user’s instance
+- `status_ttl_days`: nullable int, default time after which statuses are deleted
+
 ### Source
 
 Has these additional fields under the `pleroma` object:
diff --git a/lib/pleroma/web/api_spec/schemas/account.ex b/lib/pleroma/web/api_spec/schemas/account.ex
index 2693eaceb..2a87065a1 100644
--- a/lib/pleroma/web/api_spec/schemas/account.ex
+++ b/lib/pleroma/web/api_spec/schemas/account.ex
@@ -112,7 +112,17 @@ defmodule Pleroma.Web.ApiSpec.Schemas.Account do
       akkoma: %Schema{
         type: :object,
         properties: %{
-          note_ttl_days: %Schema{type: :integer}
+          instance: %Schema{
+            type: :object,
+            nullable: true,
+            properties: %{
+              name: %Schema{type: :string},
+              favicon: %Schema{type: :string, format: :uri, nullable: true},
+              # XXX: proper nodeinfo schema
+              nodeinfo: %Schema{type: :object, nullable: true}
+            }
+          },
+          status_ttl_days: %Schema{type: :integer, nullable: true}
         }
       },
       source: %Schema{
@@ -205,6 +215,17 @@ defmodule Pleroma.Web.ApiSpec.Schemas.Account do
           "pleroma-fe" => %{}
         }
       },
+      "akkoma" => %{
+        "instance" => %{
+          "name" => "ihatebeinga.live",
+          "favicon" => "https://ihatebeinga.live/favicon.png",
+          "nodeinfo" =>
+            %{
+              # XXX: nodeinfo schema
+            }
+        },
+        "status_ttl_days" => nil
+      },
       "source" => %{
         "fields" => [],
         "note" => "foobar",