Compare commits

...

12 Commits

Author SHA1 Message Date
Drew Hynes b9ad313839 Merge branch 'swagger-implementation' into 'master'
Swagger implementation

See merge request dword4/nhlapi!36
2023-11-08 01:35:55 +00:00
Drew Hynes 8d9129517c Merge branch 'leo' into 'master'
Added documentation regarding the new stats endpoints

See merge request dword4/nhlapi!41
2023-11-08 00:11:04 +00:00
Drew Hynes 2aa1a1e9d0 Merge branch 'rotorink-master-patch-76155' into 'master'
update made-with.md to include rotorink

See merge request dword4/nhlapi!42
2023-11-08 00:09:27 +00:00
Zach Edwards 910b849e31 update made-with.md to include rotorink 2023-11-08 00:09:26 +00:00
Leo Lewis 2e9d02d63b Added documentation regarding the new stats endpoints 2023-09-25 16:38:51 -05:00
Drew Hynes f810e66f55 added env 2023-01-25 00:48:55 +00:00
Drew Hynes 0944d424fd removed pages section 2023-01-25 00:43:44 +00:00
Drew Hynes 9793c2ecd2 adding changes to try to deploy to pages 2023-01-25 00:39:54 +00:00
Drew Hynes e669b084ec fix attempt 2022-12-26 10:34:08 -05:00
Drew Hynes 8679695402 removed attempt at output to public folder 2022-12-26 10:30:06 -05:00
Drew Hynes f5baf6d765 added empty file 2022-12-26 10:22:57 -05:00
Drew Hynes 1b42b5d55c revision to redoc-cli usage 2022-12-26 15:18:36 +00:00
5 changed files with 81 additions and 2 deletions

View File

@ -4,7 +4,10 @@ pages:
stage: deploy
script:
- npm install -g redoc-cli
- redoc-cli build public/index.html swagger/openapi.yaml
- redoc-cli build swagger/openapi.yaml
- cp redoc-static.html public/index.html
artifacts:
paths:
- public
- public/
environment:
name: pages

View File

@ -22,6 +22,7 @@ documentation including examples in multiple common langages (such as using Swag
|[misc.md](misc.md)|Random things the NHL API uses or is somehow related to|
|[records-api.md](records-api.md)|Documentation on the API for records.nhl.com|
|[stats-api.md](stats-api.md)|The one, the only NHL API (stats) documentation!|
|[new-api.md](new-api.md)|New 2023 NHL API (stats) documentation|
## Contributing

View File

@ -61,3 +61,9 @@ Description: A (WIP) GraphQL server wrapping the documented endpoints of this pr
Code: https://github.com/Rblock919/open-hockey-api
Author: [rblock919](https://github.com/Rblock919)
## rotorink
Description: Social Media Hockey application built with Nuxt 3 and Prisma complete with user authentication.
Code: https://github.com/edwardz8/nuxt3-zero

View File

@ -632,6 +632,75 @@ The NHL has surprised us all with a new API, so that means a new file to track a
`GET https://api-web.nhle.com/v1/player/PLAYER_ID/landing` | Player specific stats
`GET https://api.nhle.com/stats/rest/en/` | Base stats URL
`/config` | Stats configuration options. For each stat option and report type, this endpoint describes the default configuration of the columns, filters and sorting. <br>
`/franchise?` | Franchise info <br>
`/country?` | Country info <br>
`/season?` | Season info <br>
`/draft?` | Draft info <br>
## Skater Stats
`GET https://api.nhle.com/stats/rest/en/skater` | Base end point
### Report types: <br>
`/summary?`<br>
`/bios?`<br>
`/faceoffpercentages?`<br>
`/faceoffwins?`<br>
`/goalsForAgainst?`<br>
`/realtime?`<br>
`/penalties?`<br>
`/penaltykill?`<br>
`/penaltyShots?`<br>
`/powerplay?`<br>
`/puckPossessions?`<br>
`/summaryshooting?`<br>
`/percentages?`<br>
`/scoringRates?`<br>
`/scoringpergame?`<br>
`/shootout?`<br>
`/shottype?`<br>
`/timeonice?`<br>
## Goalie Stats
`GET https://api.nhle.com/stats/rest/en/goalie` | Base end point
### Report types: <br>
`/summary?`<br>
`/advanced?`<br>
`/bios?`<br>
`/daysrest?`<br>
`/penaltyShots?`<br>
`/savesByStrength?`<br>
`/shootout?`<br>
`/startedVsRelieved?`<br>
## Team Stats
`GET https://api.nhle.com/stats/rest/en/team` | Base end point
### Report types: <br>
`/summary?`<br>
`/faceoffpercentages?`<br>
`/daysbetweengames?`<br>
`/faceoffwins?`<br>
`/goalsagainstbystrength?`<br>
`/goalsbyperiod?`<br>
`/goalsforbystrength?`<br>
`/leadingtrailing?`<br>
`/realtime?`<br>
`/outshootoutshotby?`<br>
`/penalties?`<br>
`/penaltykill?`<br>
`/penaltykilltime?`<br>
`/powerplay?`<br>
`/powerplaytime?`<br>
`/summaryshooting?`<br>
`/percentages?`<br>
`/scoretrailfirst?`<br>
`/shootout?`<br>
`/shottype?`<br>
`/goalgames?`<br>
# Rosters
`GET https://api-web.nhle.com/v1/roster/TEAM_ABBR/now` | ADD description

0
public/index.html Normal file
View File