Skip to content

Commit

Permalink
docs: Update the table format in SearchProjects docs
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 528006710
  • Loading branch information
Google APIs authored and Copybara-Service committed Apr 28, 2023
1 parent 7e5b098 commit f373a9c
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 27 deletions.
46 changes: 20 additions & 26 deletions google/cloud/resourcemanager/v3/projects.proto
Original file line number Diff line number Diff line change
Expand Up @@ -460,37 +460,31 @@ message SearchProjectsRequest {
// included in the query, then it will return results that match any of the
// fields. Some eligible fields are:
//
// ```
// | Field | Description |
// |-------------------------|----------------------------------------------|
// | displayName, name | Filters by displayName. |
// | parent | Project's parent (for example: folders/123,
// organizations/*). Prefer parent field over parent.type and parent.id.| |
// parent.type | Parent's type: `folder` or `organization`. | |
// parent.id | Parent's id number (for example: 123) | |
// id, projectId | Filters by projectId. | |
// state, lifecycleState | Filters by state. | |
// labels | Filters by label name or value. | |
// labels.\<key\> (where *key* is the name of a label) | Filters by label
// name.|
// ```
// - **`displayName`, `name`**: Filters by displayName.
// - **`parent`**: Project's parent (for example: `folders/123`,
// `organizations/*`). Prefer `parent` field over `parent.type` and
// `parent.id`.
// - **`parent.type`**: Parent's type: `folder` or `organization`.
// - **`parent.id`**: Parent's id number (for example: `123`).
// - **`id`, `projectId`**: Filters by projectId.
// - **`state`, `lifecycleState`**: Filters by state.
// - **`labels`**: Filters by label name or value.
// - **`labels.<key>` (where `<key>` is the name of a label)**: Filters by label
// name.
//
// Search expressions are case insensitive.
//
// Some examples queries:
//
// ```
// | Query | Description |
// |------------------|-----------------------------------------------------|
// | name:how* | The project's name starts with "how". |
// | name:Howl | The project's name is `Howl` or `howl`. |
// | name:HOWL | Equivalent to above. |
// | NAME:howl | Equivalent to above. |
// | labels.color:* | The project has the label `color`. |
// | labels.color:red | The project's label `color` has the value `red`. |
// | labels.color:red labels.size:big | The project's label `color` has the
// value `red` or its label `size` has the value `big`. |
// ```
//
// - **`name:how*`**: The project's name starts with "how".
// - **`name:Howl`**: The project's name is `Howl` or `howl`.
// - **`name:HOWL`**: Equivalent to above.
// - **`NAME:howl`**: Equivalent to above.
// - **`labels.color:*`**: The project has the label `color`.
// - **`labels.color:red`**: The project's label `color` has the value `red`.
// - **`labels.color:red labels.size:big`**: The project's label `color` has
// the value `red` or its label `size` has the value `big`.
//
// If no query is specified, the call will return projects for which the user
// has the `resourcemanager.projects.get` permission.
Expand Down
1 change: 0 additions & 1 deletion google/cloud/resourcemanager/v3/tag_keys.proto
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,6 @@ message DeleteTagKeyRequest {
// Runtime operation information for deleting a TagKey.
message DeleteTagKeyMetadata {}

//
// A purpose for each policy engine requiring such an integration. A single
// policy engine may have multiple purposes defined, however a TagKey may only
// specify a single purpose.
Expand Down

0 comments on commit f373a9c

Please sign in to comment.