Skip to content

Commit

Permalink
feat: add schema evolution methods and fields (#1672)
Browse files Browse the repository at this point in the history 
* feat: add schema evolution methods and fields

PiperOrigin-RevId: 500819578

Source-Link: googleapis/googleapis@05a375f

Source-Link: googleapis/googleapis-gen@303c959
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMzAzYzk1OTJjNDk4ZGMwMjQzMmRhYTI5YWNiNDZkNjdkZWNmYjBjMiJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Jan 10, 2023
1 parent e6369ae commit 7a5bc29
Show file tree
Hide file tree
Showing 14 changed files with 3,646 additions and 59 deletions.
4 changes: 2 additions & 2 deletions .jsdoc.js
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2022 Google LLC
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -40,7 +40,7 @@ module.exports = {
includePattern: '\\.js$'
},
templates: {
copyright: 'Copyright 2022 Google LLC',
copyright: 'Copyright 2023 Google LLC',
includeDate: false,
sourceFiles: false,
systemName: '@google-cloud/pubsub',
Expand Down
10 changes: 10 additions & 0 deletions protos/google/pubsub/v1/pubsub.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,16 @@ message SchemaSettings {

// The encoding of messages validated against `schema`.
Encoding encoding = 2;

// The minimum (inclusive) revision allowed for validating messages. If empty
// or not present, allow any revision to be validated against last_revision or
// any revision created before.
string first_revision_id = 3;

// The maximum (inclusive) revision allowed for validating messages. If empty
// or not present, allow any revision to be validated against first_revision
// or any revision created after.
string last_revision_id = 4;
}

// A topic resource.
Expand Down
154 changes: 138 additions & 16 deletions protos/google/pubsub/v1/schema.proto
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2021 Google LLC
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -21,6 +21,7 @@ import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";

option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.PubSub.V1";
Expand Down Expand Up @@ -63,6 +64,41 @@ service SchemaService {
option (google.api.method_signature) = "parent";
}

// Lists all schema revisions for the named schema.
rpc ListSchemaRevisions(ListSchemaRevisionsRequest)
returns (ListSchemaRevisionsResponse) {
option (google.api.http) = {
get: "/v1/{name=projects/*/schemas/*}:listRevisions"
};
option (google.api.method_signature) = "name";
}

// Commits a new schema revision to an existing schema.
rpc CommitSchema(CommitSchemaRequest) returns (Schema) {
option (google.api.http) = {
post: "/v1/{name=projects/*/schemas/*}:commit"
body: "*"
};
option (google.api.method_signature) = "name,schema";
}

// Creates a new schema revision that is a copy of the provided revision_id.
rpc RollbackSchema(RollbackSchemaRequest) returns (Schema) {
option (google.api.http) = {
post: "/v1/{name=projects/*/schemas/*}:rollback"
body: "*"
};
option (google.api.method_signature) = "name,revision_id";
}

// Deletes a specific schema revision.
rpc DeleteSchemaRevision(DeleteSchemaRevisionRequest) returns (Schema) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/schemas/*}:deleteRevision"
};
option (google.api.method_signature) = "name,revision_id";
}

// Deletes a schema.
rpc DeleteSchema(DeleteSchemaRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
Expand Down Expand Up @@ -120,6 +156,29 @@ message Schema {
// the full definition of the schema that is a valid schema definition of
// the type specified in `type`.
string definition = 3;

// Output only. Immutable. The revision ID of the schema.
string revision_id = 4 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.field_behavior) = OUTPUT_ONLY
];

// Output only. The timestamp that the revision was created.
google.protobuf.Timestamp revision_create_time = 6
[(google.api.field_behavior) = OUTPUT_ONLY];
}

// View of Schema object fields to be returned by GetSchema and ListSchemas.
enum SchemaView {
// The default / unset value.
// The API will default to the BASIC view.
SCHEMA_VIEW_UNSPECIFIED = 0;

// Include the name and type of the schema, but not the definition.
BASIC = 1;

// Include all Schema object fields.
FULL = 2;
}

// Request for the CreateSchema method.
Expand Down Expand Up @@ -148,19 +207,6 @@ message CreateSchemaRequest {
string schema_id = 3;
}

// View of Schema object fields to be returned by GetSchema and ListSchemas.
enum SchemaView {
// The default / unset value.
// The API will default to the BASIC view.
SCHEMA_VIEW_UNSPECIFIED = 0;

// Include the name and type of the schema, but not the definition.
BASIC = 1;

// Include all Schema object fields.
FULL = 2;
}

// Request for the GetSchema method.
message GetSchemaRequest {
// Required. The name of the schema to get.
Expand All @@ -171,8 +217,7 @@ message GetSchemaRequest {
];

// The set of fields to return in the response. If not set, returns a Schema
// with `name` and `type`, but not `definition`. Set to `FULL` to retrieve all
// fields.
// with all fields filled out. Set to `BASIC` to omit the `definition`.
SchemaView view = 2;
}

Expand Down Expand Up @@ -211,6 +256,83 @@ message ListSchemasResponse {
string next_page_token = 2;
}

// Request for the `ListSchemaRevisions` method.
message ListSchemaRevisionsRequest {
// Required. The name of the schema to list revisions for.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { type: "pubsub.googleapis.com/Schema" }
];

// The set of Schema fields to return in the response. If not set, returns
// Schemas with `name` and `type`, but not `definition`. Set to `FULL` to
// retrieve all fields.
SchemaView view = 2;

// The maximum number of revisions to return per page.
int32 page_size = 3;

// The page token, received from a previous ListSchemaRevisions call.
// Provide this to retrieve the subsequent page.
string page_token = 4;
}

// Response for the `ListSchemaRevisions` method.
message ListSchemaRevisionsResponse {
// The revisions of the schema.
repeated Schema schemas = 1;

// A token that can be sent as `page_token` to retrieve the next page.
// If this field is empty, there are no subsequent pages.
string next_page_token = 2;
}

// Request for CommitSchema method.
message CommitSchemaRequest {
// Required. The name of the schema we are revising.
// Format is `projects/{project}/schemas/{schema}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { type: "pubsub.googleapis.com/Schema" }
];

// Required. The schema revision to commit.
Schema schema = 2 [(google.api.field_behavior) = REQUIRED];
}

// Request for the `RollbackSchema` method.
message RollbackSchemaRequest {
// Required. The schema being rolled back with revision id.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { type: "pubsub.googleapis.com/Schema" }
];

// Required. The revision ID to roll back to.
// It must be a revision of the same schema.
//
// Example: c7cfa2a8
string revision_id = 2 [(google.api.field_behavior) = REQUIRED];
}

// Request for the `DeleteSchemaRevision` method.
message DeleteSchemaRevisionRequest {
// Required. The name of the schema revision to be deleted, with a revision ID
// explicitly included.
//
// Example: projects/123/schemas/my-schema@c7cfa2a8
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { type: "pubsub.googleapis.com/Schema" }
];

// Required. The revision ID to roll back to.
// It must be a revision of the same schema.
//
// Example: c7cfa2a8
string revision_id = 2 [(google.api.field_behavior) = REQUIRED];
}

// Request for the `DeleteSchema` method.
message DeleteSchemaRequest {
// Required. Name of the schema to delete.
Expand Down

0 comments on commit 7a5bc29

Please sign in to comment.