Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
dgarcia360 committed Mar 9, 2020
2 parents 6f88a29 + d3b1fbf commit 5d491cc
Show file tree
Hide file tree
Showing 8 changed files with 61 additions and 23 deletions.
14 changes: 0 additions & 14 deletions spec/core/network/routes/getNetworkFees.yml

This file was deleted.

17 changes: 17 additions & 0 deletions spec/core/network/routes/getRentalFees.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
tags:
- Network routes
summary: Get rental fees information
description: |
Returns the estimated effective rental fees for namespaces and mosaics.
This endpoint is only available if the REST instance has access to catapult-server ``resources/config-network.properties`` file.
To activate this feature, add the setting "network.propertiesFilePath" in the configuration file (rest/resources/rest.json).
operationId: getRentalFees
responses:
"200":
description: success
content:
application/json:
schema:
$ref: "../schemas/RentalFeesDTO.yml"
"409":
$ref: "../../../responses/InvalidArgument.yml"
14 changes: 14 additions & 0 deletions spec/core/network/routes/getTransactionFees.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
tags:
- Network routes
summary: Get transaction fees information
description: |
Returns the average, median, highest and lower fee multiplier over the last "numBlocksTransactionFeeStats".
The setting "numBlocksTransactionFeeStats" is adjustable via the configuration file (rest/resources/rest.json) per REST instance.
operationId: getTransactionFees
responses:
"200":
description: success
content:
application/json:
schema:
$ref: "../schemas/TransactionFeesDTO.yml"
18 changes: 18 additions & 0 deletions spec/core/network/schemas/RentalFeesDTO.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
type: object
required:
- effectiveRootNamespaceRentalFeePerBlock
- effectiveChildNamespaceRentalFee
- effectiveMosaicRentalFee
properties:
effectiveRootNamespaceRentalFeePerBlock:
$ref: "../../../schemas/Amount.yml"
description: Estimated effective rental fee to register/extend a namespace per block.
example: 0
effectiveChildNamespaceRentalFee:
$ref: "../../../schemas/Amount.yml"
description: Estimated effective rental fee to create a subnamespace.
example: 0
effectiveMosaicRentalFee:
$ref: "../../../schemas/Amount.yml"
description: Estimated effective rental fee to create a mosaic.
example: 0
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@ required:
- lowestFeeMultiplier
properties:
averageFeeMultiplier:
type: number
format: double
type: integer
description: Average fee multiplier over the last "numBlocksTransactionFeeStats".
example: 1
medianFeeMultiplier:
type: number
format: double
type: integer
description: Median fee multiplier over the last "numBlocksTransactionFeeStats".
example: 1
highestFeeMultiplier:
Expand Down
2 changes: 1 addition & 1 deletion spec/parameters/limit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ in: path
description: |
Number of elements to be returned.
The limit should be greater than or equal to "db.pageSizeMin" and not higher than "db.pageSizeMax".
The settings are adjustable via a configuration file (rest/resources/rest.json) per REST instance.
The settings are adjustable via the configuration file (rest/resources/rest.json) per REST instance.
required: true
schema:
type: integer
7 changes: 5 additions & 2 deletions spec/routes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,12 @@
/network:
get:
$ref: "./core/network/routes/getNetworkType.yml"
/network/fees:
/network/fees/rental:
get:
$ref: "./core/network/routes/getNetworkFees.yml"
$ref: "./core/network/routes/getRentalFees.yml"
/network/fees/transaction:
get:
$ref: "./core/network/routes/getTransactionFees.yml"

/network/properties:
get:
Expand Down
6 changes: 4 additions & 2 deletions spec/schemas/_index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,12 @@ HeightInfoDTO:
"$ref": "../core/chain/schemas/HeightInfoDTO.yml"

# Core - Entity
RentalFeesDTO:
"$ref": "../core/network/schemas/RentalFeesDTO.yml"
TransactionFeesDTO:
"$ref": "../core/network/schemas/TransactionFeesDTO.yml"
NetworkTypeEnum:
"$ref": "../core/entity/schemas/NetworkTypeEnum.yml"
NetworkFeesDTO:
"$ref": "../core/network/schemas/NetworkFeesDTO.yml"
EntityDTO:
"$ref": "../core/entity/schemas/EntityDTO.yml"
VerifiableEntityDTO:
Expand Down

0 comments on commit 5d491cc

Please # to comment.