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

Update documentation about API Authorizations #5316

Merged
merged 1 commit into from
Sep 27, 2018

Conversation

lyzadanger
Copy link
Contributor

This PR expands the API documentation section pertaining to clientCredentials and the X-Forwarded-User header.

image

It also denotes that you can use a forwarded user on the create-group endpoint:

image

Fixes hypothesis/product-backlog#768

Expand explanation of `clientCredentials` and add section for
forwarded users
@codecov
Copy link

codecov bot commented Sep 26, 2018

Codecov Report

Merging #5316 into master will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #5316      +/-   ##
==========================================
+ Coverage   95.96%   95.99%   +0.02%     
==========================================
  Files         467      467              
  Lines       25106    25389     +283     
  Branches     1375     1405      +30     
==========================================
+ Hits        24092    24371     +279     
- Misses        889      890       +1     
- Partials      125      128       +3
Impacted Files Coverage Δ
h/presenters/annotation_searchindex.py 93.33% <0%> (-2.5%) ⬇️
tests/h/search/index_test.py 98.32% <0%> (-0.09%) ⬇️
tests/h/presenters/annotation_searchindex_test.py 100% <0%> (ø) ⬆️
tests/h/search/conftest.py 100% <0%> (ø) ⬆️
tests/h/search/query_test.py 98.56% <0%> (+0.22%) ⬆️
h/search/query.py 96.63% <0%> (+0.29%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e9f6143...68828d1. Read the comment docs.

@robertknight robertknight self-assigned this Sep 27, 2018
Copy link
Member

@robertknight robertknight left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Is the plan to ultimately support X-Forwarded-User for all APIs that can be invoked as a specific user or only a subset?

@lyzadanger
Copy link
Contributor Author

@robertknight

LGTM. Is the plan to ultimately support X-Forwarded-User for all APIs that can be invoked as a specific user or only a subset?

Something we should discuss! There are no immediate plans to add X-Forwarded-User to any existing endpoint and I won't extend its use without us having a strategic conversation.

@lyzadanger lyzadanger merged commit 8ce91ca into master Sep 27, 2018
@lyzadanger lyzadanger deleted the api-authorization-docs branch September 27, 2018 12:50
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

Successfully merging this pull request may close these issues.

2 participants