Doc: Add specification selection

This commit is contained in:
Kyle Hornberg
2019-01-02 14:47:07 -06:00
parent 7c9519c7fe
commit 6cac70edd7
+8 -3
View File
@@ -133,6 +133,11 @@ For applications provide the application id either from the ping webhook or the
The :code:`private_key` is a string of your private key provided for the application.
The :code:`app` scheme will use the application id and private key to get a token for the first installation id of the application.
API Schema/Routes/Specifications
--------------------------------
One can instantiate the ``Octokit`` with ``routes=specification`` where the ``specification`` is one of ``api.github.com``, ``ghe-2.15``, etc.
TODOs
===========
@@ -158,7 +163,7 @@ The :code:`octokit` client based on the available `route data <https://github.co
::
[ ] Periodically, check if ``routes.json`` has changed and if so fetch and open a PR for it to be merged
[x] Periodically, check if ``routes.json`` has changed and if so fetch and open a PR for it to be merged
[ ] Periodically, check if ``webhook-names.json`` has changed and if so fetch and open a PR for it to be merged
@@ -193,7 +198,7 @@ Best Practices
[ ] handles rate limiting
[ ] pagination
[x] pagination
Documentation
-------------
@@ -207,7 +212,7 @@ Deployment
::
[ ] Deploy wheels
[x] Deploy wheels
[ ] Make GitHub releases work