This repository was archived by the owner on Sep 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathopenapi.yaml
More file actions
57 lines (56 loc) · 1.32 KB
/
Copy pathopenapi.yaml
File metadata and controls
57 lines (56 loc) · 1.32 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
openapi: 3.0.1
info:
title: NBA Stats API
description: An API that retrieves NBA data & statistics, including the current scoreboard and player information.
version: 'v1'
servers:
- url: http://localhost:5003
paths:
/scoreboard:
get:
operationId: getScoreboard
summary: Get today's scoreboard
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ScoreboardResponse'
/player/{player_name}:
get:
operationId: getPlayer
summary: Get player information
parameters:
- in: path
name: player_name
schema:
type: string
required: true
description: The full name of the player.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PlayerResponse'
components:
schemas:
ScoreboardResponse:
type: array
items:
type: string
PlayerResponse:
type: object
properties:
id:
type: integer
full_name:
type: string
first_name:
type: string
last_name:
type: string
isActive:
type: boolean