This repository has been archived by the owner on Sep 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
FediseerApiSwag.nswag
100 lines (100 loc) · 35.3 KB
/
FediseerApiSwag.nswag
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
{
"runtime": "Net70",
"defaultVariables": null,
"documentGenerator": {
"fromDocument": {
"json": "{\r\n \"swagger\": \"2.0\",\r\n \"basePath\": \"/api\",\r\n \"paths\": {\r\n \"/v1/approvals/{domain}\": {\r\n \"parameters\": [\r\n {\r\n \"name\": \"domain\",\r\n \"in\": \"path\",\r\n \"required\": true,\r\n \"type\": \"string\"\r\n }\r\n ],\r\n \"get\": {\r\n \"responses\": {\r\n \"404\": {\r\n \"description\": \"Instance not registered\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"200\": {\r\n \"description\": \"Instances\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/WhitelistedInstances\"\r\n }\r\n }\r\n },\r\n \"summary\": \"Display all endorsements given by a specific domain\",\r\n \"operationId\": \"get_approvals\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"csv\",\r\n \"in\": \"query\",\r\n \"type\": \"boolean\",\r\n \"description\": \"Set to true to return just the domains as a csv. Mutually exclusive with domains\"\r\n },\r\n {\r\n \"name\": \"domains\",\r\n \"in\": \"query\",\r\n \"type\": \"boolean\",\r\n \"description\": \"Set to true to return just the domains as a list. Mutually exclusive with csv\"\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n }\r\n },\r\n \"/v1/endorsements/{domain}\": {\r\n \"parameters\": [\r\n {\r\n \"name\": \"domain\",\r\n \"in\": \"path\",\r\n \"required\": true,\r\n \"type\": \"string\"\r\n }\r\n ],\r\n \"delete\": {\r\n \"responses\": {\r\n \"404\": {\r\n \"description\": \"Instance not registered\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"401\": {\r\n \"description\": \"Invalid API Key\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"400\": {\r\n \"description\": \"Bad Request\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"200\": {\r\n \"description\": \"Withdraw Instance Endorsement\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/SimpleResponse\"\r\n }\r\n }\r\n },\r\n \"summary\": \"Withdraw an instance endorsement\",\r\n \"operationId\": \"delete_endorsements\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"apikey\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"required\": true,\r\n \"description\": \"The sending instance's API key.\"\r\n },\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n },\r\n \"put\": {\r\n \"responses\": {\r\n \"404\": {\r\n \"description\": \"Instance not registered\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"403\": {\r\n \"description\": \"Not Guaranteed\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"401\": {\r\n \"description\": \"Invalid API Key\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"400\": {\r\n \"description\": \"Bad Request\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"200\": {\r\n \"description\": \"Endorse Instance\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/SimpleResponse\"\r\n }\r\n }\r\n },\r\n \"summary\": \"Endorse an instance\",\r\n \"description\": \"An endorsement signifies an approval from your instance to how that instance is being run.\",\r\n \"operationId\": \"put_endorsements\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"apikey\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"required\": true,\r\n \"description\": \"The sending instance's API key.\"\r\n },\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n },\r\n \"get\": {\r\n \"responses\": {\r\n \"404\": {\r\n \"description\": \"Instance not registered\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"200\": {\r\n \"description\": \"Instances\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/WhitelistedInstances\"\r\n }\r\n }\r\n },\r\n \"summary\": \"Display all endorsements received by a specific domain\",\r\n \"operationId\": \"get_endorsements\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"csv\",\r\n \"in\": \"query\",\r\n \"type\": \"boolean\",\r\n \"description\": \"Set to true to return just the domains as a csv. Mutually exclusive with domains\"\r\n },\r\n {\r\n \"name\": \"domains\",\r\n \"in\": \"query\",\r\n \"type\": \"boolean\",\r\n \"description\": \"Set to true to return just the domains as a list. Mutually exclusive with csv\"\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n }\r\n },\r\n \"/v1/guarantees/{domain}\": {\r\n \"parameters\": [\r\n {\r\n \"name\": \"domain\",\r\n \"in\": \"path\",\r\n \"required\": true,\r\n \"type\": \"string\"\r\n }\r\n ],\r\n \"delete\": {\r\n \"responses\": {\r\n \"404\": {\r\n \"description\": \"Instance not registered\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"401\": {\r\n \"description\": \"Invalid API Key\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"400\": {\r\n \"description\": \"Bad Request\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"200\": {\r\n \"description\": \"Withdraw Instance Guarantee\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/SimpleResponse\"\r\n }\r\n }\r\n },\r\n \"summary\": \"Withdraw an instance guarantee\",\r\n \"operationId\": \"delete_guarantees\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"apikey\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"required\": true,\r\n \"description\": \"The sending instance's API key.\"\r\n },\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n },\r\n \"put\": {\r\n \"responses\": {\r\n \"404\": {\r\n \"description\": \"Instance not registered\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"403\": {\r\n \"description\": \"Instance Not Guaranteed or Tartget instance Guaranteed by others\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"401\": {\r\n \"description\": \"Invalid API Key\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"400\": {\r\n \"description\": \"Bad Request\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"200\": {\r\n \"description\": \"Endorse Instance\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/SimpleResponse\"\r\n }\r\n }\r\n },\r\n \"summary\": \"Guarantee an instance\",\r\n \"description\": \"A instance can only be guaranteed by one other instance\\nAn instance can guarantee up to 20 other instances\\nA guaranteed instance can guarantee and endorse other instances.\",\r\n \"operationId\": \"put_guarantees\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"apikey\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"required\": true,\r\n \"description\": \"The sending instance's API key.\"\r\n },\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n },\r\n \"get\": {\r\n \"responses\": {\r\n \"404\": {\r\n \"description\": \"Instance not registered\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"200\": {\r\n \"description\": \"Instances\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/WhitelistedInstances\"\r\n }\r\n }\r\n },\r\n \"summary\": \"Display all instances guaranteeing for this domain\",\r\n \"operationId\": \"get_guarantees\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"csv\",\r\n \"in\": \"query\",\r\n \"type\": \"boolean\",\r\n \"description\": \"Set to true to return just the domains as a csv. Mutually exclusive with domains\"\r\n },\r\n {\r\n \"name\": \"domains\",\r\n \"in\": \"query\",\r\n \"type\": \"boolean\",\r\n \"description\": \"Set to true to return just the domains as a list. Mutually exclusive with csv\"\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n }\r\n },\r\n \"/v1/guarantors/{domain}\": {\r\n \"parameters\": [\r\n {\r\n \"name\": \"domain\",\r\n \"in\": \"path\",\r\n \"required\": true,\r\n \"type\": \"string\"\r\n }\r\n ],\r\n \"get\": {\r\n \"responses\": {\r\n \"404\": {\r\n \"description\": \"Instance not registered\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"200\": {\r\n \"description\": \"Instances\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/WhitelistedInstances\"\r\n }\r\n }\r\n },\r\n \"summary\": \"Display all guarantees given by a specific domain\",\r\n \"operationId\": \"get_guarantors\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"csv\",\r\n \"in\": \"query\",\r\n \"type\": \"boolean\",\r\n \"description\": \"Set to true to return just the domains as a csv. Mutually exclusive with domains\"\r\n },\r\n {\r\n \"name\": \"domains\",\r\n \"in\": \"query\",\r\n \"type\": \"boolean\",\r\n \"description\": \"Set to true to return just the domains as a list. Mutually exclusive with csv\"\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n }\r\n },\r\n \"/v1/inbox/{username}\": {\r\n \"parameters\": [\r\n {\r\n \"name\": \"username\",\r\n \"in\": \"path\",\r\n \"required\": true,\r\n \"type\": \"string\"\r\n }\r\n ],\r\n \"post\": {\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"Success\"\r\n }\r\n },\r\n \"summary\": \"User Inbox\",\r\n \"operationId\": \"post_inbox\",\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n }\r\n },\r\n \"/v1/instances\": {\r\n \"get\": {\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"Suspicious Instances\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/SuspiciousInstances\"\r\n }\r\n }\r\n },\r\n \"summary\": \"A List with the details of all suspicious instances\",\r\n \"operationId\": \"get_suspicions\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"activity_suspicion\",\r\n \"in\": \"query\",\r\n \"type\": \"integer\",\r\n \"description\": \"How many users per local post+comment to consider suspicious\",\r\n \"default\": 20\r\n },\r\n {\r\n \"name\": \"csv\",\r\n \"in\": \"query\",\r\n \"type\": \"boolean\",\r\n \"description\": \"Set to true to return just the domains as a csv. Mutually exclusive with domains\"\r\n },\r\n {\r\n \"name\": \"domains\",\r\n \"in\": \"query\",\r\n \"type\": \"boolean\",\r\n \"description\": \"Set to true to return just the domains as a list. Mutually exclusive with csv\"\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n }\r\n },\r\n \"/v1/user/{username}\": {\r\n \"parameters\": [\r\n {\r\n \"name\": \"username\",\r\n \"in\": \"path\",\r\n \"required\": true,\r\n \"type\": \"string\"\r\n }\r\n ],\r\n \"get\": {\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"Success\"\r\n }\r\n },\r\n \"summary\": \"User details\",\r\n \"operationId\": \"get_user\",\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n }\r\n },\r\n \"/v1/whitelist\": {\r\n \"get\": {\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"Instances\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/WhitelistedInstances\"\r\n }\r\n }\r\n },\r\n \"summary\": \"A List with the details of all instances and their endorsements\",\r\n \"operationId\": \"get_whitelist\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"endorsements\",\r\n \"in\": \"query\",\r\n \"type\": \"integer\",\r\n \"description\": \"Limit to this amount of endorsements of more\",\r\n \"default\": 0\r\n },\r\n {\r\n \"name\": \"guarantors\",\r\n \"in\": \"query\",\r\n \"type\": \"integer\",\r\n \"description\": \"Limit to this amount of guarantors of more\",\r\n \"default\": 1\r\n },\r\n {\r\n \"name\": \"csv\",\r\n \"in\": \"query\",\r\n \"type\": \"boolean\",\r\n \"description\": \"Set to true to return just the domains as a csv. Mutually exclusive with domains\"\r\n },\r\n {\r\n \"name\": \"domains\",\r\n \"in\": \"query\",\r\n \"type\": \"boolean\",\r\n \"description\": \"Set to true to return just the domains as a list. Mutually exclusive with csv\"\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n }\r\n },\r\n \"/v1/whitelist/{domain}\": {\r\n \"parameters\": [\r\n {\r\n \"name\": \"domain\",\r\n \"in\": \"path\",\r\n \"required\": true,\r\n \"type\": \"string\"\r\n }\r\n ],\r\n \"patch\": {\r\n \"responses\": {\r\n \"403\": {\r\n \"description\": \"Instance Not Registered\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"401\": {\r\n \"description\": \"Invalid API Key\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"200\": {\r\n \"description\": \"Instances\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/SimpleResponse\"\r\n }\r\n }\r\n },\r\n \"summary\": \"Regenerate API key for instance\",\r\n \"operationId\": \"patch_whitelist_domain\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"apikey\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"required\": true,\r\n \"description\": \"The sending instance's API key.\"\r\n },\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"payload\",\r\n \"required\": true,\r\n \"in\": \"body\",\r\n \"schema\": {\r\n \"type\": \"object\",\r\n \"properties\": {\r\n \"regenerate_key\": {\r\n \"type\": \"string\"\r\n }\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n },\r\n \"get\": {\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"Instances\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/InstanceDetails\"\r\n }\r\n }\r\n },\r\n \"summary\": \"Display info about a specific instance\",\r\n \"operationId\": \"get_whitelist_domain\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n },\r\n \"put\": {\r\n \"responses\": {\r\n \"400\": {\r\n \"description\": \"Bad Request\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"200\": {\r\n \"description\": \"Instances\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/InstanceDetails\"\r\n }\r\n }\r\n },\r\n \"summary\": \"Claim an fediverse instance\",\r\n \"description\": \"If the instance hasn't been recorded yet it will be polled and added.\\nYou must specify an admin account which will recieve the new API key via Private Message.\",\r\n \"operationId\": \"put_whitelist_domain\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"payload\",\r\n \"required\": true,\r\n \"in\": \"body\",\r\n \"schema\": {\r\n \"type\": \"object\",\r\n \"properties\": {\r\n \"admin\": {\r\n \"type\": \"string\"\r\n },\r\n \"guarantor\": {\r\n \"type\": \"string\"\r\n }\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n },\r\n \"delete\": {\r\n \"responses\": {\r\n \"403\": {\r\n \"description\": \"Forbidden\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"401\": {\r\n \"description\": \"Invalid API Key\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"400\": {\r\n \"description\": \"Bad Request\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/RequestError\"\r\n }\r\n },\r\n \"200\": {\r\n \"description\": \"Instances\",\r\n \"schema\": {\r\n \"$ref\": \"#/definitions/SimpleResponse\"\r\n }\r\n }\r\n },\r\n \"summary\": \"Delete claim to instance (Not implemented)\",\r\n \"operationId\": \"delete_whitelist_domain\",\r\n \"parameters\": [\r\n {\r\n \"name\": \"apikey\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"required\": true,\r\n \"description\": \"The sending instance's API key.\"\r\n },\r\n {\r\n \"name\": \"Client-Agent\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"description\": \"The client name and version.\",\r\n \"default\": \"unknown:0:unknown\"\r\n },\r\n {\r\n \"name\": \"payload\",\r\n \"required\": true,\r\n \"in\": \"body\",\r\n \"schema\": {\r\n \"type\": \"object\",\r\n \"properties\": {\r\n \"username\": {\r\n \"type\": \"string\"\r\n }\r\n }\r\n }\r\n },\r\n {\r\n \"name\": \"X-Fields\",\r\n \"in\": \"header\",\r\n \"type\": \"string\",\r\n \"format\": \"mask\",\r\n \"description\": \"An optional fields mask\"\r\n }\r\n ],\r\n \"tags\": [\r\n \"v1\"\r\n ]\r\n }\r\n }\r\n },\r\n \"info\": {\r\n \"title\": \"Fediseer\",\r\n \"version\": \"1.0\",\r\n \"description\": \"The API documentation for the Fediseer\"\r\n },\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"consumes\": [\r\n \"application/json\"\r\n ],\r\n \"tags\": [\r\n {\r\n \"name\": \"v1\",\r\n \"description\": \"API Version 1\"\r\n }\r\n ],\r\n \"definitions\": {\r\n \"SuspiciousInstances\": {\r\n \"properties\": {\r\n \"instances\": {\r\n \"type\": \"array\",\r\n \"items\": {\r\n \"$ref\": \"#/definitions/SuspiciousInstances\"\r\n }\r\n },\r\n \"domains\": {\r\n \"type\": \"array\",\r\n \"items\": {\r\n \"type\": \"string\",\r\n \"description\": \"The suspicious domains as a list.\"\r\n }\r\n },\r\n \"csv\": {\r\n \"type\": \"string\",\r\n \"description\": \"The suspicious domains as a csv.\"\r\n }\r\n },\r\n \"type\": \"object\"\r\n },\r\n \"WhitelistedInstances\": {\r\n \"properties\": {\r\n \"instances\": {\r\n \"type\": \"array\",\r\n \"items\": {\r\n \"$ref\": \"#/definitions/InstanceDetails\"\r\n }\r\n },\r\n \"domains\": {\r\n \"type\": \"array\",\r\n \"items\": {\r\n \"type\": \"string\",\r\n \"description\": \"The instance domains as a list.\"\r\n }\r\n },\r\n \"csv\": {\r\n \"type\": \"string\",\r\n \"description\": \"The instance domains as a csv.\"\r\n }\r\n },\r\n \"type\": \"object\"\r\n },\r\n \"InstanceDetails\": {\r\n \"properties\": {\r\n \"id\": {\r\n \"type\": \"integer\",\r\n \"description\": \"The instance id\",\r\n \"example\": 1\r\n },\r\n \"domain\": {\r\n \"type\": \"string\",\r\n \"description\": \"The instance domain\",\r\n \"example\": \"lemmy.dbzer0.com\"\r\n },\r\n \"software\": {\r\n \"type\": \"string\",\r\n \"description\": \"The fediverse software running in this instance\",\r\n \"example\": \"lemmy\"\r\n },\r\n \"open_registrations\": {\r\n \"type\": \"boolean\",\r\n \"description\": \"The instance uptime pct. 100% and thousand of users is unlikely\"\r\n },\r\n \"email_verify\": {\r\n \"type\": \"boolean\",\r\n \"description\": \"The amount of local posts in that instance\"\r\n },\r\n \"approvals\": {\r\n \"type\": \"integer\",\r\n \"description\": \"The amount of endorsements this instance has given out\"\r\n },\r\n \"endorsements\": {\r\n \"type\": \"integer\",\r\n \"description\": \"The amount of endorsements this instance has received\"\r\n },\r\n \"guarantor\": {\r\n \"type\": \"string\",\r\n \"description\": \"The domain of the instance which guaranteed this instance.\",\r\n \"example\": \"fediseer.com\"\r\n }\r\n },\r\n \"type\": \"object\"\r\n },\r\n \"RequestError\": {\r\n \"properties\": {\r\n \"message\": {\r\n \"type\": \"string\",\r\n \"description\": \"The error message for this status code.\"\r\n }\r\n },\r\n \"type\": \"object\"\r\n },\r\n \"SimpleResponse\": {\r\n \"required\": [\r\n \"message\"\r\n ],\r\n \"properties\": {\r\n \"message\": {\r\n \"type\": \"string\",\r\n \"description\": \"The result of this operation.\",\r\n \"default\": \"OK\"\r\n }\r\n },\r\n \"type\": \"object\"\r\n }\r\n },\r\n \"responses\": {\r\n \"ParseError\": {\r\n \"description\": \"When a mask can't be parsed\"\r\n },\r\n \"MaskError\": {\r\n \"description\": \"When any error occurs on mask\"\r\n }\r\n }\r\n}",
"url": "https://fediseer.com/api/swagger.json",
"output": null,
"newLineBehavior": "Auto"
}
},
"codeGenerators": {
"openApiToCSharpClient": {
"clientBaseClass": null,
"configurationClass": null,
"generateClientClasses": true,
"generateClientInterfaces": false,
"clientBaseInterface": null,
"injectHttpClient": true,
"disposeHttpClient": true,
"protectedMethods": [],
"generateExceptionClasses": true,
"exceptionClass": "ApiException",
"wrapDtoExceptions": true,
"useHttpClientCreationMethod": false,
"httpClientType": "HttpClient",
"useHttpRequestMessageCreationMethod": false,
"useBaseUrl": true,
"generateBaseUrlProperty": true,
"generateSyncMethods": false,
"generatePrepareRequestAndProcessResponseAsAsyncMethods": false,
"exposeJsonSerializerSettings": false,
"clientClassAccessModifier": "public",
"typeAccessModifier": "public",
"generateContractsOutput": false,
"contractsNamespace": null,
"contractsOutputFilePath": null,
"parameterDateTimeFormat": "s",
"parameterDateFormat": "yyyy-MM-dd",
"generateUpdateJsonSerializerSettingsMethod": true,
"useRequestAndResponseSerializationSettings": false,
"serializeTypeInformation": false,
"queryNullValue": "",
"className": "FediseerClient",
"operationGenerationMode": "SingleClientFromOperationId",
"additionalNamespaceUsages": [],
"additionalContractNamespaceUsages": [],
"generateOptionalParameters": false,
"generateJsonMethods": false,
"enforceFlagEnums": false,
"parameterArrayType": "System.Collections.Generic.IEnumerable",
"parameterDictionaryType": "System.Collections.Generic.IDictionary",
"responseArrayType": "System.Collections.Generic.ICollection",
"responseDictionaryType": "System.Collections.Generic.IDictionary",
"wrapResponses": true,
"wrapResponseMethods": [],
"generateResponseClasses": true,
"responseClass": "SwaggerResponse",
"namespace": "Fediseer",
"requiredPropertiesMustBeDefined": true,
"dateType": "System.DateTimeOffset",
"jsonConverters": null,
"anyType": "object",
"dateTimeType": "System.DateTimeOffset",
"timeType": "System.TimeSpan",
"timeSpanType": "System.TimeSpan",
"arrayType": "System.Collections.Generic.ICollection",
"arrayInstanceType": "System.Collections.ObjectModel.Collection",
"dictionaryType": "System.Collections.Generic.IDictionary",
"dictionaryInstanceType": "System.Collections.Generic.Dictionary",
"arrayBaseType": "System.Collections.ObjectModel.Collection",
"dictionaryBaseType": "System.Collections.Generic.Dictionary",
"classStyle": "Poco",
"jsonLibrary": "NewtonsoftJson",
"generateDefaultValues": true,
"generateDataAnnotations": true,
"excludedTypeNames": [],
"excludedParameterNames": [],
"handleReferences": false,
"generateImmutableArrayProperties": false,
"generateImmutableDictionaryProperties": false,
"jsonSerializerSettingsTransformationMethod": null,
"inlineNamedArrays": false,
"inlineNamedDictionaries": false,
"inlineNamedTuples": true,
"inlineNamedAny": false,
"generateDtoTypes": true,
"generateOptionalPropertiesAsNullable": false,
"generateNullableReferenceTypes": false,
"templateDirectory": null,
"typeNameGeneratorType": null,
"propertyNameGeneratorType": null,
"enumNameGeneratorType": null,
"serviceHost": null,
"serviceSchemes": null,
"output": null,
"newLineBehavior": "Auto"
}
}
}