Skip to content

Commit 2652c02

Browse files
committed
chore: update OpenAPI generator plugin version and refine example values in API specification
- Upgraded the OpenAPI generator Maven plugin from version 6.4.0 to 7.13.0. - Simplified example values in the API specification by removing unnecessary array structures for 'network' and 'status' fields.
1 parent b91a3b9 commit 2652c02

File tree

2 files changed

+7
-12
lines changed

2 files changed

+7
-12
lines changed

api/src/main/resources/rosetta-specifications-1.4.15/api.yaml

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -542,8 +542,7 @@ components:
542542
network:
543543
description: This field contains the specific network identifier for the blockchain, such as 'mainnet', 'preprod', or 'preview' for Cardano. This helps identify which network you are connecting to.
544544
type: string
545-
example:
546-
- mainnet
545+
example: mainnet
547546
BlockIdentifier:
548547
description: The block_identifier uniquely identifies a block in a particular network.
549548
type: object
@@ -829,13 +828,11 @@ components:
829828
type:
830829
description: Type is the network-specific type of the operation. Ensure that any type that can be returned here is also specified in the NetworkOptionsResponse. This can be very useful to downstream consumers that parse all block data.
831830
type: string
832-
example:
833-
- 'input'
831+
example: input
834832
status:
835833
description: Status is the network-specific status of the operation. Status is not defined on the transaction object because blockchains with smart contracts may have transactions that partially apply (some operations are successful and some are not). Blockchains with atomic transactions (all operations succeed or all operations fail) will have the same status for each operation. Cardano transactions are generally atomic; they either succeed entirely and are included in a block or fail validation and are rejected. Therefore, the status for operations within a block transaction will typically be a single success value defined in NetworkOptionsResponse. On-chain operations (operations retrieved in the `/block` and `/block/transaction` endpoints) MUST have a populated status field. Operations provided during transaction construction (often called "intent") MUST NOT have a populated status field.
836834
type: string
837-
example:
838-
- 'success'
835+
example: success
839836
account:
840837
$ref: '#/components/schemas/AccountIdentifier'
841838
amount:
@@ -959,16 +956,14 @@ components:
959956
items:
960957
$ref: '#/components/schemas/OperationStatus'
961958
example:
962-
- status: 'success'
959+
- status: success
963960
successful: true
964-
- status: 'invalid'
965-
successful: false
966961
operation_types:
967-
description: All Operation.Type this implementation supports. This is crucial for Cardano, which has many distinct operation types beyond simple transfers.
962+
description: All Operation.Type this implementation supports (input, output, stakeKeyRegistration, stakeDelegation, withdrawal, stakeKeyDeregistration, poolRegistration, poolRegistrationWithCert, poolRetirement, voteRegistration, dRepVoteDelegation). This is crucial for Cardano, which has many distinct operation types beyond simple transfers.
968963
type: array
969964
items:
970965
type: string
971-
example: # Add all relevant Cardano operation types
966+
example:
972967
- 'input'
973968
- 'output'
974969
- 'stakeKeyRegistration'

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3232
<version.spring-boot>3.4.3</version.spring-boot>
3333
<version.springdoc-openapi-ui>1.6.15</version.springdoc-openapi-ui>
34-
<version.openapi-generator-maven-plugin>6.4.0</version.openapi-generator-maven-plugin>
34+
<version.openapi-generator-maven-plugin>7.13.0</version.openapi-generator-maven-plugin>
3535
<version.maven-compiler-plugin>3.13.0</version.maven-compiler-plugin>
3636
<version.maven-surefire-plugin>3.2.5</version.maven-surefire-plugin>
3737
<version.jacoco-maven-plugin>0.8.11</version.jacoco-maven-plugin>

0 commit comments

Comments
 (0)