mirror of
https://gitlab.com/dword4/nhlapi
synced 2024-12-23 01:27:35 +00:00
made-with cleanup, added misc and updated README
This commit is contained in:
parent
d733ecd532
commit
f4ea97e0af
11
README.md
11
README.md
@ -13,6 +13,17 @@ Eventually build documentation on features such as cayenneExp which allows for
|
||||
retrieval of very complex documentation and perhaps even a more thorough set of
|
||||
documentation including examples in multiple common langages (such as using Swagger)
|
||||
|
||||
|
||||
## Files
|
||||
|
||||
| file | description |
|
||||
| --- | --- |
|
||||
|[made-with.md](made-with.md)|Collection of things made using the NHL API documentation, by no means exhaustive and zero affiliation with these projects.|
|
||||
|[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!|
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
I am only one person so if you see something I have missed please feel free to
|
||||
|
@ -7,13 +7,17 @@ This document exists to collect things that people make using this documentation
|
||||
## nhl-api-explorer
|
||||
|
||||
Description: nuxtjs client with nodejs server (to bypass CORS headers).
|
||||
|
||||
Live: https://nhl-api-explorer.herokuapp.com/
|
||||
|
||||
Code: https://gitlab.com/sebastienblanchet/nhl-api-explorer
|
||||
|
||||
Author: [Sebastien Blanchet](https://gitlab.com/sebastienblanchet)
|
||||
|
||||
## hockey-info.online
|
||||
|
||||
Description: web app showing hockey information in a mobile friendly format
|
||||
Live: https://www.hockey-info.online
|
||||
|
||||
Code: https://gitlab.com/dword4/hockey-info
|
||||
|
||||
Author: [Me](https://gitlab.com/dword4)
|
||||
|
15
misc.md
Normal file
15
misc.md
Normal file
@ -0,0 +1,15 @@
|
||||
# Miscellaneous
|
||||
|
||||
This area documents things not directly part of the NHL API but related to it, utilized by it or otherwise related to it somehow.
|
||||
|
||||
## Player Name Suggestion
|
||||
|
||||
This service appears to be a search of players based on name
|
||||
|
||||
`GET https://suggest.svc.nhl.com/svc/suggest/v1/minplayers/NAME/NUMBER`
|
||||
|
||||
Takes the NAME value which can be any part of a player's name and a NUMBER of results to return, this endpoint searches for all players with this name fragment
|
||||
|
||||
`GET https://suggest.svc.nhl.com/svc/suggest/v1/minactiveplayers/NAME/NUMBER`
|
||||
|
||||
Same as the minplayers endpoint however this only looks at active players.
|
Loading…
Reference in New Issue
Block a user