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

[FEATURE]Add deprecation warnings for Endpoint usage deviation from Specification #211

Open
saimedhi opened this issue Jul 12, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@saimedhi
Copy link
Collaborator

Is your feature request related to a problem?

  • Add deprecation warnings to all endpoint usages that deviate from the specification. Specifically, add deprecation warnings to all patches located here. This will facilitate future removal of patches and enable direct generation from the specification.

  • For example, deprecate createPointInTime, deletePointInTimeProxy, and issue a warning to use createPIT and deletePIT instead.

  • Another example involves getRoles proxy:


public function getRoles(array $params = [])
{
    $endpointBuilder = $this->endpoints;
    if (isset($params['role'])) {
        $endpoint = $endpointBuilder('Security\GetRole');
        $role = $this->extractArgument($params, 'role');
        $endpoint->setRole($role);
    } else {
        $endpoint = $endpointBuilder('Security\GetRoles');
    }
    $endpoint->setParams($params);

    return $this->performRequest($endpoint);
}

    In this case, issue a warning when the 'role' parameter is provided, advising to use the 'getRole' endpoint instead of the 'getRoles' endpoint.

What solution would you like?

Include clear and concise deprecation warnings for endpoint usages that do not conform to the specification.

@saimedhi saimedhi added enhancement New feature or request untriaged labels Jul 12, 2024
@dblock dblock removed the untriaged label Aug 5, 2024
@dblock
Copy link
Member

dblock commented Aug 5, 2024

[Catch All Triage - 1, 2, 3]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants