Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Endpoint documentation from nba_py #22

Closed
bttmly opened this issue Feb 25, 2016 · 2 comments
Closed

Endpoint documentation from nba_py #22

bttmly opened this issue Feb 25, 2016 · 2 comments

Comments

@bttmly
Copy link
Owner

bttmly commented Feb 25, 2016

Add a script to pull this in automatically https://github.com/seemethere/nba_py/wiki/stats.nba.com-Endpoint-Documentation

Per seemethere/nba_py#18, consider generating API client programmatically from a machine-readable documentation file.

@danielwelch
Copy link

I'm working on doing this here as a fun weekend project. Using the endpoint documentation from nba_py, I'm working on generating a JSON documentation file that adheres to the Swagger specification. I initially created a JSON simply containing the endpoints and parameters and used it to generate a simple, very low-level client, but then thought using something like Swagger would be more useful.

So far, other than reformatting the information, I've specified whether or not each parameter is required, per the 400 responses from the stats.nba.com API, and identified endpoints from the documentation file that appear to be inactive (404).

This is a very rough first pass on this, and I have not tested or validated this representation at all (aside from validating that the code generates a valid swagger specification).

Next, I'd like to add information about what the API expects for each parameter. Hoping to do this by inspecting responses further (ex: in some cases, if a bad parameter is used, the API will return a regex that the parameter must match).

@bttmly
Copy link
Owner Author

bttmly commented Oct 17, 2016

RE: programmatic client generation:

developed package nba-client-template which will be used in (forthcoming) version 3 of this package

@bttmly bttmly closed this as completed Oct 17, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants