add links to masto docs, not-documented entity TODO list

halcy · May 29, 2023 · a2e6e57 · a2e6e57
1 parent acb0b17
commit a2e6e57
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 36 deletions.
diff --git a/srcgen/entities_todo.txt b/srcgen/entities_todo.txt
@@ -0,0 +1,14 @@
+https://docs.joinmastodon.org/entities/Admin_CanonicalEmailBlock/
+https://docs.joinmastodon.org/entities/Admin_DomainAllow/
+https://docs.joinmastodon.org/entities/Admin_EmailDomainBlock/
+https://docs.joinmastodon.org/entities/Admin_IpBlock/
+https://docs.joinmastodon.org/entities/DomainBlock/
+https://docs.joinmastodon.org/entities/ExtendedDescription/
+https://docs.joinmastodon.org/entities/Filter/
+https://docs.joinmastodon.org/entities/FilterKeyword/
+https://docs.joinmastodon.org/entities/FilterStatus/
+https://docs.joinmastodon.org/entities/IdentityProof/
+https://docs.joinmastodon.org/entities/StatusSource/
+https://docs.joinmastodon.org/entities/Instance/
+https://docs.joinmastodon.org/entities/Suggestion/
+https://docs.joinmastodon.org/entities/Translation/
diff --git a/srcgen/return_values.json b/srcgen/return_values.json
@@ -6,7 +6,7 @@
         "func_call_real": "mastodon.account(23972)",
         "func_call_additional": "mastodon.account_verify_credentials()",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Account/",
         "func_alternate_acc": false,
         "manual_update": false,
         "fields": {
@@ -234,7 +234,7 @@
         "func_call": "mastodon.account_verify_credentials().role",
         "func_call_real": "mastodon.account_verify_credentials().role",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Role/",
         "func_call_additional": null,
         "func_alternate_acc": false,
         "manual_update": false,
@@ -338,7 +338,7 @@
         "func_call_real": "mastodon.status(110446223051565765)",
         "func_call_additional": "mastodon.status(110446183735368325)",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Status/",
         "func_alternate_acc": false,
         "manual_update": false,
         "fields": {
@@ -561,7 +561,7 @@
         "func_call_real": "mastodon.status_history(110446223051565765)[-1]",
         "func_call_additional": "mastodon.status_history(110446183735368325)[-1]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/StatusEdit/",
         "func_alternate_acc": false,
         "manual_update": false,
         "fields": {
@@ -629,7 +629,7 @@
         "func_call": "mastodon.status(<status id>).filtered[0]",
         "func_call_real": "mastodon.status(110447998920481458).filtered[0]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/FilterResult/",
         "func_call_additional": null,
         "func_alternate_acc": false,
         "manual_update": false,
@@ -704,7 +704,7 @@
         "func_call": "mastodon.status_post(\"futureposting\", scheduled_at=the_future)",
         "func_call_real": "mastodon.status_post(\"posting in the far future\", scheduled_at=datetime(9999,12,12))",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/ScheduledStatus/",
         "func_call_additional": null,
         "func_alternate_acc": false,
         "manual_update": false,
@@ -849,7 +849,7 @@
         "func_call": "mastodon.poll(<poll id>)",
         "func_call_real": "mastodon.status(110446383900387196).poll",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Poll/",
         "func_call_additional": null,
         "func_alternate_acc": false,
         "manual_update": false,
@@ -958,7 +958,7 @@
         "python_name": "Conversation",
         "func_call": "mastodon.conversations()[0]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Conversation/",
         "func_call_real": null,
         "func_call_additional": null,
         "func_alternate_acc": false,
@@ -999,7 +999,7 @@
         "python_name": "Hashtag",
         "func_call": "mastodon.trending_tags()[0]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Tag/",
         "func_call_real": null,
         "func_call_additional": null,
         "func_alternate_acc": false,
@@ -1075,7 +1075,7 @@
         "func_call": "mastodon.toot(\":sidekiqin:\").emojis[0]",
         "func_call_real": "mastodon.status(110446223051565765).emojis[0]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/CustomEmoji/",
         "func_call_additional": null,
         "func_alternate_acc": false,
         "manual_update": false,
@@ -1122,7 +1122,7 @@
         "python_name": "Application",
         "func_call": "mastodon.app_verify_credentials()",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Application/",
         "func_call_real": null,
         "func_call_additional": null,
         "func_alternate_acc": false,
@@ -1157,7 +1157,7 @@
         "func_call": "mastodon.account_relationships(<account id>)[0]",
         "func_call_real": "mastodon.account_relationships(23972)[0]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Relationship/",
         "func_call_additional": null,
         "func_alternate_acc": false,
         "manual_update": false,
@@ -1274,7 +1274,7 @@
         "python_name": "Filter",
         "func_call": "mastodon.filters()[0]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/V1_Filter/",
         "func_call_real": null,
         "func_call_additional": null,
         "func_alternate_acc": false,
@@ -1329,7 +1329,7 @@
         "python_name": "Notification",
         "func_call": "mastodon.notifications()[0]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Notification/",
         "func_call_real": null,
         "func_call_additional": null,
         "func_alternate_acc": false,
@@ -1378,7 +1378,7 @@
         "func_call": "mastodon.status_context(<status id>)",
         "func_call_real": "mastodon.status_context(110446983926957470)",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Context/",
         "func_call_additional": null,
         "func_alternate_acc": false,
         "manual_update": false,
@@ -1400,11 +1400,11 @@
         }
     },
     {
-        "name": "List",
+        "name": "User List",
         "python_name": "UserList",
         "func_call": "mastodon.lists()[0]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/List/",
         "func_call_real": null,
         "func_call_additional": null,
         "func_alternate_acc": false,
@@ -1440,7 +1440,7 @@
         "func_call_real": "mastodon.status(110447012773105565).media_attachments[0]",
         "func_call_additional": "mastodon.status(110447003454258227).media_attachments[0]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/MediaAttachment/",
         "func_alternate_acc": false,
         "manual_update": false,
         "fields": {
@@ -1740,7 +1740,7 @@
         "func_call_real": "mastodon.status_card(110447098625216345)",
         "python_name": "Card",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/PreviewCard/",
         "func_call_additional": null,
         "func_alternate_acc": false,
         "manual_update": false,
@@ -1858,7 +1858,7 @@
         "func_call": "mastodon.search(\"<search query>\")",
         "func_call_real": "mastodon.search(\"halcy\")",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Search/",
         "func_call_additional": null,
         "func_alternate_acc": false,
         "manual_update": false,
@@ -1891,7 +1891,7 @@
         "python_name": "Instance",
         "func_call": "mastodon.instance()",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/V1_Instance/",
         "func_call_real": null,
         "func_call_additional": null,
         "func_alternate_acc": false,
@@ -2077,7 +2077,7 @@
         "python_name": "InstanceRule",
         "func_call": "mastodon.instance().rules[0]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Rule/",
         "func_call_real": null,
         "func_call_additional": null,
         "func_alternate_acc": false,
@@ -2508,7 +2508,7 @@
         "func_call_real": "mastodon.admin_reports()[-1]",
         "func_call_additional": "mastodon.admin_reports(resolved=True)[-1]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Report/",
         "manual_update": false,
         "fields": {
             "id": {
@@ -2617,7 +2617,7 @@
         "func_call": "mastodon.push_subscription()",
         "func_call_real": "mastodon_soc.push_subscription_set(\"http://halcy.de/\",mastodon_soc.push_subscription_generate_keys()[1],follow_events=True)",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/WebPushSubscription/",
         "func_call_additional": null,
         "func_alternate_acc": false,
         "manual_update": false,
@@ -2767,7 +2767,7 @@
         "python_name": "Preferences",
         "func_call": "mastodon.preferences()",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Preferences/",
         "func_call_real": null,
         "func_call_additional": null,
         "func_alternate_acc": false,
@@ -2822,7 +2822,7 @@
         "python_name": "FeaturedHashtag",
         "func_call": "mastodon.featured_tags()[0]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/FeaturedTag/",
         "func_call_real": null,
         "func_call_additional": null,
         "func_alternate_acc": false,
@@ -2870,7 +2870,7 @@
         "python_name": "ReadMarker",
         "func_call": "mastodon.markers_get()[\"home\"]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Marker/",
         "func_call_real": null,
         "func_call_additional": null,
         "func_alternate_acc": false,
@@ -2905,7 +2905,7 @@
         "func_call": "mastodon.announcements()[0]",
         "func_alternate_acc": true,
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Announcement/",
         "func_call_real": null,
         "func_call_additional": null,
         "manual_update": false,
@@ -3009,7 +3009,7 @@
         "func_call": "mastodon.announcements()[0].reactions[0]",
         "func_alternate_acc": true,
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Reaction/",
         "func_call_real": null,
         "func_call_additional": null,
         "manual_update": false,
@@ -3058,7 +3058,7 @@
         "func_call": "mastodon.account_familiar_followers(<account id>)[0]",
         "func_call_real": "mastodon.account_familiar_followers(2)[0]",
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/FamiliarFollowers/",
         "func_call_additional": null,
         "manual_update": false,
         "fields": {
@@ -3085,7 +3085,7 @@
         "func_call_real": "mastodon.admin_account(1)",
         "func_alternate_acc": true,
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Account/",
         "func_call_additional": null,
         "manual_update": false,
         "fields": {
@@ -3224,7 +3224,7 @@
         "func_call_real": "mastodon.admin_account(1).ips[0]",
         "func_alternate_acc": true,
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Ip/",
         "func_call_additional": null,
         "manual_update": false,
         "fields": {
@@ -3250,7 +3250,7 @@
         "func_call": "mastodon.admin_measures(datetime.now() - timedelta(hours=24*5), datetime.now(), interactions=True)[0]",
         "func_alternate_acc": true,
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Measure/",
         "func_call_real": null,
         "func_call_additional": null,
         "manual_update": false,
@@ -3332,7 +3332,7 @@
         "func_call": "mastodon.admin_dimensions(datetime.now() - timedelta(hours=24*5), datetime.now(), languages=True)[0]",
         "func_alternate_acc": true,
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Dimension/",
         "func_call_real": null,
         "func_call_additional": null,
         "manual_update": false,
@@ -3427,7 +3427,7 @@
         "func_call": "mastodon.admin_retention(datetime.now() - timedelta(hours=24*5), datetime.now())[0].data[0]",
         "func_alternate_acc": true,
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_Cohort/",
         "func_call_real": null,
         "func_call_additional": null,
         "manual_update": false,
@@ -3461,7 +3461,7 @@
         "func_call": "mastodon_ico_admin.admin_domain_blocks()[0]",
         "func_alternate_acc": true,
         "last_changed": "TODO",
-        "masto_doc_link": "TODO",
+        "masto_doc_link": "https://docs.joinmastodon.org/entities/Admin_DomainBlock/",
         "func_call_real": null,
         "func_call_additional": null,
         "manual_update": false,