From 50eaceda5eabc5970effe491f0d58194852718c9 Mon Sep 17 00:00:00 2001 From: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com> Date: Wed, 8 Sep 2021 09:57:04 -0700 Subject: [PATCH] docs: fix ecocredit proto comments (#522) --- client/docs/swagger-ui/swagger.yaml | 14 +++++++------- proto/regen/ecocredit/v1alpha1/tx.proto | 6 ++---- proto/regen/ecocredit/v1alpha1/types.proto | 2 +- x/ecocredit/spec/protobuf.md | 6 +++--- x/ecocredit/tx.pb.go | 6 ++---- x/ecocredit/types.pb.go | 2 +- 6 files changed, 16 insertions(+), 20 deletions(-) diff --git a/client/docs/swagger-ui/swagger.yaml b/client/docs/swagger-ui/swagger.yaml index fcb2f20bc4..4e4a34a662 100644 --- a/client/docs/swagger-ui/swagger.yaml +++ b/client/docs/swagger-ui/swagger.yaml @@ -872,9 +872,9 @@ paths: class_id: type: string description: class_id is the unique ID of credit class. - designer: + admin: type: string - description: designer is the designer of the credit class. + description: admin is the admin of the credit class. issuers: type: array items: @@ -27961,7 +27961,7 @@ definitions: metadata: type: string format: byte - description: metadata is any arbitrary metadata to attached to the credit batch. + description: metadata is any arbitrary metadata attached to the credit batch. amount_cancelled: type: string description: >- @@ -28005,9 +28005,9 @@ definitions: class_id: type: string description: class_id is the unique ID of credit class. - designer: + admin: type: string - description: designer is the designer of the credit class. + description: admin is the admin of the credit class. issuers: type: array items: @@ -28115,9 +28115,9 @@ definitions: class_id: type: string description: class_id is the unique ID of credit class. - designer: + admin: type: string - description: designer is the designer of the credit class. + description: admin is the admin of the credit class. issuers: type: array items: diff --git a/proto/regen/ecocredit/v1alpha1/tx.proto b/proto/regen/ecocredit/v1alpha1/tx.proto index a76a8df6b5..5aa2b5e625 100644 --- a/proto/regen/ecocredit/v1alpha1/tx.proto +++ b/proto/regen/ecocredit/v1alpha1/tx.proto @@ -35,9 +35,7 @@ service Msg { // MsgCreateClass is the Msg/CreateClass request type. message MsgCreateClass { - // admin is the address of the account which can manage the credit class. The - // admin has permissions to change the list of issuers and perform other - // administrative operations. + // admin is the address of the account that created the credit class. string admin = 1; // issuers are the account addresses of the approved issuers. @@ -69,7 +67,7 @@ message MsgCreateBatch { // issuance are the credits issued in the batch. repeated BatchIssuance issuance = 3; - // metadata is any arbitrary metadata to attached to the credit batch. + // metadata is any arbitrary metadata attached to the credit batch. bytes metadata = 4; // start_date is the beginning of the period during which this credit batch diff --git a/proto/regen/ecocredit/v1alpha1/types.proto b/proto/regen/ecocredit/v1alpha1/types.proto index a09430e317..37878db0e4 100644 --- a/proto/regen/ecocredit/v1alpha1/types.proto +++ b/proto/regen/ecocredit/v1alpha1/types.proto @@ -49,7 +49,7 @@ message BatchInfo { // were issued. string total_amount = 4; - // metadata is any arbitrary metadata to attached to the credit batch. + // metadata is any arbitrary metadata attached to the credit batch. bytes metadata = 5; // amount_cancelled is the number of credits in the batch that have been diff --git a/x/ecocredit/spec/protobuf.md b/x/ecocredit/spec/protobuf.md index 87694361e5..8c9acb396a 100644 --- a/x/ecocredit/spec/protobuf.md +++ b/x/ecocredit/spec/protobuf.md @@ -194,7 +194,7 @@ BatchInfo represents the high-level on-chain information for a credit batch. | batch_denom | [string](#string) | | batch_denom is the unique ID of credit batch. | | issuer | [string](#string) | | issuer is the issuer of the credit batch. | | total_amount | [string](#string) | | total_amount is the total number of active credits in the credit batch. Some of the issued credits may be cancelled and will be removed from total_amount and tracked in amount_cancelled. total_amount and amount_cancelled will always sum to the original amount of credits that were issued. | -| metadata | [bytes](#bytes) | | metadata is any arbitrary metadata to attached to the credit batch. | +| metadata | [bytes](#bytes) | | metadata is any arbitrary metadata attached to the credit batch. | | amount_cancelled | [string](#string) | | amount_cancelled is the number of credits in the batch that have been cancelled, effectively undoing there issuance. The sum of total_amount and amount_cancelled will always sum to the original amount of credits that were issued. | | start_date | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | start_date is the beginning of the period during which this credit batch was quantified and verified. | | end_date | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | end_date is the end of the period during which this credit batch was quantified and verified. | @@ -664,7 +664,7 @@ MsgCreateBatch is the Msg/CreateBatch request type. | issuer | [string](#string) | | issuer is the address of the batch issuer. | | class_id | [string](#string) | | class_id is the unique ID of the class. | | issuance | [MsgCreateBatch.BatchIssuance](#regen.ecocredit.v1alpha1.MsgCreateBatch.BatchIssuance) | repeated | issuance are the credits issued in the batch. | -| metadata | [bytes](#bytes) | | metadata is any arbitrary metadata to attached to the credit batch. | +| metadata | [bytes](#bytes) | | metadata is any arbitrary metadata attached to the credit batch. | | start_date | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | start_date is the beginning of the period during which this credit batch was quantified and verified. | | end_date | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | end_date is the end of the period during which this credit batch was quantified and verified. | | project_location | [string](#string) | | project_location is the location of the project backing the credits in this batch. It is a string of the form [-[ ]], with the first two fields conforming to ISO 3166-2, and postal-code being up to 64 alphanumeric characters. country-code is required, while sub-national-code and postal-code can be added for increasing precision. | @@ -716,7 +716,7 @@ MsgCreateClass is the Msg/CreateClass request type. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| admin | [string](#string) | | admin is the address of the account which can manage the credit class. The admin has permissions to change the list of issuers and perform other administrative operations. | +| admin | [string](#string) | | admin is the address of the account that created the credit class. | | issuers | [string](#string) | repeated | issuers are the account addresses of the approved issuers. | | metadata | [bytes](#bytes) | | metadata is any arbitrary metadata to attached to the credit class. | | credit_type_name | [string](#string) | | credit_type_name describes the type of credit (e.g. "carbon", "biodiversity"). | diff --git a/x/ecocredit/tx.pb.go b/x/ecocredit/tx.pb.go index 46cd084db7..2176634164 100644 --- a/x/ecocredit/tx.pb.go +++ b/x/ecocredit/tx.pb.go @@ -34,9 +34,7 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // MsgCreateClass is the Msg/CreateClass request type. type MsgCreateClass struct { - // admin is the address of the account which can manage the credit class. The - // admin has permissions to change the list of issuers and perform other - // administrative operations. + // admin is the address of the account that created the credit class. Admin string `protobuf:"bytes,1,opt,name=admin,proto3" json:"admin,omitempty"` // issuers are the account addresses of the approved issuers. Issuers []string `protobuf:"bytes,2,rep,name=issuers,proto3" json:"issuers,omitempty"` @@ -161,7 +159,7 @@ type MsgCreateBatch struct { ClassId string `protobuf:"bytes,2,opt,name=class_id,json=classId,proto3" json:"class_id,omitempty"` // issuance are the credits issued in the batch. Issuance []*MsgCreateBatch_BatchIssuance `protobuf:"bytes,3,rep,name=issuance,proto3" json:"issuance,omitempty"` - // metadata is any arbitrary metadata to attached to the credit batch. + // metadata is any arbitrary metadata attached to the credit batch. Metadata []byte `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"` // start_date is the beginning of the period during which this credit batch // was quantified and verified. diff --git a/x/ecocredit/types.pb.go b/x/ecocredit/types.pb.go index 7386e3cebc..ba1743dc68 100644 --- a/x/ecocredit/types.pb.go +++ b/x/ecocredit/types.pb.go @@ -134,7 +134,7 @@ type BatchInfo struct { // amount_cancelled will always sum to the original amount of credits that // were issued. TotalAmount string `protobuf:"bytes,4,opt,name=total_amount,json=totalAmount,proto3" json:"total_amount,omitempty"` - // metadata is any arbitrary metadata to attached to the credit batch. + // metadata is any arbitrary metadata attached to the credit batch. Metadata []byte `protobuf:"bytes,5,opt,name=metadata,proto3" json:"metadata,omitempty"` // amount_cancelled is the number of credits in the batch that have been // cancelled, effectively undoing there issuance. The sum of total_amount and