Skip to content

Commit b91a3b9

Browse files
committed
fix: remove schema 'examples' breaking CI validation
Remove multiple 'examples' entries from schema definitions ('Operation', 'NetworkIdentifier'). These were intended solely for enhanced rendering in Scalar docs but caused spec-validation failures during CI builds. Single 'example' per schema retained to ensure OpenAPI compliance and fix build errors.
1 parent 3f7930c commit b91a3b9

File tree

1 file changed

+3
-16
lines changed
  • api/src/main/resources/rosetta-specifications-1.4.15

1 file changed

+3
-16
lines changed

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

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -542,10 +542,8 @@ 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-
examples:
545+
example:
546546
- mainnet
547-
- preprod
548-
- preview
549547
BlockIdentifier:
550548
description: The block_identifier uniquely identifies a block in a particular network.
551549
type: object
@@ -831,24 +829,13 @@ components:
831829
type:
832830
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.
833831
type: string
834-
examples:
832+
example:
835833
- 'input'
836-
- 'output'
837-
- 'stakeKeyRegistration'
838-
- 'stakeDelegation'
839-
- 'stakeKeyDeregistration'
840-
- 'poolRegistration'
841-
- 'poolRegistrationWithCert'
842-
- 'poolRetirement'
843-
- 'voteRegistration'
844-
- 'dRepVoteDelegation'
845-
- 'withdrawal'
846834
status:
847835
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.
848836
type: string
849-
examples:
837+
example:
850838
- 'success'
851-
- 'failure'
852839
account:
853840
$ref: '#/components/schemas/AccountIdentifier'
854841
amount:

0 commit comments

Comments
 (0)