File tree 1 file changed +8
-5
lines changed
1 file changed +8
-5
lines changed Original file line number Diff line number Diff line change 1
1
# Istio API Style Guide
2
2
3
3
This page defines the design guidelines for Istio APIs. They apply to
4
- all proto files in the Istio project. Developers who create their APIs
5
- using Istio may find these guidelines useful as well.
4
+ all proto files in the Istio project. Developers who create their own
5
+ APIs using Istio should find these guidelines useful as well.
6
6
7
7
Since Istio APIs are based on _ proto3_ and _ gRPC_ , we will use
8
8
Google's [ API Design Guide] ( https://cloud.google.com/apis/design ) as
@@ -16,8 +16,8 @@ followed for Istio APIs.
16
16
## Naming
17
17
18
18
Having consistent naming improves understanding of the APIs and reduce
19
- churns on the API design. Istio APIs should follow the following
20
- naming convention :
19
+ churns on the API design. Istio APIs should follow these naming
20
+ conventions :
21
21
22
22
* Package names must use ` lowercase ` without any ` _ ` . Singular words
23
23
are recommended to avoid mixture of plural and singular words in
@@ -33,7 +33,10 @@ naming convention:
33
33
* Field names must use ` lowercase_with_underscore ` . For example,
34
34
` display_name ` .
35
35
36
- * Avoid using postpositive adjectives. For example,
36
+ * Repeated fields must use proper plural names. For example,
37
+ ` rules ` .
38
+
39
+ * Avoid using postpositive adjectives in names. For example,
37
40
` collected_items ` is recommended over ` items_collected ` .
38
41
39
42
## Versioning
You can’t perform that action at this time.
0 commit comments