Skip to content

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

@FaithOmbongi

Description

@FaithOmbongi

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions