Merge pull request #1696 from onflow/peter/contracts-endpoints-results

Add result to contract deployments

Author: peterargue

openapi/experimental/go-client-generated/api/swagger.yaml

@@ -2347,6 +2347,7 @@ components:
           execution_effort: execution_effort
           transaction_handler_owner: transaction_handler_owner
           transaction_handler_uuid: transaction_handler_uuid
+          is_placeholder: true
           cancelled_transaction_id: null
           id: id
           executed_transaction_id: null
@@ -2357,14 +2358,16 @@ components:
             _links:
               _self: _self
             contract_id: contract_id
-            is_placeholder: true
             block_height: block_height
+            event_index: event_index
+            code_hash: code_hash
+            result: null
+            is_placeholder: true
             tx_index: tx_index
             _expandable:
               result: http://example.com/aeiou
+              code: http://example.com/aeiou
               transaction: http://example.com/aeiou
-            event_index: event_index
-            code_hash: code_hash
             transaction: null
           _expandable:
             result: http://example.com/aeiou
@@ -2454,6 +2457,7 @@ components:
           execution_effort: execution_effort
           transaction_handler_owner: transaction_handler_owner
           transaction_handler_uuid: transaction_handler_uuid
+          is_placeholder: true
           cancelled_transaction_id: null
           id: id
           executed_transaction_id: null
@@ -2464,14 +2468,16 @@ components:
             _links:
               _self: _self
             contract_id: contract_id
-            is_placeholder: true
             block_height: block_height
+            event_index: event_index
+            code_hash: code_hash
+            result: null
+            is_placeholder: true
             tx_index: tx_index
             _expandable:
               result: http://example.com/aeiou
+              code: http://example.com/aeiou
               transaction: http://example.com/aeiou
-            event_index: event_index
-            code_hash: code_hash
             transaction: null
           _expandable:
             result: http://example.com/aeiou
@@ -2588,6 +2594,11 @@ components:
           $ref: "#/components/schemas/Identifier"
         cancelled_transaction_id:
           $ref: "#/components/schemas/Identifier"
+        is_placeholder:
+          type: boolean
+          description: "True if the scheduled transaction was created during bootstrapping\
+            \ based on the current chain state, not based on a protocol event. When\
+            \ true, block_height, transaction_id, tx_index, and event_index are absent."
         transaction:
           $ref: "#/components/schemas/Transaction"
         result:
@@ -2630,6 +2641,7 @@ components:
         execution_effort: execution_effort
         transaction_handler_owner: transaction_handler_owner
         transaction_handler_uuid: transaction_handler_uuid
+        is_placeholder: true
         cancelled_transaction_id: null
         id: id
         executed_transaction_id: null
@@ -2640,14 +2652,16 @@ components:
           _links:
             _self: _self
           contract_id: contract_id
-          is_placeholder: true
           block_height: block_height
+          event_index: event_index
+          code_hash: code_hash
+          result: null
+          is_placeholder: true
           tx_index: tx_index
           _expandable:
             result: http://example.com/aeiou
+            code: http://example.com/aeiou
             transaction: http://example.com/aeiou
-          event_index: event_index
-          code_hash: code_hash
           transaction: null
         _expandable:
           result: http://example.com/aeiou
@@ -2729,7 +2743,6 @@ components:
       required:
       - _expandable
       - address
-      - code
       - code_hash
       - contract_id
       type: object
@@ -2767,6 +2780,8 @@ components:
             \ block_height, transaction_id, tx_index, and event_index are absent."
         transaction:
           $ref: "#/components/schemas/Transaction"
+        result:
+          $ref: "#/components/schemas/TransactionResult"
         _expandable:
           $ref: "#/components/schemas/ContractDeployment__expandable"
         _links:
@@ -2778,14 +2793,16 @@ components:
         _links:
           _self: _self
         contract_id: contract_id
-        is_placeholder: true
         block_height: block_height
+        event_index: event_index
+        code_hash: code_hash
+        result: null
+        is_placeholder: true
         tx_index: tx_index
         _expandable:
           result: http://example.com/aeiou
+          code: http://example.com/aeiou
           transaction: http://example.com/aeiou
-        event_index: event_index
-        code_hash: code_hash
         transaction: null
     ContractsResponse:
       required:
