Skip to content

AEP-140 URI vs URL #358

@thegagne

Description

@thegagne

Recently running the OAS linter on a project, it got flagged for fields containing url in the field names.

Current guidance field names is that they should be uri and not url.

Field names representing URLs or URIs should always use uri rather than url. This is because while all URLs are URIs, not all URIs are URLs. Field names may use a prefix in front of uri as appropriate.

I asked this question in Slack around it:

Has someone been burned by this or why did this come up?
If you know it's specifically a URL, why not say that in the field name?
Can discuss tomorrow or any other time, it's not super urgent, just want to know if I should push people towards URI.

@kindermoumoute replied.

Looks like it’s from the original AIP, which recently changed aip-dev/google.aip.dev#1551

If it got changed in AIP, maybe we should change it as well?

This would impact both AEP-140 and the linters which are enforcing this.

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