Skip to content

Commit 234a2ad

Browse files
authored
feat: moving content out of appendix. (#1057)
As discussed in #1048, the appendix today is not used as a location to discuss in-depth design decisions as is stated in AIP-8, but is instead used to state content that should be in the general AIP guidance. Correcting those examples.
1 parent 4f2fccc commit 234a2ad

5 files changed

Lines changed: 6 additions & 11 deletions

File tree

aip/aog/3021.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ enough to be modeled in a permanent/unversioned way, then API author **should**
3535
consider proposing a new Actions on Google common type in
3636
[google.actions.type.\*][actions-type].
3737

38-
The guidance in the appendix of [AIP-213][] also applies to creating new
38+
The guidance in [AIP-213][] also applies to creating new
3939
Actions on Google common types. Specifically, API authors proposing new types
4040
**should** consider whether a new type should be a Google-wide common type
4141
rather than an Actions on Google common type. One exception to this is that new

aip/general/0162.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ message DeleteBookRevisionRequest {
389389
- The response **should** include the fully-populated resource unless it is
390390
infeasible to do so.
391391

392-
## Appendix: Character Collision
392+
### Character Collision
393393

394394
Most resource names have a restrictive set of characters, but some are very
395395
open. For example, Google Cloud Storage allows the `@` character in filenames,

aip/general/0194.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@ error codes:
3838
generally transient. It is retryable under the expectation that the
3939
connection will become available (soon).
4040

41-
## Appendix
42-
4341
### Non-retryable codes
4442

4543
The following codes **should not** be automatically retried for any request:

aip/general/0213.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ and the definitive list is always [the code][type], several types deserve note:
120120
[time_of_day]: https://github.com/googleapis/googleapis/blob/master/google/type/timeofday.proto
121121
<!-- prettier-ignore-end -->
122122

123-
## Appendix: Adding to common protos
123+
### Adding to common protos
124124

125125
Occasionally, it may be useful to add protos to these packages or to add to the
126126
list of commonly-available protos. In order to do this, [open an issue][] on

aip/general/0216.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,6 @@ large number of states simply because they exist in your internal system is
5151
unnecessary and adds confusion for customers. Each state must come with a use
5252
case for why it is necessary.
5353

54-
A list of commonly used enum values for states is in the appendix of this
55-
document.
56-
5754
### Output only
5855

5956
The field referencing the `State` enum in a resource **should** behave and be
@@ -189,13 +186,13 @@ above. In this situation, the API may be better off exposing a
189186
`google.protobuf.Timestamp delete_time`, and instructing users to rely on
190187
whether it is set to determine deletion.
191188

192-
## Appendix: Common states
189+
### Common states
193190

194191
The following is a list of states in common use. APIs **should** consider prior
195192
art when determining state names, and **should** value local consistency above
196193
global consistency in the case of conflicting precedent.
197194

198-
### Resting states
195+
#### Resting states
199196

200197
"Resting states" are lifecycle states that, absent user action, are expected to
201198
remain indefinitely. However, the user can initiate an action to move a
@@ -210,7 +207,7 @@ resource in a resting state into certain other states (resting or active).
210207
- `SUSPENDED`
211208
- `VERIFIED`
212209

213-
### Active states
210+
#### Active states
214211

215212
"Active states" are lifecycle states that typically resolve on their own into a
216213
single expected resting state.

0 commit comments

Comments
 (0)