Skip to content

Commit 029ab09

Browse files
authored
feat(0004): clarify lowercase in type (#380)
Resource types **must** be lowercase, as the name must be kebab-case. However, it's valuable to explicitly clarify this. also fixing some broken links discovered along the way.
1 parent 12dc65a commit 029ab09

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

aep/general/0004/aep.md.j2

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,11 @@ indicated by it's namespacing within the API name.
2424

2525
The type name:
2626

27-
- **must** Only contain ASCII alphanumeric characters.
28-
- **must** Start with a lowercase letter.
29-
- **must** Be of the singular form of the resource.
30-
- **must** Use kebab case.
27+
- **must** only contain ASCII alphanumeric characters.
28+
- **must** start with a lowercase letter.
29+
- **must** be of the singular form of the resource.
30+
- **must** use kebab case.
31+
- **must** use all lowercase characters.
3132

3233
### Examples
3334

aep/general/0102/aep.md.j2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ specification in depth.
1010
An API name is a string that **must** uniquely identify the API. It serves as a
1111
namespace where elements of an API are defined, including:
1212

13-
- [resource types][/resource-types]
14-
- [methods][/standard-methods]
13+
- [resource types](/resource-types)
14+
- [methods](/standard-methods)
1515

1616
In practice, it is difficult to prevent the re-use of the name across different
1717
APIs. Therefore the API should use something, such as the domain name of the

0 commit comments

Comments
 (0)