Merge pull request #775 from kaleido-io/approval

Clean up API spec for token approvals
hyperledger · Apr 29, 2022 · 4de43ef · 4de43ef
2 parents ea38e01 + fe60004
commit 4de43ef
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 35 deletions.
diff --git a/docs/swagger/swagger.yaml b/docs/swagger/swagger.yaml
@@ -10367,10 +10367,6 @@ paths:
                       description: A string identifying the parties and entities in
                         the scope of this approval, as provided by the token connector
                       type: string
-                    tokenIndex:
-                      description: The index of the token within the pool that this
-                        approval applies to
-                      type: string
                     tx:
                       description: If submitted via FireFly, this will reference the
                         UUID of the FireFly transaction (if the token connector in
@@ -10431,37 +10427,18 @@ paths:
                     of the approval.  See your chosen token connector documentation
                     for details
                   type: object
-                info:
-                  additionalProperties:
-                    description: Token connector specific information about the approval
-                      operation, such as whether it applied to a limited balance of
-                      a fungible token. See your chosen token connector documentation
-                      for details
-                  description: Token connector specific information about the approval
-                    operation, such as whether it applied to a limited balance of
-                    a fungible token. See your chosen token connector documentation
-                    for details
-                  type: object
                 key:
                   description: The blockchain signing key for the approval request.
                     On input defaults to the first signing key of the organization
                     that operates the node
                   type: string
-                namespace:
-                  description: The namespace for the approval, which must match the
-                    namespace of the token pool
-                  type: string
                 operator:
                   description: The blockchain identity that is granted the approval
                   type: string
                 pool:
                   description: The UUID the token pool this approval applies to
                   format: uuid
                   type: string
-                tokenIndex:
-                  description: The index of the token within the pool that this approval
-                    applies to
-                  type: string
               type: object
       responses:
         "200":
@@ -10531,10 +10508,6 @@ paths:
                     description: A string identifying the parties and entities in
                       the scope of this approval, as provided by the token connector
                     type: string
-                  tokenIndex:
-                    description: The index of the token within the pool that this
-                      approval applies to
-                    type: string
                   tx:
                     description: If submitted via FireFly, this will reference the
                       UUID of the FireFly transaction (if the token connector in use
@@ -10617,10 +10590,6 @@ paths:
                     description: A string identifying the parties and entities in
                       the scope of this approval, as provided by the token connector
                     type: string
-                  tokenIndex:
-                    description: The index of the token within the pool that this
-                      approval applies to
-                    type: string
                   tx:
                     description: If submitted via FireFly, this will reference the
                       UUID of the FireFly transaction (if the token connector in use

diff --git a/internal/coremsgs/en_struct_descriptions.go b/internal/coremsgs/en_struct_descriptions.go
@@ -476,7 +476,6 @@ var (
 	// TokenApproval field descriptions
 	TokenApprovalLocalID         = ffm("TokenApproval.localId", "The UUID of this token approval, in the local FireFly node")
 	TokenApprovalPool            = ffm("TokenApproval.pool", "The UUID the token pool this approval applies to")
-	TokenApprovalTokenIndex      = ffm("TokenApproval.tokenIndex", "The index of the token within the pool that this approval applies to")
 	TokenApprovalConnector       = ffm("TokenApproval.connector", "The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured")
 	TokenApprovalKey             = ffm("TokenApproval.key", "The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node")
 	TokenApprovalOperator        = ffm("TokenApproval.operator", "The blockchain identity that is granted the approval")

diff --git a/pkg/fftypes/tokenapproval.go b/pkg/fftypes/tokenapproval.go
@@ -24,13 +24,12 @@ type TokenApprovalInput struct {
 type TokenApproval struct {
 	LocalID         *UUID          `ffstruct:"TokenApproval" json:"localId,omitempty" ffexcludeinput:"true"`
 	Pool            *UUID          `ffstruct:"TokenApproval" json:"pool,omitempty"`
-	TokenIndex      string         `ffstruct:"TokenApproval" json:"tokenIndex,omitempty"`
 	Connector       string         `ffstruct:"TokenApproval" json:"connector,omitempty" ffexcludeinput:"true"`
 	Key             string         `ffstruct:"TokenApproval" json:"key,omitempty"`
 	Operator        string         `ffstruct:"TokenApproval" json:"operator,omitempty"`
 	Approved        bool           `ffstruct:"TokenApproval" json:"approved"`
-	Info            JSONObject     `ffstruct:"TokenApproval" json:"info,omitempty"`
-	Namespace       string         `ffstruct:"TokenApproval" json:"namespace,omitempty"`
+	Info            JSONObject     `ffstruct:"TokenApproval" json:"info,omitempty" ffexcludeinput:"true"`
+	Namespace       string         `ffstruct:"TokenApproval" json:"namespace,omitempty" ffexcludeinput:"true"`
 	ProtocolID      string         `ffstruct:"TokenApproval" json:"protocolId,omitempty" ffexcludeinput:"true"`
 	Subject         string         `ffstruct:"TokenApproval" json:"subject,omitempty" ffexcludeinput:"true"`
 	Active          bool           `ffstruct:"TokenApproval" json:"active,omitempty" ffexcludeinput:"true"`