@@ -2807,29 +2824,33 @@ components:
           _links:
             _self: _self
           contract_id: contract_id
-          is_placeholder: true
           block_height: block_height
+          event_index: event_index
+          code_hash: code_hash
+          result: null
+          is_placeholder: true
           tx_index: tx_index
           _expandable:
             result: http://example.com/aeiou
+            code: http://example.com/aeiou
             transaction: http://example.com/aeiou
-          event_index: event_index
-          code_hash: code_hash
           transaction: null
         - transaction_id: null
           address: null
           code: ""
           _links:
             _self: _self
           contract_id: contract_id
-          is_placeholder: true
           block_height: block_height
+          event_index: event_index
+          code_hash: code_hash
+          result: null
+          is_placeholder: true
           tx_index: tx_index
           _expandable:
             result: http://example.com/aeiou
+            code: http://example.com/aeiou
             transaction: http://example.com/aeiou
-          event_index: event_index
-          code_hash: code_hash
           transaction: null
     ContractDeploymentsResponse:
       required:
@@ -2850,29 +2871,33 @@ components:
           _links:
             _self: _self
           contract_id: contract_id
-          is_placeholder: true
           block_height: block_height
+          event_index: event_index
+          code_hash: code_hash
+          result: null
+          is_placeholder: true
           tx_index: tx_index
           _expandable:
             result: http://example.com/aeiou
+            code: http://example.com/aeiou
             transaction: http://example.com/aeiou
-          event_index: event_index
-          code_hash: code_hash
           transaction: null
         - transaction_id: null
           address: null
           code: ""
           _links:
             _self: _self
           contract_id: contract_id
-          is_placeholder: true
           block_height: block_height
+          event_index: event_index
+          code_hash: code_hash
+          result: null
+          is_placeholder: true
           tx_index: tx_index
           _expandable:
             result: http://example.com/aeiou
+            code: http://example.com/aeiou
             transaction: http://example.com/aeiou
-          event_index: event_index
-          code_hash: code_hash
           transaction: null
         next_cursor: next_cursor
     Error:
@@ -2938,6 +2963,10 @@ components:
     ContractDeployment__expandable:
       type: object
       properties:
+        code:
+          type: string
+          description: Link to fetch the Cadence source code of this deployment.
+          format: uri
         transaction:
           type: string
           description: Link to fetch the full transaction that applied this deployment.
@@ -2951,6 +2980,7 @@ components:
         \ and is removed from `_expandable`."
       example:
         result: http://example.com/aeiou
+        code: http://example.com/aeiou
         transaction: http://example.com/aeiou
   parameters:
     cursorParam:

openapi/experimental/go-client-generated/docs/ContractDeployment.md

@@ -9,10 +9,11 @@ Name | Type | Description | Notes
 **TransactionId** | **string** |  | [optional] [default to null]
 **TxIndex** | **string** | Position of the deploying transaction within its block. | [optional] [default to null]
 **EventIndex** | **string** | Position of the contract event within its transaction. | [optional] [default to null]
-**Code** | **string** | Base64-encoded Cadence source code of the contract deployed. | [default to null]
+**Code** | **string** | Base64-encoded Cadence source code of the contract deployed. | [optional] [default to null]
 **CodeHash** | **string** | Hex-encoded SHA3-256 hash of the contract code. | [default to null]
 **IsPlaceholder** | **bool** | True if the deployment was created during bootstrapping based on the current chain state, not based on a protocol event. When true, block_height, transaction_id, tx_index, and event_index are absent. | [optional] [default to null]
 **Transaction** | [***Transaction**](Transaction.md) |  | [optional] [default to null]
+**Result** | [***TransactionResult**](TransactionResult.md) |  | [optional] [default to null]
 **Expandable** | [***ContractDeploymentExpandable**](ContractDeployment__expandable.md) |  | [default to null]
 **Links** | [***Links**](Links.md) |  | [optional] [default to null]
 

openapi/experimental/go-client-generated/docs/ContractDeploymentExpandable.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**Code** | **string** | Link to fetch the Cadence source code of this deployment. | [optional] [default to null]
 **Transaction** | **string** | Link to fetch the full transaction that applied this deployment. | [optional] [default to null]
 **Result** | **string** | Link to fetch the transaction result. | [optional] [default to null]
 

