File tree Expand file tree Collapse file tree 12 files changed +137
-0
lines changed Expand file tree Collapse file tree 12 files changed +137
-0
lines changed Original file line number Diff line number Diff line change 1+ type : object
2+ properties :
3+ cluster_id :
4+ type : string
5+ cluster_name :
6+ type : string
7+ required :
8+ - cluster_id
9+ - cluster_name
10+ example :
11+ cluster_id : abcdefgh123456789
12+ cluster_name : MyCluster
Original file line number Diff line number Diff line change 1+ type : object
2+ properties :
3+ user_id :
4+ type : string
5+ name :
6+ type : string
7+ example :
8+ user_id : " 1"
9+ name : John
Original file line number Diff line number Diff line change 1+ type : object
2+ properties :
3+ error :
4+ type : object
5+ properties :
6+ type :
7+ type : number
8+ message :
9+ type : string
10+ example :
11+ error :
12+ type : 400
13+ message : ' Bad request'
Original file line number Diff line number Diff line change 1+ openapi : ' 3.0.3'
2+ info :
3+ version : 0.0.1
4+ title : My API
5+ description : Best API ever
6+ contact :
7+ name : My Support
8+ email : support@example.com
9+ servers :
10+ - url : 127.0.0.1/v1
11+ paths :
12+ $ref : paths.yaml
13+ components :
14+ schemas : {}
15+ tags :
16+ - name : Clusters
17+ - name : Users
Original file line number Diff line number Diff line change 1+ /clusters :
2+ $ref : " paths/clusters.yaml"
3+ /users :
4+ $ref : " paths/users.yaml"
Original file line number Diff line number Diff line change 1+ get :
2+ tags :
3+ - Clusters
4+ description : Returns a list of clusters
5+ operationId : getClusters
6+ responses :
7+ " 200 " :
8+ $ref : " ../responses/clusters.yaml"
9+ " 400 " :
10+ $ref : " ../responses/400.yaml"
Original file line number Diff line number Diff line change 1+ get :
2+ tags :
3+ - Users
4+ description : Returns a list of users
5+ operationId : getUsers
6+ responses :
7+ ' 200 ' :
8+ $ref : ' ../responses/users.yaml'
9+ ' 400 ' :
10+ $ref : ' ../responses/400.yaml'
Original file line number Diff line number Diff line change 1+ description : Bad request
2+ content :
3+ ' application/json ' :
4+ schema :
5+ $ref : ' ../errors/400.yaml'
Original file line number Diff line number Diff line change 1+ description : Not found
2+ content :
3+ " application/json " :
4+ schema :
5+ $ref : " ../errors/404.yaml"
Original file line number Diff line number Diff line change 1+ description : Clusters
2+ content :
3+ ' application/json ' :
4+ schema :
5+ type : array
6+ items :
7+ $ref : ' ../components/cluster.yaml'
You can’t perform that action at this time.
0 commit comments