From f4ea97e0affa2a28ea7f83b9ea010396bc0aea96 Mon Sep 17 00:00:00 2001 From: Drew Hynes Date: Fri, 18 Jun 2021 22:29:04 -0400 Subject: [PATCH] made-with cleanup, added misc and updated README --- README.md | 11 +++++++++++ made-with.md | 6 +++++- misc.md | 15 +++++++++++++++ 3 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 misc.md diff --git a/README.md b/README.md index 20379cf..d962908 100644 --- a/README.md +++ b/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 diff --git a/made-with.md b/made-with.md index 7a073c8..7e274c9 100644 --- a/made-with.md +++ b/made-with.md @@ -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) diff --git a/misc.md b/misc.md new file mode 100644 index 0000000..87c8f99 --- /dev/null +++ b/misc.md @@ -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.