openapi/experimental/go-client-generated/docs/ScheduledTransaction.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **CreatedTransactionId** | **string** |  | [default to null]
 **ExecutedTransactionId** | **string** |  | [optional] [default to null]
 **CancelledTransactionId** | **string** |  | [optional] [default to null]
+**IsPlaceholder** | **bool** | True if the scheduled transaction was created during bootstrapping based on the current chain state, not based on a protocol event. When true, block_height, transaction_id, tx_index, and event_index are absent. | [optional] [default to null]
 **Transaction** | [***Transaction**](Transaction.md) |  | [optional] [default to null]
 **Result** | [***TransactionResult**](TransactionResult.md) |  | [optional] [default to null]
 **HandlerContract** | [***ContractDeployment**](ContractDeployment.md) |  | [optional] [default to null]

openapi/experimental/go-client-generated/model_contract_deployment.go

@@ -19,12 +19,13 @@ type ContractDeployment struct {
 	// Position of the contract event within its transaction.
 	EventIndex string `json:"event_index,omitempty"`
 	// Base64-encoded Cadence source code of the contract deployed.
-	Code string `json:"code"`
+	Code string `json:"code,omitempty"`
 	// Hex-encoded SHA3-256 hash of the contract code.
 	CodeHash string `json:"code_hash"`
 	// True if the deployment was created during bootstrapping based on the current chain state, not based on a protocol event. When true, block_height, transaction_id, tx_index, and event_index are absent.
 	IsPlaceholder bool `json:"is_placeholder,omitempty"`
 	Transaction *Transaction `json:"transaction,omitempty"`
+	Result *TransactionResult `json:"result,omitempty"`
 	Expandable *ContractDeploymentExpandable `json:"_expandable"`
 	Links *Links `json:"_links,omitempty"`
 }

openapi/experimental/go-client-generated/model_contract_deployment__expandable.go

@@ -10,6 +10,8 @@ package swagger
 
 // Contains URI links for fields not included in the response. When a field is expanded via the `expand` query parameter, it appears inline and is removed from `_expandable`.
 type ContractDeploymentExpandable struct {
+	// Link to fetch the Cadence source code of this deployment.
+	Code string `json:"code,omitempty"`
 	// Link to fetch the full transaction that applied this deployment.
 	Transaction string `json:"transaction,omitempty"`
 	// Link to fetch the transaction result.

openapi/experimental/go-client-generated/model_scheduled_transaction.go

@@ -33,6 +33,8 @@ type ScheduledTransaction struct {
 	CreatedTransactionId string `json:"created_transaction_id"`
 	ExecutedTransactionId string `json:"executed_transaction_id,omitempty"`
 	CancelledTransactionId string `json:"cancelled_transaction_id,omitempty"`
+	// True if the scheduled transaction was created during bootstrapping based on the current chain state, not based on a protocol event. When true, block_height, transaction_id, tx_index, and event_index are absent.
+	IsPlaceholder bool `json:"is_placeholder,omitempty"`
 	Transaction *Transaction `json:"transaction,omitempty"`
 	Result *TransactionResult `json:"result,omitempty"`
 	HandlerContract *ContractDeployment `json:"handler_contract,omitempty"`

openapi/experimental/openapi.yaml

@@ -1126,6 +1126,9 @@ components:
         cancelled_transaction_id:
           description: Flow transaction ID of the cancellation transaction.
           $ref: "#/components/schemas/Identifier"
+        is_placeholder:
+          description: True if the scheduled transaction was created during bootstrapping based on the current chain state, not based on a protocol event. When true, block_height, transaction_id, tx_index, and event_index are absent.
+          type: boolean
         transaction:
           $ref: "#/components/schemas/Transaction"
         result:
@@ -1176,7 +1179,6 @@ components:
       required:
         - contract_id
         - address
-        - code
         - code_hash
         - _expandable
       properties:
@@ -1214,10 +1216,16 @@ components:
           type: boolean
         transaction:
           $ref: "#/components/schemas/Transaction"
+        result:
+          $ref: "#/components/schemas/TransactionResult"
         _expandable:
           type: object
           description: Contains URI links for fields not included in the response. When a field is expanded via the `expand` query parameter, it appears inline and is removed from `_expandable`.
           properties:
+            code:
+              type: string
+              format: uri
+              description: Link to fetch the Cadence source code of this deployment.
             transaction:
               type: string
               format: uri