From 0480a446440670d35421278c1632850e2dcccbb1 Mon Sep 17 00:00:00 2001 From: bufdev Date: Wed, 23 Oct 2024 18:39:02 -0400 Subject: [PATCH] Remove Doc type and update PluginInfo --- buf/plugin/info/v1/doc.proto | 34 ---------------------------- buf/plugin/info/v1/license.proto | 2 +- buf/plugin/info/v1/plugin_info.proto | 13 +++-------- 3 files changed, 4 insertions(+), 45 deletions(-) delete mode 100644 buf/plugin/info/v1/doc.proto diff --git a/buf/plugin/info/v1/doc.proto b/buf/plugin/info/v1/doc.proto deleted file mode 100644 index ede476d..0000000 --- a/buf/plugin/info/v1/doc.proto +++ /dev/null @@ -1,34 +0,0 @@ -// Copyright 2024 Buf Technologies, Inc. -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -syntax = "proto3"; - -package buf.plugin.info.v1; - -import "buf/validate/validate.proto"; - -option go_package = "buf.build/gen/go/bufbuild/bufplugin/protocolbuffers/go/buf/plugin/info/v1"; - -// Documentation for a plugin. -message Doc { - // A short string describing the plugin. - // - // This is required. - string short = 1 [(buf.validate.field).required = true]; - // A long string providing more details on using the plugin. - // - // When producing documentation for the plugin, this will be concatenated with - // the value from short with a newline separating short and long. - string long = 2; -} diff --git a/buf/plugin/info/v1/license.proto b/buf/plugin/info/v1/license.proto index ac9cd45..d543064 100644 --- a/buf/plugin/info/v1/license.proto +++ b/buf/plugin/info/v1/license.proto @@ -32,7 +32,7 @@ message License { // The raw text of the license. string text = 2; - // The url that contains the license + // The url that contains the license. string url = 3 [ (buf.validate.field).ignore = IGNORE_IF_UNPOPULATED, (buf.validate.field).string.uri = true diff --git a/buf/plugin/info/v1/plugin_info.proto b/buf/plugin/info/v1/plugin_info.proto index d2438db..4e8df7e 100644 --- a/buf/plugin/info/v1/plugin_info.proto +++ b/buf/plugin/info/v1/plugin_info.proto @@ -16,23 +16,16 @@ syntax = "proto3"; package buf.plugin.info.v1; -import "buf/plugin/info/v1/doc.proto"; import "buf/plugin/info/v1/license.proto"; -import "buf/validate/validate.proto"; option go_package = "buf.build/gen/go/bufbuild/bufplugin/protocolbuffers/go/buf/plugin/info/v1"; // Information about a plugin. message PluginInfo { - // The url for the plugin. + // A long string providing more details on using the plugin. // - // This typically is the source control repository that contains the plugin's implementation. - string url = 1 [ - (buf.validate.field).ignore = IGNORE_IF_UNPOPULATED, - (buf.validate.field).string.uri = true - ]; + // This is equivalent to a README.md in effect. + string documentation = 1; // The license of the plugin. License license = 2; - // Documentation for a plugin. - Doc doc = 3; }