diff --git a/hedera-mirror-rest/api/v1/openapi.yml b/hedera-mirror-rest/api/v1/openapi.yml index 2c6411f18f4..02dca913d0a 100644 --- a/hedera-mirror-rest/api/v1/openapi.yml +++ b/hedera-mirror-rest/api/v1/openapi.yml @@ -93,7 +93,7 @@ paths: description: Return the contract information given an id operationId: getContractById parameters: - - $ref: '#/components/parameters/entityIdPathParam' + - $ref: '#/components/parameters/contractIdPathParam' - $ref: '#/components/parameters/timestampQueryParam' responses: 200: @@ -114,7 +114,7 @@ paths: description: Returns a list of all ContractResults for a contract's function executions. operationId: listContractResults parameters: - - $ref: '#/components/parameters/entityIdPathParam' + - $ref: '#/components/parameters/contractIdPathParam' - $ref: '#/components/parameters/fromQueryParam' - $ref: '#/components/parameters/limitQueryParam' - $ref: '#/components/parameters/orderQueryParamDesc' @@ -136,7 +136,7 @@ paths: description: Returns a single ContractResult for a contract's function executions at a specific timestamp. operationId: getContractResultByIdAndTimestamp parameters: - - $ref: '#/components/parameters/entityIdPathParam' + - $ref: '#/components/parameters/contractIdPathParam' - $ref: '#/components/parameters/timestampPathParam' responses: 200: @@ -182,7 +182,7 @@ paths: and span a time range of at most seven days. operationId: listContractLogs parameters: - - $ref: '#/components/parameters/entityIdPathParam' + - $ref: '#/components/parameters/contractIdPathParam' - $ref: '#/components/parameters/logIndexQueryParam' - $ref: '#/components/parameters/limitQueryParam' - $ref: '#/components/parameters/orderQueryParam' @@ -249,7 +249,7 @@ paths: description: Returns schedule information based on the given schedule id operationId: getScheduleById parameters: - - $ref: '#/components/parameters/entityIdPathParam' + - $ref: '#/components/parameters/scheduleIdPathParam' responses: 200: description: OK @@ -347,7 +347,7 @@ paths: description: Returns the list of topic messages for the given topic id. operationId: listTopicMessagesById parameters: - - $ref: '#/components/parameters/entityIdPathParam' + - $ref: '#/components/parameters/topicIdPathParam' - name: sequencenumber in: query example: 2 @@ -380,7 +380,7 @@ paths: description: Returns a single topic message the given topic id and sequence number. operationId: getTopicMessageByIdAndSequenceNumber parameters: - - $ref: '#/components/parameters/entityIdPathParam' + - $ref: '#/components/parameters/topicIdPathParam' - name: sequencenumber in: path required: true @@ -450,7 +450,7 @@ paths: description: Returns token entity information given the id operationId: getTokenById parameters: - - $ref: '#/components/parameters/entityIdPathParam' + - $ref: '#/components/parameters/tokenIdPathParam' - $ref: '#/components/parameters/tokenInfoTimestampQueryParam' responses: 200: @@ -579,7 +579,7 @@ paths: description: Returns a list of token balances given the id. This represents the Token supply distribution across the network operationId: listTokenBalancesById parameters: - - $ref: '#/components/parameters/entityIdPathParam' + - $ref: '#/components/parameters/tokenIdPathParam' - $ref: '#/components/parameters/accountIdQueryParam' - $ref: '#/components/parameters/accountBalanceQueryParam' - $ref: '#/components/parameters/orderQueryParam' @@ -604,10 +604,10 @@ paths: description: Returns a list of non-fungible tokens operationId: listNfts parameters: + - $ref: '#/components/parameters/tokenIdPathParam' - $ref: '#/components/parameters/accountIdQueryParam' - $ref: '#/components/parameters/limitQueryParam' - $ref: '#/components/parameters/orderQueryParam' - - $ref: '#/components/parameters/entityIdPathParam' responses: 200: description: OK @@ -627,8 +627,8 @@ paths: description: Returns information for a non-fungible token operationId: listNftBySerialnumber parameters: + - $ref: '#/components/parameters/tokenIdPathParam' - $ref: '#/components/parameters/serialNumberPathParam' - - $ref: '#/components/parameters/entityIdPathParam' responses: 200: description: OK @@ -648,8 +648,8 @@ paths: description: Returns a list of transactions for a given non-fungible token operationId: listNftTransactions parameters: + - $ref: '#/components/parameters/tokenIdPathParam' - $ref: '#/components/parameters/serialNumberPathParam' - - $ref: '#/components/parameters/entityIdPathParam' responses: 200: description: OK @@ -2026,6 +2026,14 @@ components: value: lte:0.0.700 schema: $ref: '#/components/schemas/EntityIdQuery' + # Path parameters for different IDs. + contractIdPathParam: + name: contractId + in: path + required: true + description: Contract id + schema: + $ref: '#/components/schemas/EntityId' entityIdPathParam: name: entityId in: path @@ -2033,6 +2041,27 @@ components: description: Entity id schema: $ref: '#/components/schemas/EntityId' + scheduleIdPathParam: + name: scheduleId + in: path + required: true + description: Schedule id + schema: + $ref: '#/components/schemas/EntityId' + tokenIdPathParam: + name: tokenId + in: path + required: true + description: Token id + schema: + $ref: '#/components/schemas/EntityId' + topicIdPathParam: + name: topicId + in: path + required: true + description: Topic id + schema: + $ref: '#/components/schemas/EntityId' fromQueryParam: name: from in: query