Skip to content

Commit bc5a961

Browse files
authored
List common packages that are org-specific or non-conformant (#1157)
Fixes #1142
1 parent 842e930 commit bc5a961

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

aip/general/0213.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ requirements, or be too complex for general use.
4141
`google.geo.type` or `google.shopping.type`.
4242
- Organizations **must** consult the API design team before creating a new
4343
organization-wide common component package.
44+
- Organization-wide common component packages **must** be published in [the
45+
`googleapis` repository](https://github.com/googleapis/googleapis).
46+
- Organizations creating and publishing a new organization-wide common component
47+
package **must** update this AIP to include it in the
48+
[list below](#existing-organization-specific-common-component-packages).
4449
- Organizations **must not** define generic components in organization-specific
4550
common component packages, instead preferring global common components.
4651
- Common components **must not** be "moved" (that is, deleted from one common
@@ -157,6 +162,37 @@ Occasionally, it may be useful to add protos to these packages or to add to the
157162
list of commonly-available protos. In order to do this, [open an issue][] on
158163
the AIP repository in GitHub, noting the guidelines above.
159164

165+
## Existing organization-specific common component packages
166+
167+
The following organization-specific common component packages exist and conform with the above guidance:
168+
169+
- [`google.apps.script.type`](https://github.com/googleapis/googleapis/tree/master/google/apps/script/type)
170+
Common component package for Google Apps Script.
171+
- [`google.geo.type`](https://github.com/googleapis/googleapis/tree/master/google/geo/type)
172+
Common component package for Google Maps and the Geo organization.
173+
- [`google.actions.type`](https://github.com/googleapis/googleapis/tree/master/google/actions/type)
174+
Common component package for Actions on Google APIs.
175+
176+
## Non-conformant common component packages
177+
178+
The following common component packages exist, but do not conform with the above guidance,
179+
and do not form a precedent for further such packages.
180+
181+
- [`google.cloud.common`](https://github.com/googleapis/googleapis/tree/master/google/cloud/common):
182+
This does not conform to the requirement for the package name to end in `.type`. (This would otherwise
183+
be acceptable, and this package should be considered as the Cloud common component package.)
184+
- [`google.logging.type`](https://github.com/googleapis/googleapis/tree/master/google/logging/type):
185+
This appears to be API-specific, although it's used from multiple APIs; some aspects should probably
186+
be global or in a Cloud common component package.
187+
- [`google.cloud.workflows.type`](https://github.com/googleapis/googleapis/tree/master/google/cloud/workflows/type):
188+
API-specific types.
189+
- [`google.cloud.oslogin.common`](https://github.com/googleapis/googleapis/tree/master/google/cloud/oslogin/common):
190+
API-specific types, and a non-conformant name.
191+
- [`google.identity.accesscontextmanager.type`](https://github.com/googleapis/googleapis/tree/master/google/identity/accesscontextmanager/type):
192+
API-specific types.
193+
- [`google.networking.trafficdirector.type`](https://github.com/googleapis/googleapis/tree/master/google/networking/trafficdirector/type):
194+
API-specific types.
195+
160196
## Rationale
161197

162198
Common components are effectively unversioned: APIs evolve independently of

0 commit comments

Comments
 (0)