Skip to content

Instantly share code, notes, and snippets.

@truelecter
Last active September 10, 2017 14:50
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save truelecter/7cef73113d34d5a3a5d0f6d63f56f02b to your computer and use it in GitHub Desktop.
Save truelecter/7cef73113d34d5a3a5d0f6d63f56f02b to your computer and use it in GitHub Desktop.
Swagger test configuration
{"swagger":"2.0","info":{"version":"v1","title":"Discord Emoji Collector api"},"host":"localhost:9000","schemes":["https"],"paths":{"/api/Emojis":{"get":{"tags":["Emojis"],"summary":"Get known emojis list","operationId":"Emojis_GetEmojis","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"page","in":"query","required":false,"type":"integer","format":"int32","default":1},{"name":"limit","in":"query","required":false,"type":"integer","format":"int32","default":100}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.EmojisController.ListedEmojiDto"}},"examples":[{"id":314489295014723585,"name":"nb3Meh","managed":false,"public":false,"serverId":293374085407178753},{"id":323497592348394388,"name":"idkidk","managed":true,"public":false,"serverId":198402934589340595},{"id":334825482820255765,"name":":GabrielThink:","managed":true,"public":true,"serverId":194170124859736065}]}}}},"/api/Emojis/{id}":{"get":{"tags":["Emojis"],"summary":"Get emoji by id","operationId":"Emojis_GetEmoji","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Emoji id","required":true,"type":"integer","format":"int64"}],"responses":{"404":{"description":"Emojis id is not present in registry"},"200":{"description":"OK","schema":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.EmojisController.SingleEmojiDto"},"examples":{"id":334825482820255765,"name":"GabrielThink","managed":true,"roles":"","requireColons":true,"server":{"id":194170124859736065,"name":"China Town","invites":[{"code":"t4etzqs","status":0}]}}}}}},"/api/invites/{code}":{"get":{"tags":["Invites"],"summary":"Get invite by code","operationId":"Invites_GetInvite","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"code","in":"path","description":"Server invite code","required":true,"type":"string"}],"responses":{"404":{"description":"Current code not present is invites registry"},"200":{"description":"OK","schema":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.InvitesController.InviteDto"},"examples":{"code":"t4etzqs","status":0,"server":{"id":296167427652321302,"name":"China Town","status":0,"emojis":[{"id":334825482820255765,"name":":GabrielThink:","managed":true,"public":true},{"id":334825476461953025,"name":":Yamero:","managed":true,"public":true}]}}}}},"post":{"tags":["Invites"],"summary":"Add invite to parse queue","operationId":"Invites_PostInvite","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"code","in":"path","description":"Server invite code.","required":true,"type":"string"}],"responses":{"400":{"description":"code is not Discord invite code"},"201":{"description":"Invite added to queue","schema":{"type":"object"}}}}},"/api/Invites":{"get":{"tags":["Invites"],"summary":"Gets known invites list","operationId":"Invites_GetInvites","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"page","in":"query","required":false,"type":"integer","format":"int32","default":1},{"name":"limit","in":"query","required":false,"type":"integer","format":"int32","default":50}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.InvitesController.InviteListEntryDto"}},"examples":[{"code":"t4etzqs","status":0,"serverId":296167427652321302}]}}}},"/api/Servers":{"get":{"tags":["Servers"],"summary":"Get known servers list","operationId":"Servers_GetServers","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"page","in":"query","required":false,"type":"integer","format":"int32","default":1},{"name":"limit","in":"query","required":false,"type":"integer","format":"int32","default":10}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.ServersController.ServerListEntryDto"}},"examples":[{"id":296167427652321302,"name":"China Town","status":0,"lastUpdate":"2017-09-10T17:49:53.6419575+03:00","invites":[{"code":"t4etzqs","status":0}],"emojis":[{"id":334825482820255765,"name":":GabrielThink:","managed":true,"public":true},{"id":334825476461953025,"name":":Yamero:","managed":true,"public":true}]}]}}}},"/api/Servers/{id}":{"get":{"tags":["Servers"],"summary":"Get server by id","operationId":"Servers_GetServer","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"404":{"description":"Server id is not present in registry"},"200":{"description":"OK","schema":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.ServersController.SingleServerDto"},"examples":{"id":296167427652321302,"name":"China Town","status":0,"lastUpdate":"2017-09-10T17:49:53.6654732+03:00","invites":[{"code":"t4etzqs","status":0}],"emojis":[{"id":334825482820255765,"name":"GabrielThink","managed":true,"roles":"","requireColons":true},{"id":334825476461953025,"name":"Yamero","managed":true,"roles":"","requireColons":true}]}}}}}},"definitions":{"DiscordEmojiCollector.SelfHost.Controllers.EmojisController.ListedEmojiDto":{"title":"Partial emoji","type":"object","properties":{"id":{"format":"int64","description":"Discord emoji id","type":"integer"},"name":{"description":"Emoji name","type":"string"},"managed":{"description":"True if emoji can be used on other servers","type":"boolean"},"public":{"description":"Can be emoji used right after user joined server\r\nThis is true when managed = true and there are no role restrictions for this emoji","type":"boolean"},"serverId":{"format":"int64","description":"Discord server id","type":"integer"}}},"DiscordEmojiCollector.SelfHost.Controllers.EmojisController.SingleEmojiDto":{"title":"Emoji","type":"object","properties":{"id":{"format":"int64","description":"Discord emoji id","type":"integer"},"name":{"description":"Emoji name","type":"string"},"managed":{"description":"True if emoji can be used on other servers","type":"boolean"},"roles":{"description":"Roles this emoji enabled for. It is array of ulong (int64) values separated by |","type":"string"},"requireColons":{"description":"True if colons are required to use this emoji in text.\r\nNote: Name will never contain colons.\r\nNote 2: Partial emoji name contains colons if they are required","type":"boolean"},"server":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.EmojisController.ServerDto","description":"Summary about server this emoji from"}}},"DiscordEmojiCollector.SelfHost.Controllers.EmojisController.ServerDto":{"title":"Partial server","type":"object","properties":{"id":{"format":"int64","description":"Discord server id","type":"integer"},"name":{"description":"Server name","type":"string"},"invites":{"description":"List of known invites for this server","type":"array","items":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.EmojisController.InviteDto"}}}},"DiscordEmojiCollector.SelfHost.Controllers.EmojisController.InviteDto":{"title":"Invite","type":"object","properties":{"code":{"description":"Invite code","type":"string"},"status":{"format":"int32","description":"Invite status. 0 if valid. 3 if awaits check","type":"integer"}}},"DiscordEmojiCollector.SelfHost.Controllers.InvitesController.InviteDto":{"title":"Invite","type":"object","properties":{"code":{"description":"Invite code","type":"string"},"status":{"format":"int32","description":"Invite status. 0 if valid. 3 if awaits check","type":"integer"},"server":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.InvitesController.ServerDto","description":"Server, this invite belongs to"}}},"DiscordEmojiCollector.SelfHost.Controllers.InvitesController.ServerDto":{"title":"Partial server","type":"object","properties":{"id":{"format":"int64","description":"Discord server id","type":"integer"},"name":{"description":"Server name","type":"string"},"status":{"format":"int32","description":"Server check status. 0 if successfully checked","type":"integer"},"emojis":{"description":"List of known emojsi for this server","type":"array","items":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.InvitesController.ServerListEmojiEntryDto"}}}},"DiscordEmojiCollector.SelfHost.Controllers.InvitesController.ServerListEmojiEntryDto":{"title":"Partial emoji","type":"object","properties":{"id":{"format":"int64","description":"Discord emoji id","type":"integer"},"name":{"description":"Emoji name","type":"string"},"managed":{"description":"Can emoji be used on other servers","type":"boolean"},"public":{"description":"Can be emoji used right after user joined server\r\nThis is true when managed = true and there are no role restrictions for this emoji","type":"boolean"}}},"DiscordEmojiCollector.SelfHost.Controllers.InvitesController.InviteListEntryDto":{"title":"Partial invite","type":"object","properties":{"code":{"description":"Invite code","type":"string"},"status":{"format":"int32","description":"Invite status. 0 if valid. 3 if awaits check","type":"integer"},"serverId":{"format":"int64","description":"Discord server id this invite from","type":"integer"}}},"DiscordEmojiCollector.SelfHost.Controllers.ServersController.ServerListEntryDto":{"title":"Partial server","type":"object","properties":{"id":{"format":"int64","description":"Discord server id","type":"integer"},"name":{"description":"Server name","type":"string"},"status":{"format":"int32","description":"Server check status. 0 if successfully checked","type":"integer"},"lastUpdate":{"format":"date-time","description":"Last time this server has been checked","type":"string"},"invites":{"description":"List of known invites for this server","type":"array","items":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.ServersController.InviteDto"}},"emojis":{"description":"List of known emojsi for this server","type":"array","items":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.ServersController.ServerListEmojiEntryDto"}}}},"DiscordEmojiCollector.SelfHost.Controllers.ServersController.InviteDto":{"title":"Invite","type":"object","properties":{"code":{"description":"Invite code","type":"string"},"status":{"format":"int32","description":"Invite status. 0 if valid. 3 if awaits check","type":"integer"}}},"DiscordEmojiCollector.SelfHost.Controllers.ServersController.ServerListEmojiEntryDto":{"title":"Partial emoji","type":"object","properties":{"id":{"format":"int64","description":"Discord emoji id","type":"integer"},"name":{"description":"Emoji name","type":"string"},"managed":{"description":"Can emoji be used on other servers","type":"boolean"},"public":{"description":"Can be emoji used right after user joined server\r\nThis is true when managed = true and there are no role restrictions for this emoji","type":"boolean"}}},"DiscordEmojiCollector.SelfHost.Controllers.ServersController.SingleServerDto":{"title":"Server","type":"object","properties":{"id":{"format":"int64","description":"Discord server id","type":"integer"},"name":{"description":"Server name","type":"string"},"status":{"format":"int32","description":"Server check status. 0 if successfully checked","type":"integer"},"icon":{"description":"Server icon hash. May be null","type":"string"},"lastUpdate":{"format":"date-time","description":"Last time this server has been checked","type":"string"},"invites":{"description":"List of known invites for this server","type":"array","items":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.ServersController.InviteDto"}},"emojis":{"description":"List of known emojsi for this server","type":"array","items":{"$ref":"#/definitions/DiscordEmojiCollector.SelfHost.Controllers.ServersController.EmojiDto"}}}},"DiscordEmojiCollector.SelfHost.Controllers.ServersController.EmojiDto":{"title":"Emoji","type":"object","properties":{"id":{"format":"int64","description":"Discord emoji id","type":"integer"},"name":{"description":"Emoji name","type":"string"},"managed":{"description":"Can emoji be used on other servers","type":"boolean"},"roles":{"description":"Roles this emoji enabled for. It is array of ulong (int64) values separated by |","type":"string"},"requireColons":{"description":"True if colons are required to use this emoji in text.\r\nNote: Name will never contain colons.\r\nNote 2: Partial emoji name contains colons if they are required","type":"boolean"}}}}}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment