Align swagger spec names with cardano-api

cardano-foundation · Sep 18, 2020 · 2d41f15 · 2d41f15
1 parent 58d5db1
commit 2d41f15
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 11 deletions.
diff --git a/lib/core/test/unit/Cardano/Wallet/Api/TypesSpec.hs b/lib/core/test/unit/Cardano/Wallet/Api/TypesSpec.hs
@@ -1571,17 +1571,17 @@ instance ToSchema ByronWalletPutPassphraseData where
 
 instance ToSchema (PostTransactionData t) where
     declareNamedSchema _ = do
-        addDefinition transactionMetadatumSchema
+        addDefinition transactionMetadataValueSchema
         declareSchemaForDefinition "ApiPostTransactionData"
 
 instance ToSchema (PostTransactionFeeData t) where
     declareNamedSchema _ = do
-        addDefinition transactionMetadatumSchema
+        addDefinition transactionMetadataValueSchema
         declareSchemaForDefinition "ApiPostTransactionFeeData"
 
 instance ToSchema (ApiTransaction t) where
     declareNamedSchema _ = do
-        addDefinition transactionMetadatumSchema
+        addDefinition transactionMetadataValueSchema
         declareSchemaForDefinition "ApiTransaction"
 
 instance ToSchema ApiUtxoStatistics where
@@ -1617,11 +1617,11 @@ instance ToSchema ApiPostRandomAddressData where
 -- switched to a library that supports OpenAPI 3.0, we can remove this empty
 -- schema and use instead something like:
 --
---     addDefinition =<< declareSchemaForDefinition "TransactionMetadatum"
+--     addDefinition =<< declareSchemaForDefinition "TransactionMetadataValue"
 --
-transactionMetadatumSchema :: NamedSchema
-transactionMetadatumSchema =
-    NamedSchema (Just "TransactionMetadatum") $ mempty
+transactionMetadataValueSchema :: NamedSchema
+transactionMetadataValueSchema =
+    NamedSchema (Just "TransactionMetadataValue") $ mempty
         & additionalProperties ?~ AdditionalPropertiesAllowed True
 
 -- | Utility function to provide an ad-hoc 'ToSchema' instance for a definition:

diff --git a/specifications/api/swagger.yaml b/specifications/api/swagger.yaml
@@ -584,7 +584,7 @@ x-transactionMetadata: &transactionMetadata
   type: object
   nullable: true
   additionalProperties:
-    $ref: "#/components/schemas/TransactionMetadatum"
+    $ref: "#/components/schemas/TransactionMetadataValue"
   # Note: propertyNames pattern not supported in current OpenAPI version.
   # propertyNames:
   #   pattern: '^[0-9]+$'
@@ -1398,18 +1398,18 @@ components:
         passphrase: *lenientPassphrase
         address_index: *addressIndex
 
-    TransactionMetadatum: &TransactionMetadatum
+    TransactionMetadataValue: &TransactionMetadataValue
       oneOf:
         - type: string
         - type: number
         - title: list
           type: array
           items:
-            $ref: "#/components/schemas/TransactionMetadatum"
+            $ref: "#/components/schemas/TransactionMetadataValue"
         - title: map
           type: object
           additionalProperties:
-            $ref: "#/components/schemas/TransactionMetadatum"
+            $ref: "#/components/schemas/TransactionMetadataValue"
 
 #############################################################################
 #                                                                           #