Skip to content

Commit af6d478

Browse files
authored
chore(AIP-9): downcase headings and terms as per dev docs style (#1463)
1 parent aaceb3c commit af6d478

1 file changed

Lines changed: 34 additions & 33 deletions

File tree

aip/general/0009.md

Lines changed: 34 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -18,90 +18,90 @@ The following terminology **should** be used consistently throughout AIPs.
1818

1919
### API
2020

21-
Application Programming Interface. This can be a local interface (such as a
21+
Application programming interface. This can be a local interface (such as a
2222
client library) or a Network API (defined below).
2323

24-
### API Backend
24+
### API backend
2525

2626
A set of servers and related infrastructure that implements the business logic
27-
for an API Service. An individual API backend server is often called an API
27+
for an API service. An individual API backend server is often called an API
2828
server.
2929

30-
### API Consumer
30+
### API consumer
3131

32-
The entity that consumes an API Service. For Google APIs, it typically is a
32+
The entity that consumes an API service. For Google APIs, it typically is a
3333
Google project that owns the client application or the server resource.
3434

35-
### API Definition
35+
### API definition
3636

3737
The definition of an API, usually defined in a Protocol Buffer service. An API
38-
Definition can be implemented by any number of API Services.
38+
definition can be implemented by any number of API services.
3939

40-
### API Frontend
40+
### API frontend
4141

4242
A set of servers plus related infrastructure that provides common functionality
43-
across API Services, such as load balancing and authentication. An individual
43+
across API services, such as load balancing and authentication. An individual
4444
API frontend server is often called an API proxy.
4545

4646
**Note:** the API frontend and the API backend may run next to each other or far
4747
away from each other. In some cases, they can be compiled into a single
4848
application binary and run inside a single process.
4949

50-
### API Method
50+
### API method
5151

5252
An individual operation within an API. It is typically represented in Protocol
5353
Buffers by an `rpc` definition, and is mapped to a function in the API in most
5454
programming languages.
5555

56-
### API Producer
56+
### API producer
5757

58-
The entity that produces an API Service. For Google APIs, it typically is a
59-
Google team responsible for the API Service.
58+
The entity that produces an API service. For Google APIs, it typically is a
59+
Google team responsible for the API service.
6060

61-
### API Product
61+
### API product
6262

63-
An API Service and its related components, such as Terms of Service,
63+
An API service and its related components, such as Terms of Service,
6464
documentation, client libraries, and service support, are collectively presented
65-
to customers as a API Product. For example, Google Calendar API.
65+
to customers as a API product. For example, Google Calendar API.
6666

67-
**Note:** people sometimes refer to an API Product simply as an API.
67+
**Note:** people sometimes refer to an API product simply as an API.
6868

69-
### API Service
69+
### API service
7070

7171
A deployed implementation of one or more APIs, exposed on one or more network
7272
addresses, such as the Cloud Pub/Sub API.
7373

74-
### API Service Definition
74+
### API service definition
7575

76-
The combination of API Definitions (`.proto` files) and API Service
77-
configurations (`.yaml` files) used to define an API Service. The schema for
78-
Google API Service Definition is `google.api.Service`.
76+
The combination of API definitions (`.proto` files) and API service
77+
configurations (`.yaml` files) used to define an API service. The schema for
78+
Google API service definition is `google.api.Service`.
7979

80-
### API Service Endpoint
80+
### API service endpoint
8181

82-
Refers to a network address that an API Service uses to handle incoming API
83-
Requests. One API Service may have multiple API Service Endpoints, such as
82+
Refers to a network address that an API service uses to handle incoming API
83+
requests. One API service may have multiple API service endpoints, such as
8484
`https://pubsub.googleapis.com` and `https://content-pubsub.googleapis.com`.
8585

86-
### API Service Name
86+
### API service name
8787

88-
Refers to the logical identifier of an API Service. Google APIs use RFC 1035 DNS
89-
compatible names as their API Service Names, such as `pubsub.googleapis.com`.
88+
Refers to the logical identifier of an API service. Google APIs use RFC 1035 DNS
89+
compatible names as their API service names, such as `pubsub.googleapis.com`.
9090

91-
### API Title
91+
### API title
9292

9393
Refers to the user-facing product title of an API service, such as "Cloud Pub/Sub
9494
API".
9595

96-
### API Request
96+
### API request
9797

98-
A single invocation of an API Method. It is often used as the unit for billing,
98+
A single invocation of an API method. It is often used as the unit for billing,
9999
logging, monitoring, and rate limiting.
100100

101-
### API Version
101+
### API version
102102

103103
The version of an API or a group of APIs if they are defined together. An API
104-
Version is often represented by a string, such as "v1", and presents in API
104+
version is often represented by a string, such as "v1", and presents in API
105105
requests and Protocol Buffers package names.
106106

107107
### Client
@@ -161,6 +161,7 @@ organizations separate from those that consume them.
161161

162162
## Changelog
163163

164+
- **2024-12-18**: Downcase headings and terms as per dev docs style
164165
- **2024-10-23**: Add API Title entry
165166
- **2023-07-24**: Rename IaC to Declarative Clients
166167
- **2023-04-01**: Adding definition of IaC

0 commit comments

Comments
 (0)