Skip to content

Consistent naming for enterprise & organization scoped functions #3761

@stevehipwell

Description

@stevehipwell

I'd like to see a consistent naming convention used for enterprise and organization scoped functions that reflects the significance of the scoping. My suggestion is that we adopt the pattern <VERB><SCOPE><SUBJECT> which as a very simple example would look something like GetOrganizationThing. Scope and subject are an overlapping concept so we will need to define valid scopes that are linear (possibly just enterprise and organization). Subject is a more of an art than a science but we will still want to keep the most significant information at the beginning of the function name.

As an example of an alternative but supporting pattern; in a greenfield API design these scopes could have been structural with a pattern such as client.organization.GetThing instead of client.GetOrganizationThing.

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