这是indexloc提供的服务,不要输入任何密码
Skip to content

Proposal: AIP for abbreviated resource names #1480

@tenF

Description

@tenF

When I was working on launching the new Comparison Shopping Service (CSS) API, we had to migrate existing CSS account functionality from ContentApi. The resource name for Comparison Shopping Service accounts was Css, and they were organized under the csses collection v2.1/{cssGroupId}/csses/.

'CSSes' was used as the plural form of the abbreviation CSS, although the official documentation uses 'CSSs' as the plural. (There seems to be no clear grammatical rule on forming the plural of abbreviations ending with 'S' by adding 'es'.)

I searched for AIPs regarding abbreviated resource names, but I couldn't find anything. We eventually decided to use the resource name Account for all account types, but it made me think about the RAS syndrome and consider an AIP proposal.

It could be clearer to append the last word of the abbreviation to the resource name to avoid confusion and improve plural readability.

For example, which one would you rather have:

  • v1/csses/123
  • v1/csss/123
  • v1/cssServices/123
  • v1/atms/123
  • v1/atmMachines/123
  • v1/hpvs/123
  • v1/hpvViruses/123
  • v1/aips/123
  • v1/aipProposals/123
  • v1/dcs/123
  • v1/dcComics/123

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