forked from BrasilAPI/BrasilAPI
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from danilosp1/docs
docs
- Loading branch information
Showing
4 changed files
with
87 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
{ | ||
"tags": [ | ||
{ | ||
"name": "TIMES", | ||
"description": "Informação dos times da seleção no Brasileirão" | ||
} | ||
], | ||
|
||
"paths": { | ||
"/times/v1/{serie}" : { | ||
"get" : { | ||
"tags" : ["TIMES"], | ||
"summary" : "Retorna os times no Brasileirão", | ||
"description" :"Informação dos times da seleção na série especificada", | ||
"parameters": [ | ||
{ | ||
"name": "série", | ||
"description": "Série que você deseja visualizar os times\n", | ||
"in": "path", | ||
"required": true, | ||
"schema": { | ||
"type": "string" | ||
} | ||
} | ||
], | ||
"responses" : { | ||
"200": { | ||
"description" : "Success", | ||
"content" : { | ||
"application/json" : { | ||
"schema" : { | ||
"type" : "array", | ||
"items" : { | ||
"$ref" : "#/components/schemas/Time" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
|
||
"components" : { | ||
"schemas" : { | ||
"Time" : { | ||
"title" : "Time", | ||
"required" : ["name", "score"], | ||
"type" : "object", | ||
"properties" : { | ||
"name" : { | ||
"type" : "string" | ||
}, | ||
"score" : { | ||
"type" : "string" | ||
} | ||
} , | ||
"example" : { | ||
"name" : "Palmeiras", | ||
"score" : "66" | ||
} | ||
} | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,6 +24,7 @@ const getDocs = () => { | |
'ISBN', | ||
'CPTEC', | ||
'PIX', | ||
'Times-Brasileirao', | ||
]; | ||
}; | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters