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

API Doctor bug affecting updates to permissions tables for URLs with /$ref & /$count path segments #2307

Open
FaithOmbongi opened this issue Jan 28, 2025 · 0 comments

Comments

@FaithOmbongi
Copy link

Describe the bug
API Doctor runs every day to reconcile permissions tables in API docs with the data in the AGS repo. Unfortunately, for endpoints that end with the /$ref or /$count segment, the tooling strips the last segment, then tries to reconciles the remaining endpoint, causing a false negative - i.e. the data for that endpoint isn't available in the permissions JSON files in the AGS repo.

For example:

If the true URL is PUT /directory/authenticationMethodDevices/hardwareOathDevices/{hardwareOathTokenAuthenticationMethodDeviceId}/assignTo/$ref

API Doctor only searches for PUT /directory/authenticationMethodDevices/hardwareOathDevices/{hardwareOathTokenAuthenticationMethodDeviceId}/assignTo and therefore fails to update the associated permissions tables correctly.

As per @millicentachieng, it's a bug 👇🏾

Faith, worth noting, API Doctor and the 'Explorer tool' remove $ref and $count segments from request URLs before attempting to fetch their permissions. However, I’ve observed that some paths in the permissions JSON file include $ref segments. Stripping $ref before lookup could result in missing the exact permissions for those paths.

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

No branches or pull requests

1 participant