Update API docs for Analytics endpoint(s)
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- api, documentation
Research direction
Open the linked drilldown analytics documentation section and inspect the /api-umbrella/v1/analytics/drilldown entry first. Confirm the endpoint's actual purpose and response from the project before replacing the incorrect “pending configuration changes” summary; done means the API docs accurately describe this endpoint.
Written by the indexing model from the issue text.
Description
The API Umbrella REST API docs contains a section for drilldown analytics. However, the documentation in that section seems to be incorrect, reading:
/api-umbrella/v1/analytics/drilldown
Get a summary of pending configuration changes.
We have a tool that relies on API Umbrella analytics, so would really value having updated documentation for this endpoint.
- Dominant language
- Ruby
- Stars
- 2.2k
- Forks
- 373
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from NatLabRockies/api-umbrella
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
NatLabRockies/api-umbrella#687 · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
NatLabRockies/api-umbrella#682 · 6 comments · 3 reactions ·
-
MacOS support Open
Difficulty 5/5 Over a week Newbie friendliness 20/100
NatLabRockies/api-umbrella#668 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 15/100
NatLabRockies/api-umbrella#659 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
NatLabRockies/api-umbrella#658 ·
All issues in NatLabRockies/api-umbrella
Similar issues
-
バグ
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
voxpupuli/puppet-epel#186 · 1 comment ·
-
external_created_at is no longer used for the message timestamp since the new message UI (v4.4.0) OpenBug Frontend
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
TheOdinProject/curriculum#31402 · 1 comment ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100