Skip to content

Conflicting guidance in Azure guidelines on ODATA query parameters names #385

@forteddyt

Description

@forteddyt

In https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#query-options, it states

⛔ DO NOT prefix any of these query parameter names with "$" (the convention in the OData standard).

However in other Azure API guidelines (such as https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md) there is consistent examples of these ODATA query parameters being defined with a leading $.

Which is correct? Do I define my ODATA query parameters with a leading $ or not?

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