Skip to content

Commit

Permalink
docs: Reference AIP links in a uniform way. (#840)
Browse files Browse the repository at this point in the history
  • Loading branch information
RocketDonkey authored Apr 27, 2021
1 parent 4f5c7ac commit 8e9cd4a
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/rules/0123/resource-reference-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ message Book {

Do not violate this rule; it will break several tools.

[aip-123]: http://aip.dev/123
[aip-123]: https://aip.dev/123
3 changes: 2 additions & 1 deletion docs/rules/0126/unspecified.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ redirect_from:
# Enum unspecified value

This rule enforces that all enums have a default unspecified value, as mandated
in [AIP-126](http://aip.dev/126).
in [AIP-126][].

Because our APIs create automatically-generated client libraries, we need to
consider languages that have varying behavior around default values. To avoid
Expand Down Expand Up @@ -69,4 +69,5 @@ enum Format {
If you need to violate this rule for an entire file, place the comment at the
top of the file.

[aip-126]: https://aip.dev/126
[aip.dev/not-precedent]: https://aip.dev/not-precedent
4 changes: 3 additions & 1 deletion docs/rules/0126/upper-snake-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ redirect_from:
# Upper snake case values

This rule enforces that all enum values be in upper snake case, as mandated in
[AIP-126](http://aip.dev/126).
[AIP-126][].

## Details

Expand Down Expand Up @@ -55,3 +55,5 @@ enum Format {

If you need to violate this rule for an entire file, place the comment at the
top of the file.

[aip-126]: https://aip.dev/126
3 changes: 2 additions & 1 deletion docs/rules/0132/request-parent-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ redirect_from:
# List methods: Parent field

This rule enforces that all `List` standard methods have a `string parent`
field in the request message, as mandated in [AIP-132](http://aip.dev/132).
field in the request message, as mandated in [AIP-132][].

## Details

Expand Down Expand Up @@ -61,4 +61,5 @@ message ListBooksRequest {
If you need to violate this rule for an entire file, place the comment at the
top of the file.

[aip-132]: https://aip.dev/132
[aip.dev/not-precedent]: https://aip.dev/not-precedent
3 changes: 2 additions & 1 deletion docs/rules/0132/request-parent-required.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ redirect_from:
# List methods: Parent field

This rule enforces that all `List` standard methods have a `string parent`
field in the request message, as mandated in [AIP-132](http://aip.dev/132).
field in the request message, as mandated in [AIP-132][].

## Details

Expand Down Expand Up @@ -61,4 +61,5 @@ message ListBooksRequest {
If you need to violate this rule for an entire file, place the comment at the
top of the file.

[aip-132]: https://aip.dev/132
[aip.dev/not-precedent]: https://aip.dev/not-precedent
3 changes: 2 additions & 1 deletion docs/rules/0132/request-show-deleted-required.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ redirect_from:

This rule enforces that all `List` standard methods have a `bool show_deleted`
field in the request message if the resource supports soft delete, as mandated
in [AIP-132](http://aip.dev/132).
in [AIP-132][].

## Details

Expand Down Expand Up @@ -77,4 +77,5 @@ message ListBooksRequest {
If you need to violate this rule for an entire file, place the comment at the
top of the file.

[aip-132]: https://aip.dev/132
[aip.dev/not-precedent]: https://aip.dev/not-precedent
3 changes: 2 additions & 1 deletion docs/rules/0133/request-parent-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ redirect_from:
# Create methods: Parent field

This rule enforces that all `Create` standard methods have a `string parent`
field in the request message, as mandated in [AIP-133](http://aip.dev/133).
field in the request message, as mandated in [AIP-133][].

## Details

Expand Down Expand Up @@ -61,4 +61,5 @@ message CreateBookRequest {
If you need to violate this rule for an entire file, place the comment at the
top of the file.

[aip-133]: https://aip.dev/133
[aip.dev/not-precedent]: https://aip.dev/not-precedent
3 changes: 2 additions & 1 deletion docs/rules/0133/request-parent-required.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ redirect_from:
# Create methods: Parent field

This rule enforces that all `Create` standard methods have a `string parent`
field in the request message, as mandated in [AIP-133](http://aip.dev/133).
field in the request message, as mandated in [AIP-133][].

## Details

Expand Down Expand Up @@ -61,4 +61,5 @@ message CreateBookRequest {
If you need to violate this rule for an entire file, place the comment at the
top of the file.

[aip-133]: https://aip.dev/133
[aip.dev/not-precedent]: https://aip.dev/not-precedent
2 changes: 1 addition & 1 deletion docs/rules/0140/prepositions.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,5 @@ message Book {
If you need to violate this rule for an entire file, place the comment at the
top of the file.

[aip-136]: https://aip.dev/136
[aip-140]: https://aip.dev/140
[aip.dev/not-precedent]: https://aip.dev/not-precedent
2 changes: 1 addition & 1 deletion docs/rules/0140/reserved-words.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ If you need to violate this rule for an entire file, place the comment at the
top of the file.

<!-- prettier-ignore-start -->
[aip-136]: https://aip.dev/136
[aip-140]: https://aip.dev/140
[aip.dev/not-precedent]: https://aip.dev/not-precedent
[the code]: https://github.com/googleapis/api-linter/blob/main/rules/aip0140/reserved_words.go
<!-- prettier-ignore-end -->

0 comments on commit 8e9cd4a

Please sign in to comment.