scripts/src/lib/twhelp/openapi3.json

2 lines
44 KiB
JSON
Raw Normal View History

2024-04-01 07:45:33 +00:00
{"components":{"parameters":{"BeforeQueryParam":{"description":"only items created before the provided time are returned, this is a timestamp in RFC 3339 format","in":"query","name":"before","schema":{"format":"date-time","type":"string"}},"CursorQueryParam":{"in":"query","name":"cursor","schema":{"$ref":"#/components/schemas/CursorString"}},"EnnoblementSortQueryParam":{"description":"Order matters!","in":"query","name":"sort","schema":{"default":["createdAt:ASC"],"items":{"enum":["createdAt:ASC","createdAt:DESC"],"maxItems":1,"type":"string"},"type":"array"}},"LimitQueryParam":{"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":1,"type":"integer"}},"PlayerDeletedQueryParam":{"description":"true=only deleted players, false=only existing players, by default both existing and deleted players are returned","in":"query","name":"deleted","schema":{"type":"boolean"}},"PlayerIdPathParam":{"in":"path","name":"playerId","required":true,"schema":{"$ref":"#/components/schemas/IntId"}},"PlayerIdQueryParam":{"in":"query","name":"id","schema":{"items":{"$ref":"#/components/schemas/IntId"},"type":"array"}},"PlayerNameQueryParam":{"in":"query","name":"name","schema":{"items":{"maxLength":150,"minLength":1,"type":"string"},"maxItems":100,"type":"array"}},"PlayerSnapshotSortQueryParam":{"description":"Order matters!","in":"query","name":"sort","schema":{"default":["date:ASC"],"items":{"enum":["date:ASC","date:DESC"],"maxItems":1,"type":"string"},"type":"array"}},"PlayerSortQueryParam":{"description":"Order matters!","in":"query","name":"sort","schema":{"items":{"enum":["odScoreAtt:ASC","odScoreAtt:DESC","odScoreDef:ASC","odScoreDef:DESC","odScoreSup:ASC","odScoreSup:DESC","odScoreTotal:ASC","odScoreTotal:DESC","points:ASC","points:DESC","deletedAt:ASC","deletedAt:DESC"],"maxItems":2,"type":"string"},"type":"array"}},"ServerKeyPathParam":{"in":"path","name":"serverKey","required":true,"schema":{"$ref":"#/components/schemas/ServerKey"}},"ServerOpenQueryParam":{"description":"true=only open servers, false=only closed servers, by default both open and closed servers are returned","in":"query","name":"open","schema":{"type":"boolean"}},"SinceQueryParam":{"description":"only items created since the provided time are returned, this is a timestamp in RFC 3339 format","in":"query","name":"since","schema":{"format":"date-time","type":"string"}},"TribeChangeSortQueryParam":{"description":"Order matters!","in":"query","name":"sort","schema":{"default":["createdAt:ASC"],"items":{"enum":["createdAt:ASC","createdAt:DESC"],"maxItems":1,"type":"string"},"type":"array"}},"TribeDeletedQueryParam":{"description":"true=only deleted tribes, false=only existing tribes, by default both existing and deleted tribes are returned","in":"query","name":"deleted","schema":{"type":"boolean"}},"TribeIdPathParam":{"in":"path","name":"tribeId","required":true,"schema":{"$ref":"#/components/schemas/IntId"}},"TribeSnapshotSortQueryParam":{"description":"Order matters!","in":"query","name":"sort","schema":{"default":["date:ASC"],"items":{"enum":["date:ASC","date:DESC"],"maxItems":1,"type":"string"},"type":"array"}},"TribeSortQueryParam":{"description":"Order matters!","in":"query","name":"sort","schema":{"items":{"enum":["odScoreAtt:ASC","odScoreAtt:DESC","odScoreDef:ASC","odScoreDef:DESC","odScoreTotal:ASC","odScoreTotal:DESC","points:ASC","points:DESC","dominance:ASC","dominance:DESC","deletedAt:ASC","deletedAt:DESC"],"maxItems":2,"type":"string"},"type":"array"}},"TribeTagQueryParam":{"in":"query","name":"tag","schema":{"items":{"type":"string"},"maxItems":100,"type":"array"}},"VersionCodePathParam":{"in":"path","name":"versionCode","required":true,"schema":{"$ref":"#/components/schemas/VersionCode"}},"VillageCoordsQueryParam":{"in":"query","name":"coords","schema":{"items":{"example":"500|500","type":"string"},"maxItems":200,"type":"array"}},"VillageIdPathParam":{"in":"path","name":"villageId","required":true,"schema":{"$ref":"#/components/schemas/IntId"}}},"responses":{"ErrorResponse":{"content":{"application/json":{"schema":{"additionalProperti