Skip to content

Commit

Permalink
docs: fix ecocredit proto comments (#522)
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanchristo authored Sep 8, 2021
1 parent 8cae9dd commit 50eaced
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 20 deletions.
14 changes: 7 additions & 7 deletions client/docs/swagger-ui/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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: >-
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
6 changes: 2 additions & 4 deletions proto/regen/ecocredit/v1alpha1/tx.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion proto/regen/ecocredit/v1alpha1/types.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions x/ecocredit/spec/protobuf.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down Expand Up @@ -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 <country-code>[-<sub-national-code>[ <postal-code>]], 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. |
Expand Down Expand Up @@ -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"). |
Expand Down
6 changes: 2 additions & 4 deletions x/ecocredit/tx.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion x/ecocredit/types.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 50eaced

Please sign in to comment.