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

add metadata to each client action #2124

Merged
merged 4 commits into from
Mar 5, 2020
Merged

add metadata to each client action #2124

merged 4 commits into from
Mar 5, 2020

Conversation

shiftkey
Copy link
Member

@shiftkey shiftkey commented Mar 5, 2020

This PR adds attributes to each client action to provide context about where each client method is sourced from.

This comes with two main benefits:

  • by including the verb and path for each route, this will help me audit what parts of the API are not implemented currently
  • using ManualRouteAttribute will help me to track which code was hand-crafted, and hopefully which ones are generated by tooling in the future

I also noticed some places where things are likely broken, and some long-obsolete APIs, and I might need to make changes to this metadata down the track, but I can follow-up with other PRs later once I've given this another look.

@codecov
Copy link

codecov bot commented Mar 5, 2020

Codecov Report

Merging #2124 into master will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #2124      +/-   ##
==========================================
- Coverage   66.95%   66.91%   -0.05%     
==========================================
  Files         542      543       +1     
  Lines       14240    14252      +12     
==========================================
+ Hits         9535     9537       +2     
- Misses       4705     4715      +10     
Impacted Files Coverage Δ
Octokit/Helpers/ManualRouteAttribute.cs 0.00% <0.00%> (ø)
Octokit/SimpleJson.cs 70.41% <0.00%> (+0.26%) ⬆️

@shiftkey shiftkey merged commit f968856 into master Mar 5, 2020
@shiftkey shiftkey deleted the audit-all-endpoints branch March 5, 2020 01:10
@shiftkey
Copy link
Member Author

release_notes: add metadata to each client to assist with auditing API coverage

@nickfloyd nickfloyd added Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR and removed category: housekeeping labels Oct 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants