v0.yaml (4921B)
1 openapi: 3.0.2 2 info: 3 title: Server_Stats API 4 version: 0.1.0 5 contact: 6 name: MTRNord 7 url: 'https://serverstats.nordgedanken.dev/faq' 8 email: mtrnord@nordgedanken.dev 9 license: 10 name: GNU AGPLv3 11 url: 'https://www.gnu.org/licenses/agpl.txt' 12 servers: 13 - url: 'https://serverstats.nordgedanken.dev/' 14 description: '' 15 paths: 16 /relations: 17 summary: Room Relations 18 get: 19 responses: 20 '200': 21 $ref: '#/components/responses/RelationsResponse' 22 deprecated: false 23 summary: Get the room relations 24 /servers: 25 get: 26 parameters: 27 - examples: 28 include_members: 29 value: 'false' 30 name: include_members 31 description: Defined if you want the servers of members included as well. 32 schema: 33 type: boolean 34 in: query 35 required: false 36 responses: 37 '200': 38 $ref: '#/components/responses/ServersResponse' 39 deprecated: false 40 components: 41 schemas: 42 Relations: 43 title: Root Type for Relations 44 description: '' 45 type: object 46 properties: 47 nodes: 48 type: array 49 items: 50 type: object 51 properties: 52 id: 53 type: string 54 room_id: 55 type: string 56 name: 57 type: string 58 alias: 59 type: string 60 avatar: 61 type: string 62 members: 63 format: int32 64 type: integer 65 topic: 66 type: string 67 weight: 68 format: int32 69 type: integer 70 incoming_links: 71 format: int32 72 type: integer 73 outgoing_links: 74 format: int32 75 type: integer 76 is_space: 77 type: boolean 78 links: 79 type: array 80 items: 81 type: object 82 properties: 83 source: 84 type: string 85 target: 86 type: string 87 value: 88 format: int32 89 type: integer 90 example: 91 nodes: 92 - id: zzNhtqtTKvKoKmplCDE8GQ== 93 room_id: '!room:server' 94 name: Example Room 95 alias: '#example:server' 96 avatar: 'mxc://server/media' 97 members: 231 98 topic: An example topic 99 weight: 2 100 incoming_links: 1 101 outgoing_links: 1 102 is_space: false 103 - id: zxCnSRqXsaRrLP4HuVLtXw== 104 room_id: '!room2:server' 105 name: Example Room2 106 alias: '#example2:server' 107 avatar: 'mxc://server/media2' 108 members: 231 109 topic: An example topic 110 weight: 2 111 incoming_links: 1 112 outgoing_links: 1 113 is_space: false 114 links: 115 - source: zzNhtqtTKvKoKmplCDE8GQ== 116 target: zxCnSRqXsaRrLP4HuVLtXw== 117 value: 1 118 Servers: 119 title: Root Type for Servers 120 description: '' 121 type: object 122 properties: 123 servers: 124 type: array 125 items: 126 type: string 127 example: 128 servers: 129 - example.com 130 - anotherexample.com 131 responses: 132 RelationsResponse: 133 content: 134 application/json: 135 schema: 136 $ref: '#/components/schemas/Relations' 137 examples: 138 Relations example: 139 value: 140 nodes: 141 - id: zzNhtqtTKvKoKmplCDE8GQ== 142 room_id: '!room:server' 143 name: Example Room 144 alias: '#example:server' 145 avatar: 'mxc://server/media' 146 members: 231 147 topic: An example topic 148 weight: 2 149 incoming_links: 1 150 outgoing_links: 1 151 is_space: false 152 - id: zxCnSRqXsaRrLP4HuVLtXw== 153 room_id: '!room2:server' 154 name: Example Room2 155 alias: '#example2:server' 156 avatar: 'mxc://server/media2' 157 members: 231 158 topic: An example topic 159 weight: 2 160 incoming_links: 1 161 outgoing_links: 1 162 is_space: false 163 links: 164 - source: zzNhtqtTKvKoKmplCDE8GQ== 165 target: zxCnSRqXsaRrLP4HuVLtXw== 166 value: 1 167 description: '' 168 ServersResponse: 169 content: 170 application/json: 171 examples: 172 ServersExample: 173 value: 174 servers: 175 - example.com 176 - anotherexample.com 177 description: ''