Skip to content

Use consistent "update" verbs in our API based on the underlying RPC (PUT/PATCH). #321

Closed
@aozarov

Description

@aozarov

When it comes to metadata, some apiary libraries provide "patch" operations, some provide "update" and others provide both.

In GCS API we picked the verb "update" for PATCH operation and we don't provide a "replace"/PUT
(which exists now in the apiary world but is probably going to be removed for gRPC).

I would like to avoid confusion when using different services, and suggests we always use the same
verb for metadata "patch" operations and a different one for metadata "replace" operations.

Some options for API names:

Patch RPC Update RPC
1 patch update
2 patch put
3 update replace
4 update set
5 update put

Other options are welcomed.

gRPC does not provide the apiary level PATCH support (it is up to the service), and One Platform
suggests to use HTTP PATCH for update operations that are partial or non-idempotent.

My preference is option (3)

/cc @mziccard @ajkannan @jgeewax

Metadata

Metadata

Assignees

Labels

type: questionRequest for information or clarification. Not an issue.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions