Skip to content

Commit 6da16c4

Browse files
lukesneeringerlukesneeringer
authored
feat: Lint PRs for Markdown style. (#118)
1 parent 0c43e4b commit 6da16c4

7 files changed

Lines changed: 77 additions & 54 deletions

File tree

‎.github/workflows/lint.yaml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: test
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
container: node:20
11+
steps:
12+
- uses: actions/checkout@v3
13+
- name: Install prettier.
14+
run: npm install --global prettier
15+
- name: Verify proper formatting.
16+
run: prettier --check **/*.md **/*.md.j2

‎ADOPTERS.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Adopters
22

3-
The following enumerates organizations who have adopted the AIPs in some form (directly, fork, or otherwise).
3+
The following enumerates organizations who have adopted the AIPs in some form
4+
(directly, fork, or otherwise).
45

5-
If you are using the AIPs at your organization, please add your organization's name to this list (in alphabetical order).
6+
If you are using the AIPs at your organization, please add your organization's
7+
name to this list (in alphabetical order).
68

7-
| Organization | Contact | How you use the AIPs |
8-
| ---------------------------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9-
| [Google](https://about.google/) | [@toumorokoshi](https://github.com/toumorokoshi) | Google maintains a fork at [google.aip.dev](http://google.aip.dev) which is adhered to for all APIs. Google also runs the [api-linter](https://linter.aip.dev/) across the company internally. |
10-
| [Roblox](https://corp.roblox.com/) | [@rofrankel](https://github.com/rofrankel) | Roblox maintains a private fork of the AIPs, and is using them as a style guide for new APIs. Roblox also maintains private forks of the [api-linter](https://linter.aip.dev) and [site generator](https://github.com/aip-dev/site-generator). |
9+
| Organization | Contact | How you use the AIPs |
10+
| ---------------------------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11+
| [Google](https://about.google/) | [@toumorokoshi](https://github.com/toumorokoshi) | Google maintains a fork at [google.aip.dev](http://google.aip.dev) which is adhered to for all APIs. Google also runs the [api-linter](https://linter.aip.dev/) across the company internally. |
12+
| [Roblox](https://corp.roblox.com/) | [@rofrankel](https://github.com/rofrankel) | Roblox maintains a private fork of the AIPs, and is using them as a style guide for new APIs. Roblox also maintains private forks of the [api-linter](https://linter.aip.dev) and [site generator](https://github.com/aip-dev/site-generator). |

‎LICENSE.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ Except as otherwise noted, the content of this repository is licensed under the
33
under the [Apache 2.0 License][2]. For details, see the developer.google.com
44
[Site Policies][3].
55

6-
[1]: https://creativecommons.org/licenses/by/4.0/
7-
[2]: https://www.apache.org/licenses/LICENSE-2.0
8-
[3]: https://developers.google.com/terms/site-policies
6+
[1]: https://creativecommons.org/licenses/by/4.0/
7+
[2]: https://www.apache.org/licenses/LICENSE-2.0
8+
[3]: https://developers.google.com/terms/site-policies
99

1010
---
1111

‎OWNERS.md‎

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,33 @@
11
# AIP Maintainers
22

3-
This page lists all active maintainers of the aip.dev and standard. Maintainers have write and approval privileges to the aip.dev repository.
3+
This page lists all active maintainers of the aip.dev and standard. Maintainers
4+
have write and approval privileges to the aip.dev repository.
45

56
## Maintainers
67

7-
| Name | GitHub | Organization (if applicable) |
8-
| --------------------------------------------------- | ------------------------------------------------ | ---------------------------- |
9-
| [Yusuke Tsutsumi](mailto:yusuketsutsumi@google.com) | [@toumorokoshi](https://github.com/toumorokoshi) | Google |
10-
| [Mak Ahmad](mailto:mak1@fb.com) | [@makahmad](https://github.com/makahmad) | Meta |
11-
| Richard Frankel | [@rofrankel](https://github.com/rofrankel) | Roblox |
12-
| Dan Hudlow | [@hudlow](https://github.com/hudlow) | IBM |
13-
| Alfred Fuller | [@alfus](https://github.com/alfus) | |
14-
| Jeff Albert | [@monkey-jeff](https://github.com/monkey-jeff) | Salesforce |
15-
| Mike Kistler | [@mkistler](https://github.com/mkistler) | Microsoft |
16-
| Richard Gibson | [@gibson042](https://github.com/gibson042) | Algoric |
17-
| [David Ebbo](mailto:davidebbo@google.com) | [@davidebbo](https://github.com/davidebbo) | Google |
18-
| [Sam Woodard](mailto:samwoodard@google.com) | [@shwoodard](https://github.com/shwoodard) | Google |
19-
| JJ Geewax | [@jgeewax](https://github.com/jgeewax) | Meta |
8+
| Name | GitHub | Organization |
9+
| ------------------- | ------------------------------------------------ | ------------ |
10+
| [Yusuke Tsutsumi][] | [@toumorokoshi](https://github.com/toumorokoshi) | Google |
11+
| [Mak Ahmad][] | [@makahmad](https://github.com/makahmad) | |
12+
| Richard Frankel | [@rofrankel](https://github.com/rofrankel) | Roblox |
13+
| Dan Hudlow | [@hudlow](https://github.com/hudlow) | IBM |
14+
| Alfred Fuller | [@alfus](https://github.com/alfus) | Buf |
15+
| Jeff Albert | [@monkey-jeff](https://github.com/monkey-jeff) | Salesforce |
16+
| Mike Kistler | [@mkistler](https://github.com/mkistler) | Microsoft |
17+
| Richard Gibson | [@gibson042](https://github.com/gibson042) | Algoric |
18+
| [David Ebbo][] | [@davidebbo](https://github.com/davidebbo) | Google |
19+
| [Sam Woodard][] | [@shwoodard](https://github.com/shwoodard) | Google |
20+
| JJ Geewax | [@jgeewax](https://github.com/jgeewax) | Meta |
2021

2122
## Emiritus
2223

2324
The following table enumerates previous maintainers of the aip.dev standard.
2425

25-
| Name | GitHub | Organization (if applicable) |
26-
| --------------- | ---------------------------------------------------- | ---------------------------- |
27-
| Luke Sneeringer | [@lukesneeringer](https://github.com/lukesneeringer) | |
26+
| Name | GitHub | Organization |
27+
| --------------- | ---------------------------------------------------- | ------------ |
28+
| Luke Sneeringer | [@lukesneeringer](https://github.com/lukesneeringer) | |
29+
30+
[David Ebbo]: mailto:davidebbo@google.com
31+
[Mak Ahmad]: mailto:mak1@fb.com
32+
[Sam Woodard]: mailto:samwoodard@google.com
33+
[Yusuke Tsutsumi]: mailto:yusuketsutsumi@google.com

‎README.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,10 @@ AIPs for others to follow.
4848
If you'd like to get involved in the AIP community, we'd love to have you! The
4949
following channels of communication are available:
5050

51-
- [The #aip channel in the CNCF
52-
Slack](https://cloud-native.slack.com/archives/C04TX46UCTV). Sign up at https://slack.cncf.io.
51+
- [The #aip channel in the CNCF Slack](https://cloud-native.slack.com/archives/C04TX46UCTV).
52+
Sign up at https://slack.cncf.io.
5353
- [The AIP Google Calendar, to view any upcoming meetings](https://calendar.google.com/calendar/u/0?cid=N2UzNWRkM2RmMTk0YTMyZjRmYTdjMDNhMzQ1NGUyNGJhMzY1MWU2ZjU2ODI0OGVmZTFkZGYxZTM0YTdiZWU5ZUBncm91cC5jYWxlbmRhci5nb29nbGUuY29t).
54-
- [The AIP Community Meeting, for general topics, those who want to introduce
55-
themselves, or want to learn more about the AIPs](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NXRiMmMxcTRoY2hnbG51ZGpnN2kyZHBqbjlfMjAyMzA0MTlUMTYwMDAwWiA3ZTM1ZGQzZGYxOTRhMzJmNGZhN2MwM2EzNDU0ZTI0YmEzNjUxZTZmNTY4MjQ4ZWZlMWRkZjFlMzRhN2JlZTllQGc&tmsrc=7e35dd3df194a32f4fa7c03a3454e24ba3651e6f568248efe1ddf1e34a7bee9e%40group.calendar.google.com&scp=ALL).
56-
54+
- [The AIP Community Meeting, for general topics, those who want to introduce themselves, or want to learn more about the AIPs](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NXRiMmMxcTRoY2hnbG51ZGpnN2kyZHBqbjlfMjAyMzA0MTlUMTYwMDAwWiA3ZTM1ZGQzZGYxOTRhMzJmNGZhN2MwM2EzNDU0ZTI0YmEzNjUxZTZmNTY4MjQ4ZWZlMWRkZjFlMzRhN2JlZTllQGc&tmsrc=7e35dd3df194a32f4fa7c03a3454e24ba3651e6f568248efe1ddf1e34a7bee9e%40group.calendar.google.com&scp=ALL).
5755

5856
## License
5957

‎aip/general/0132/aip.md.j2‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ Accept: application/json
3030
- If a `GET` request contains a body, the body **must** be ignored, and
3131
**must not** cause an error.
3232
- The request **must not** require any fields in the query string.
33-
- The query string **may** include fields for common design patterns
34-
relevant to list methods, such as `string filter` and `string orderBy`.
33+
- The query string **may** include fields for common design patterns relevant
34+
to list methods, such as `string filter` and `string orderBy`.
3535
- The query string **may** include custom fields if necessary for a specific
3636
resource, but not in place of any of the common fields for list methods.
3737

@@ -77,11 +77,11 @@ individual result being a resource:
7777

7878
**Note:** List methods **may** return the complete collection to any user with
7979
permission to make a successful List request on the collection, _or_ **may**
80-
return a collection only containing resources for which the user has read permission.
81-
This behavior **should** be clearly documented either for each List method or as
82-
a standard convention in service-level documentation. Permission checks on individual
83-
resources may have a negative performance impact so should be used only where
84-
absolutely necessary.
80+
return a collection only containing resources for which the user has read
81+
permission. This behavior **should** be clearly documented either for each List
82+
method or as a standard convention in service-level documentation. Permission
83+
checks on individual resources may have a negative performance impact so should
84+
be used only where absolutely necessary.
8585

8686
### Errors
8787

‎aip/general/0151/aip.md.j2‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -160,24 +160,25 @@ what this document describes as a `StatusMonitor`.
160160
{% sample 'lro.oas.yaml', 'paths' %}
161161

162162
- `202` **must** be the only success status code defined.
163-
- The `202` response **must** define an `application/json` response body and no other
164-
response content types.
165-
- The response body schema **must** be an object with `name`, `done`, and `result`
166-
properties as described above for a StatusMonitor
167-
- The response body schema **may** contain an object property named `metadata` to
168-
hold service-specific metadata associated with the operation, for example progress
169-
information and common metadata such as create time. The service **should** define
170-
the contents of the `metadata` object in a separate schema, which **should** specify
171-
`additionalProperties: true` to allow for future extensibility.
163+
- The `202` response **must** define an `application/json` response body and no
164+
other response content types.
165+
- The response body schema **must** be an object with `name`, `done`, and
166+
`result` properties as described above for a StatusMonitor
167+
- The response body schema **may** contain an object property named `metadata`
168+
to hold service-specific metadata associated with the operation, for example
169+
progress information and common metadata such as create time. The service
170+
**should** define the contents of the `metadata` object in a separate schema,
171+
which **should** specify `additionalProperties: true` to allow for future
172+
extensibility.
172173
- The `response` property **must** be a schema that defines the success
173-
response for the operation. For an operation that typically gives a `204 No Content`
174-
response, such as a `Delete`, `response` should be defined as an empty object schema.
175-
For a standard `Get/Create/Update` operation, `response` should be a representation
176-
of the resource.
174+
response for the operation. For an operation that typically gives a
175+
`204 No Content` response, such as a `Delete`, `response` should be defined
176+
as an empty object schema. For a standard `Get/Create/Update` operation,
177+
`response` should be a representation of the resource.
177178
- If a service has any long running operations, the service **must** define an
178-
`StatusMonitor` resource with a `list` operation to retrieve a potentially filtered
179-
list of status monitors and a `get` operation to retrieve a specific status monitor
180-
by its `name`.
179+
`StatusMonitor` resource with a `list` operation to retrieve a potentially
180+
filtered list of status monitors and a `get` operation to retrieve a specific
181+
status monitor by its `name`.
181182

182183
{% endtabs %}
183184

0 commit comments

Comments
 (0)