Skip to content

Add guidance to avoid overly generic resource names. #1288

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.

Sign up for GitHub

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

Open
Jseph wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add guidance to avoid overly generic resource names. #1288

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8199fda
Add guidance to avoid overly generic resource names.
Jseph Dec 20, 2023
d852fa1
Added update description
Jseph Dec 20, 2023
67d1e36
Fix typo
Jseph Dec 20, 2023
fb4dce2
Add rationale and make suggested formatting changes
Jseph Dec 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion aip/general/0123.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ the following pattern: `{Service Name}/{Type}`. The type name **must**:
- Be of the singular form of the noun.
- Use PascalCase (UpperCamelCase).

Additionally APIs **should** avoid avoid overly generic resource names like
Comment thread
noahdietz marked this conversation as resolved.
Outdated
Metadata, Resource, Config, Settings, etc.
Comment thread
Jseph marked this conversation as resolved.
Outdated

### Examples

Examples of resource types include:
Expand Down Expand Up @@ -118,7 +121,7 @@ such as UpperCamelCase and snake_case.
<!-- prettier-ignore-end -->

## Changelog

- **2023-12-20**: Added guidance on overly-generic resource type names.
- **2023-09-19**: Prohibit duplicate pattern variables.
- **2023-05-06**: Adding requirement of singular and plural.
- **2023-01-28**: Clarifying guidance for the resource type name.
Expand Down