Update descriptions and examples

iotaledger · Nov 20, 2023 · 107c6f5 · 107c6f5
1 parent 02e9c48
commit 107c6f5
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 16 deletions.
diff --git a/tips/TIP-0048/openapi3-core.yaml b/tips/TIP-0048/openapi3-core.yaml
@@ -1643,7 +1643,7 @@ components:
               description: Network version identifier. It also tells which network the node is running.
             issuingTime:
               type: string
-              description: The timestamp of issuing this block, a uint64 string.
+              description: The timestamp of issuing this block, a uint64 string in nanosecond-precision.
             slotCommitmentId:
               type: string
               description: The slot commitment ID contains in this block.
@@ -2347,8 +2347,8 @@ components:
       properties:
         type:
           type: integer
-          description: Set to value 4 to denote a Block Issuer Feature.
-          example: 4
+          description: Set to value 6 to denote a Block Issuer Feature.
+          example: 6
         blockIssuerKeys:
           type: array
           description: The keys allowed to issue blocks from an account with a BlockIssuerFeature.
@@ -2381,8 +2381,8 @@ components:
       properties:
         type:
           type: string
-          description: Set to value 5 to denote a Staking Feature.
-          example: 5
+          description: Set to value 7 to denote a Staking Feature.
+          example: 7
         stakedAmount:
           type: string
           description: The amount of IOTA coins that are locked and staked in the containing account.
@@ -2438,7 +2438,7 @@ components:
       properties:
         type:
           type: integer
-          description: Set to value 3 to denote a Tag Feature.
+          description: Set to value 4 to denote a Tag Feature.
         tag:
           type: string
           description: Hex-encoded binary indexation tag with 0x prefix.
@@ -2659,16 +2659,16 @@ components:
               type: boolean
               description: Tells whether the node is healthy or not.
             acceptedTangleTime:
-              description: A notion of time that is anchored to the latest accepted block.
+              description: A notion of time that is anchored to the latest accepted block. It's in nanosecond-precision. 
               type: string
             relativeAcceptedTangleTime:
-              description: The time after Accepted Tangle Time has advanced with the system clock.
+              description: The time after Accepted Tangle Time has advanced with the system clock. It's in nanosecond-precision.
               type: string
             confirmedTangleTime:
-              description: A notion of time that is anchored to the latest confirmed block.
+              description: A notion of time that is anchored to the latest confirmed block. It's in nanosecond-precision.
               type: string
             relativeConfirmedTangleTime:
-              description: The time after Confirmed Tangle Time has advanced with the system clock.
+              description: The time after Confirmed Tangle Time has advanced with the system clock. It's in nanosecond-precision.
               type: string
             latestCommitmentId:
               type: string
@@ -2893,7 +2893,7 @@ components:
               description: Current supply of base token. Plain string encoded number.
             genesisUnixTimestamp:
               type: string
-              description: The genesis timestamp at which the slots start to count.
+              description: The genesis timestamp at which the slots start to count. It's in second-precision.
             slotDurationInSeconds:
               type: integer
               description: The duration of a slot, in seconds.

diff --git a/tips/TIP-0048/openapi3-indexer.yaml b/tips/TIP-0048/openapi3-indexer.yaml
@@ -1044,24 +1044,24 @@ components:
   examples:
     get-outputs-response-three-example:
       value:
-        ledgerIndex: 101
+        committedSlot: 101
         items:
           - "0x0c78e998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a790000"
           - "0x0c78e998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a790100"
           - "0x0c78e998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a790200"
     get-outputs-response-single-example:
       value:
-        ledgerIndex: 101
+        committedSlot: 101
         items:
           - "0x0c78e998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a790000"
     get-outputs-empty-response-example:
       value:
-        ledgerIndex: 101
+        committedSlot: 101
         items:
           -
     get-outputs-pagesize2-response-example:
       value:
-        ledgerIndex: 101
+        committedSlot: 101
         cursor: 61fa44a14d35ce14b9d0e7ee6ac9af70c0af156be269f69348be6d6f83c80a3a8a44ce440000.2
         items:
           - "0x0c78e998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a790000"
@@ -1139,7 +1139,7 @@ components:
       properties:
         committedSlot:
           type: integer
-          description: The committed slot at which these outputs where available at.
+          description: The committed slot at which these outputs were available at.
         pageSize:
           type: integer
           description: The maximum amount of items returned in one call. If there are more items, a cursor to the next page is returned too.