· 5 years ago · Jan 15, 2021, 04:48 PM
1{"swagger":"2.0","info":{"version":"7.0.1 (UNKNOWN)","title":"PostgREST API","description":"This is a dynamic API generated by PostgREST"},"host":"0.0.0.0:3000","basePath":"/","schemes":["http"],"consumes":["application/json","application/vnd.pgrst.object+json","text/csv"],"produces":["application/json","application/vnd.pgrst.object+json","text/csv"],"paths":{"/":{"get":{"tags":["Introspection"],"summary":"OpenAPI description (this document)","produces":["application/openapi+json","application/json"],"responses":{"200":{"description":"OK"}}}},"/admin":{"get":{"tags":["admin"],"parameters":[{"$ref":"#/parameters/rowFilter.admin.id"},{"$ref":"#/parameters/rowFilter.admin.username"},{"$ref":"#/parameters/rowFilter.admin.password"},{"$ref":"#/parameters/select"},{"$ref":"#/parameters/order"},{"$ref":"#/parameters/range"},{"$ref":"#/parameters/rangeUnit"},{"$ref":"#/parameters/offset"},{"$ref":"#/parameters/limit"},{"$ref":"#/parameters/preferCount"}],"responses":{"206":{"description":"Partial Content"},"200":{"schema":{"items":{"$ref":"#/definitions/admin"},"type":"array"},"description":"OK"}}},"post":{"tags":["admin"],"parameters":[{"$ref":"#/parameters/body.admin"},{"$ref":"#/parameters/select"},{"$ref":"#/parameters/preferReturn"}],"responses":{"201":{"description":"Created"}}},"delete":{"tags":["admin"],"parameters":[{"$ref":"#/parameters/rowFilter.admin.id"},{"$ref":"#/parameters/rowFilter.admin.username"},{"$ref":"#/parameters/rowFilter.admin.password"},{"$ref":"#/parameters/preferReturn"}],"responses":{"204":{"description":"No Content"}}},"patch":{"tags":["admin"],"parameters":[{"$ref":"#/parameters/rowFilter.admin.id"},{"$ref":"#/parameters/rowFilter.admin.username"},{"$ref":"#/parameters/rowFilter.admin.password"},{"$ref":"#/parameters/body.admin"},{"$ref":"#/parameters/preferReturn"}],"responses":{"204":{"description":"No Content"}}}},"/auction_bids":{"get":{"tags":["auction_bids"],"parameters":[{"$ref":"#/parameters/rowFilter.auction_bids.id"},{"$ref":"#/parameters/rowFilter.auction_bids.amount"},{"$ref":"#/parameters/rowFilter.auction_bids.when"},{"$ref":"#/parameters/rowFilter.auction_bids.player_id"},{"$ref":"#/parameters/rowFilter.auction_bids.team_id"},{"$ref":"#/parameters/select"},{"$ref":"#/parameters/order"},{"$ref":"#/parameters/range"},{"$ref":"#/parameters/rangeUnit"},{"$ref":"#/parameters/offset"},{"$ref":"#/parameters/limit"},{"$ref":"#/parameters/preferCount"}],"responses":{"206":{"description":"Partial Content"},"200":{"schema":{"items":{"$ref":"#/definitions/auction_bids"},"type":"array"},"description":"OK"}}},"post":{"tags":["auction_bids"],"parameters":[{"$ref":"#/parameters/body.auction_bids"},{"$ref":"#/parameters/select"},{"$ref":"#/parameters/preferReturn"}],"responses":{"201":{"description":"Created"}}},"delete":{"tags":["auction_bids"],"parameters":[{"$ref":"#/parameters/rowFilter.auction_bids.id"},{"$ref":"#/parameters/rowFilter.auction_bids.amount"},{"$ref":"#/parameters/rowFilter.auction_bids.when"},{"$ref":"#/parameters/rowFilter.auction_bids.player_id"},{"$ref":"#/parameters/rowFilter.auction_bids.team_id"},{"$ref":"#/parameters/preferReturn"}],"responses":{"204":{"description":"No Content"}}},"patch":{"tags":["auction_bids"],"parameters":[{"$ref":"#/parameters/rowFilter.auction_bids.id"},{"$ref":"#/parameters/rowFilter.auction_bids.amount"},{"$ref":"#/parameters/rowFilter.auction_bids.when"},{"$ref":"#/parameters/rowFilter.auction_bids.player_id"},{"$ref":"#/parameters/rowFilter.auction_bids.team_id"},{"$ref":"#/parameters/body.auction_bids"},{"$ref":"#/parameters/preferReturn"}],"responses":{"204":{"description":"No Content"}}}},"/player":{"get":{"tags":["player"],"parameters":[{"$ref":"#/parameters/rowFilter.player.id"},{"$ref":"#/parameters/rowFilter.player.firstname"},{"$ref":"#/parameters/rowFilter.player.middlename"},{"$ref":"#/parameters/rowFilter.player.lastname"},{"$ref":"#/parameters/rowFilter.player.player_type"},{"$ref":"#/parameters/rowFilter.player.buyout"},{"$ref":"#/parameters/rowFilter.player.start_price"},{"$ref":"#/parameters/rowFilter.player.auctioned"},{"$ref":"#/parameters/rowFilter.player.contract_period"},{"$ref":"#/parameters/rowFilter.player.team_id"},{"$ref":"#/parameters/select"},{"$ref":"#/parameters/order"},{"$ref":"#/parameters/range"},{"$ref":"#/parameters/rangeUnit"},{"$ref":"#/parameters/offset"},{"$ref":"#/parameters/limit"},{"$ref":"#/parameters/preferCount"}],"responses":{"206":{"description":"Partial Content"},"200":{"schema":{"items":{"$ref":"#/definitions/player"},"type":"array"},"description":"OK"}}},"post":{"tags":["player"],"parameters":[{"$ref":"#/parameters/body.player"},{"$ref":"#/parameters/select"},{"$ref":"#/parameters/preferReturn"}],"responses":{"201":{"description":"Created"}}},"delete":{"tags":["player"],"parameters":[{"$ref":"#/parameters/rowFilter.player.id"},{"$ref":"#/parameters/rowFilter.player.firstname"},{"$ref":"#/parameters/rowFilter.player.middlename"},{"$ref":"#/parameters/rowFilter.player.lastname"},{"$ref":"#/parameters/rowFilter.player.player_type"},{"$ref":"#/parameters/rowFilter.player.buyout"},{"$ref":"#/parameters/rowFilter.player.start_price"},{"$ref":"#/parameters/rowFilter.player.auctioned"},{"$ref":"#/parameters/rowFilter.player.contract_period"},{"$ref":"#/parameters/rowFilter.player.team_id"},{"$ref":"#/parameters/preferReturn"}],"responses":{"204":{"description":"No Content"}}},"patch":{"tags":["player"],"parameters":[{"$ref":"#/parameters/rowFilter.player.id"},{"$ref":"#/parameters/rowFilter.player.firstname"},{"$ref":"#/parameters/rowFilter.player.middlename"},{"$ref":"#/parameters/rowFilter.player.lastname"},{"$ref":"#/parameters/rowFilter.player.player_type"},{"$ref":"#/parameters/rowFilter.player.buyout"},{"$ref":"#/parameters/rowFilter.player.start_price"},{"$ref":"#/parameters/rowFilter.player.auctioned"},{"$ref":"#/parameters/rowFilter.player.contract_period"},{"$ref":"#/parameters/rowFilter.player.team_id"},{"$ref":"#/parameters/body.player"},{"$ref":"#/parameters/preferReturn"}],"responses":{"204":{"description":"No Content"}}}},"/team":{"get":{"tags":["team"],"parameters":[{"$ref":"#/parameters/rowFilter.team.id"},{"$ref":"#/parameters/rowFilter.team.teamname"},{"$ref":"#/parameters/rowFilter.team.username"},{"$ref":"#/parameters/rowFilter.team.password"},{"$ref":"#/parameters/rowFilter.team.funds"},{"$ref":"#/parameters/select"},{"$ref":"#/parameters/order"},{"$ref":"#/parameters/range"},{"$ref":"#/parameters/rangeUnit"},{"$ref":"#/parameters/offset"},{"$ref":"#/parameters/limit"},{"$ref":"#/parameters/preferCount"}],"responses":{"206":{"description":"Partial Content"},"200":{"schema":{"items":{"$ref":"#/definitions/team"},"type":"array"},"description":"OK"}}},"post":{"tags":["team"],"parameters":[{"$ref":"#/parameters/body.team"},{"$ref":"#/parameters/select"},{"$ref":"#/parameters/preferReturn"}],"responses":{"201":{"description":"Created"}}},"delete":{"tags":["team"],"parameters":[{"$ref":"#/parameters/rowFilter.team.id"},{"$ref":"#/parameters/rowFilter.team.teamname"},{"$ref":"#/parameters/rowFilter.team.username"},{"$ref":"#/parameters/rowFilter.team.password"},{"$ref":"#/parameters/rowFilter.team.funds"},{"$ref":"#/parameters/preferReturn"}],"responses":{"204":{"description":"No Content"}}},"patch":{"tags":["team"],"parameters":[{"$ref":"#/parameters/rowFilter.team.id"},{"$ref":"#/parameters/rowFilter.team.teamname"},{"$ref":"#/parameters/rowFilter.team.username"},{"$ref":"#/parameters/rowFilter.team.password"},{"$ref":"#/parameters/rowFilter.team.funds"},{"$ref":"#/parameters/body.team"},{"$ref":"#/parameters/preferReturn"}],"responses":{"204":{"description":"No Content"}}}}},"definitions":{"admin":{"required":["id","username","password"],"properties":{"id":{"format":"integer","type":"integer","description":"Note:\nThis is a Primary Key.<pk/>"},"username":{"maxLength":64,"format":"character varying","type":"string"},"password":{"maxLength":128,"format":"character varying","type":"string"}},"type":"object"},"auction_bids":{"required":["id","amount"],"properties":{"id":{"format":"integer","type":"integer","description":"Note:\nThis is a Primary Key.<pk/>"},"amount":{"format":"double precision","type":"number"},"when":{"format":"timestamp without time zone","type":"string"},"player_id":{"format":"integer","type":"integer","description":"Note:\nThis is a Foreign Key to `player.id`.<fk table='player' column='id'/>"},"team_id":{"format":"integer","type":"integer","description":"Note:\nThis is a Foreign Key to `team.id`.<fk table='team' column='id'/>"}},"type":"object"},"player":{"required":["id","firstname","lastname"],"properties":{"id":{"format":"integer","type":"integer","description":"Note:\nThis is a Primary Key.<pk/>"},"firstname":{"maxLength":64,"format":"character varying","type":"string"},"middlename":{"maxLength":64,"format":"character varying","type":"string"},"lastname":{"maxLength":64,"format":"character varying","type":"string"},"player_type":{"format":"public.playerrole","type":"string","enum":["Batsman","Bowler","AllRounder","WicketKeeper"]},"buyout":{"format":"double precision","type":"number"},"start_price":{"format":"double precision","type":"number"},"auctioned":{"format":"boolean","type":"boolean"},"contract_period":{"format":"double precision","type":"number"},"team_id":{"format":"integer","type":"integer","description":"Note:\nThis is a Foreign Key to `team.id`.<fk table='team' column='id'/>"}},"type":"object"},"team":{"required":["id","teamname","username","password","funds"],"properties":{"id":{"format":"integer","type":"integer","description":"Note:\nThis is a Primary Key.<pk/>"},"teamname":{"maxLength":64,"format":"character varying","type":"string"},"username":{"maxLength":64,"format":"character varying","type":"string"},"password":{"maxLength":128,"format":"character varying","type":"string"},"funds":{"format":"double precision","type":"number"}},"type":"object"}},"parameters":{"preferParams":{"name":"Prefer","description":"Preference","required":false,"in":"header","type":"string","enum":["params=single-object"]},"preferReturn":{"name":"Prefer","description":"Preference","required":false,"in":"header","type":"string","enum":["return=representation","return=minimal","return=none"]},"preferCount":{"name":"Prefer","description":"Preference","required":false,"in":"header","type":"string","enum":["count=none"]},"select":{"name":"select","description":"Filtering Columns","required":false,"in":"query","type":"string"},"on_conflict":{"name":"on_conflict","description":"On Conflict","required":false,"in":"query","type":"string"},"order":{"name":"order","description":"Ordering","required":false,"in":"query","type":"string"},"range":{"name":"Range","description":"Limiting and Pagination","required":false,"in":"header","type":"string"},"rangeUnit":{"name":"Range-Unit","description":"Limiting and Pagination","required":false,"default":"items","in":"header","type":"string"},"offset":{"name":"offset","description":"Limiting and Pagination","required":false,"in":"query","type":"string"},"limit":{"name":"limit","description":"Limiting and Pagination","required":false,"in":"query","type":"string"},"body.admin":{"name":"admin","description":"admin","required":false,"schema":{"$ref":"#/definitions/admin"},"in":"body"},"rowFilter.admin.id":{"name":"id","required":false,"format":"integer","in":"query","type":"string"},"rowFilter.admin.username":{"name":"username","required":false,"format":"character varying","in":"query","type":"string"},"rowFilter.admin.password":{"name":"password","required":false,"format":"character varying","in":"query","type":"string"},"body.auction_bids":{"name":"auction_bids","description":"auction_bids","required":false,"schema":{"$ref":"#/definitions/auction_bids"},"in":"body"},"rowFilter.auction_bids.id":{"name":"id","required":false,"format":"integer","in":"query","type":"string"},"rowFilter.auction_bids.amount":{"name":"amount","required":false,"format":"double precision","in":"query","type":"string"},"rowFilter.auction_bids.when":{"name":"when","required":false,"format":"timestamp without time zone","in":"query","type":"string"},"rowFilter.auction_bids.player_id":{"name":"player_id","required":false,"format":"integer","in":"query","type":"string"},"rowFilter.auction_bids.team_id":{"name":"team_id","required":false,"format":"integer","in":"query","type":"string"},"body.player":{"name":"player","description":"player","required":false,"schema":{"$ref":"#/definitions/player"},"in":"body"},"rowFilter.player.id":{"name":"id","required":false,"format":"integer","in":"query","type":"string"},"rowFilter.player.firstname":{"name":"firstname","required":false,"format":"character varying","in":"query","type":"string"},"rowFilter.player.middlename":{"name":"middlename","required":false,"format":"character varying","in":"query","type":"string"},"rowFilter.player.lastname":{"name":"lastname","required":false,"format":"character varying","in":"query","type":"string"},"rowFilter.player.player_type":{"name":"player_type","required":false,"format":"public.playerrole","in":"query","type":"string"},"rowFilter.player.buyout":{"name":"buyout","required":false,"format":"double precision","in":"query","type":"string"},"rowFilter.player.start_price":{"name":"start_price","required":false,"format":"double precision","in":"query","type":"string"},"rowFilter.player.auctioned":{"name":"auctioned","required":false,"format":"boolean","in":"query","type":"string"},"rowFilter.player.contract_period":{"name":"contract_period","required":false,"format":"double precision","in":"query","type":"string"},"rowFilter.player.team_id":{"name":"team_id","required":false,"format":"integer","in":"query","type":"string"},"body.team":{"name":"team","description":"team","required":false,"schema":{"$ref":"#/definitions/team"},"in":"body"},"rowFilter.team.id":{"name":"id","required":false,"format":"integer","in":"query","type":"string"},"rowFilter.team.teamname":{"name":"teamname","required":false,"format":"character varying","in":"query","type":"string"},"rowFilter.team.username":{"name":"username","required":false,"format":"character varying","in":"query","type":"string"},"rowFilter.team.password":{"name":"password","required":false,"format":"character varying","in":"query","type":"string"},"rowFilter.team.funds":{"name":"funds","required":false,"format":"double precision","in":"query","type":"string"}},"externalDocs":{"url":"https://postgrest.org/en/v7.0/api.html","description":"PostgREST Documentation"}}