https://developer.github.com/v3/checks/

This is slightly related to #51 as it's validating an optional parameter but the exception is worth looking into. The parameter comments contains a list object which the validation breaks on.

pulls = Octokit(auth='installation', app_id=APP_ID, private_key=private_key).pulls
pulls.create_a_pull_request_review(owner='Foo', repo='demo', number=1, body='hello world', event='COMMENT')
Traceback (most recent call last):
  File "<input>", line 1, in <module>
  File "/Users/ahmed/pyenvchatback/lib/python3.6/site-packages/octokit/__init__.py", line 192, in _api_call
    self._validate(kwargs, parameter_map)
  File "/Users/ahmed/pyenv/chatback/lib/python3.6/site-packages/octokit/__init__.py", line 30, in _validate
    self._validate_required_params(required_params, cached_kwargs)
  File "/Users/ahmed/pyenv/chatback/lib/python3.6/site-packages/octokit/__init__.py", line 38, in _validate_required_params
    utils.walk_path(cached_kwargs, p.split('.'))
  File "/Users/ahmed/pyenv/chatback/lib/python3.6/site-packages/octokit/utils.py", line 24, in walk_path
    walk_path(obj[path[0]], path[1:])
KeyError: 'comments[]'

Currently the assumption for app auth is to get a token for auth as an installation but one may want to auth as the app

I just ran into this... I got rate limited and the error message seemed fairly cryptic (since it essentially failed silently)

o = Octokit(auth='token', token="mykey")
repo = o.repos.get(owner="myowner", repo="myrepo")
repo.response # is <class 'octokit.ResponseData'>
repo.response.message # is "API rate limit exceeded for user ID XXXXX"

In my case what ended up happening was that I was trying to do something like

o = Octokit(auth='token', token="mykey")
repo = o.repos.get(owner="myowner", repo="myrepo")
repo.response.name # do something with this...

and I ended up getting an AttributeError

AttributeError: type object 'ResponseData' has no attribute 'name'

I'm not sure exactly what the behavior should be.... I assume there should be some exceptions raised in there when non-successful status codes are encountered... maybe? Thoughts?

e.g.

accept: 'application/vnd.github.mercy-preview+json,application/vnd.github.scarlet-witch-preview+json'

octokit/routes@0362c57

x-changes has what changed but the underlying data is already changed and therefore not reflected here

This broke a test which was good

I think what needs to happen is adding a conditional that checks of the x-changes and adds the operationId of before to the python object as well

If the param_value is None then the data for that function indicates that the parameter is unknown. This is likely a user error.

Perhaps the error can be more helpful in saying such

"installation": {
    "id": 12345	
  }

Use that from the webhook to do things authorized as an app?

When octokitpy-routes has a minor version change
add a minor version here

When octokitpy-routes has a major version change
add a major version here

Ad-hoc others when the version changes in the file

Tie this to git tags?

flow?

if version not in git tags
create tag
create release
deploy to pypi

would need to look at the PR from dependabot in an action and change the version and add a commit

example is creating a check run.

output is optional but the parameters if one uses output are still required

This is because the validation of required parameters is not taking into consideration of whether or not the whole path is currently in use.

The data has output.title as required. This is only true if output is a parameter.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency requests to v2.31.0 [security]
• chore(deps): update actions/setup-python action to v5
• chore(deps): update dependency sphinx to v7
• chore(deps): update dependency sphinx-rtd-theme to v2
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

    rp = required_parameters if isinstance(required_parameters, (dict, list)) else []
    for required_parameter in rp:

seems to allow the issue to pass but doesn't seem like a fix

For example, downloading a zipped artifact is very slow and eventually fails, due to trying to parse it as json or text

After fresh install on Windows using conda, following the example in the docs, I did:

from octokit import Octokit

and then I got:

>>> from octokit import Octokit
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "C:\Users\josee\Documents\mag\tesis\dev\env_github_app\lib\site-packages\octokit\__init__.py", line 6, in <module>
    from octokit_routes import specifications
  File "C:\Users\josee\Documents\mag\tesis\dev\env_github_app\lib\site-packages\octokit_routes\__init__.py", line 31, in <module>
    specifications = {spec.replace(".json", ""): _load_spec(spec) for spec in specs}
  File "C:\Users\josee\Documents\mag\tesis\dev\env_github_app\lib\site-packages\octokit_routes\__init__.py", line 31, in <dictcomp>
    specifications = {spec.replace(".json", ""): _load_spec(spec) for spec in specs}
  File "C:\Users\josee\Documents\mag\tesis\dev\env_github_app\lib\site-packages\octokit_routes\__init__.py", line 21, in _load_spec
    return _load_json(os.path.join(__location__, "routes", spec_name))
  File "C:\Users\josee\Documents\mag\tesis\dev\env_github_app\lib\site-packages\octokit_routes\__init__.py", line 9, in _load_json
    return json.load(f)
  File "C:\devel\conda\lib\json\__init__.py", line 293, in load
    return loads(fp.read(),
  File "C:\devel\conda\lib\encodings\cp1252.py", line 23, in decode
    return codecs.charmap_decode(input,self.errors,decoding_table)[0]
UnicodeDecodeError: 'charmap' codec can't decode byte 0x9d in position 6024723: character maps to <undefined>

I did a quick fix replacing:

with open(path, "r") as f:

with:

with open(path, "r", encoding="utf8") as f:

at line 9 in ...\site-packages\octokit_routes_init_.py inside the virtual enviroment

Thanks for this great library

Bests, José.-

When trying to create a repo passing has_issues =False does not seem to work but has_issues='false' does

Make the python boolean work

We've got a test that revealed an issue with this line of code:

https://github.com/khornberg/octokit.py/blob/master/src/octokit/webhook.py#L24

Since webhook_names contains a * this method will always return True