Skip to content

Commit ea67f5e

Browse files
committed
Spec fixes from vacuum linting
1 parent 1eeb31c commit ea67f5e

File tree

10 files changed

+3716
-2522
lines changed

10 files changed

+3716
-2522
lines changed

specs/results/koiosapi-guild.yaml

Lines changed: 543 additions & 504 deletions
Large diffs are not rendered by default.

specs/results/koiosapi-mainnet.yaml

Lines changed: 543 additions & 504 deletions
Large diffs are not rendered by default.

specs/results/koiosapi-preprod.yaml

Lines changed: 543 additions & 504 deletions
Large diffs are not rendered by default.

specs/results/koiosapi-preview.yaml

Lines changed: 543 additions & 504 deletions
Large diffs are not rendered by default.

specs/templates/1-api-info.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
info:
22
title: Koios API
3+
contact:
4+
name: Koios Core Team
5+
url: https://t.me/CardanoKoios
6+
email: general@koios.rest
7+
license:
8+
name: Creative Commons Attribution 4.0 International
9+
url: https://github.com/cardano-community/koios-artifacts/blob/main/LICENSE
310
version: v1.1.0rc
411
description: |
512
Koios is best described as a Decentralized and Elastic RESTful query layer for exploring data on Cardano blockchain to consume within applications/wallets/explorers/etc. This page not only provides an OpenAPI Spec for live implementation, but also ability to execute live demo from client browser against each endpoint with pre-filled examples.

specs/templates/2-api-params.yaml

Lines changed: 12 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,4 @@
11
parameters:
2-
select:
3-
name: select
4-
description: Filtering Columns
5-
schema:
6-
type: string
7-
in: query
8-
required: false
9-
on_conflict:
10-
name: on_conflict
11-
description: On Conflict
12-
schema:
13-
type: string
14-
in: query
15-
required: false
16-
order:
17-
name: order
18-
description: Ordering
19-
schema:
20-
type: string
21-
in: query
22-
required: false
23-
range:
24-
name: Range
25-
description: Limiting and Pagination
26-
schema:
27-
type: string
28-
in: header
29-
required: false
30-
rangeUnit:
31-
name: Range-Unit
32-
description: Limiting and Pagination
33-
schema:
34-
default: items
35-
type: string
36-
in: header
37-
required: false
38-
offset:
39-
name: offset
40-
description: Limiting and Pagination
41-
schema:
42-
type: string
43-
in: query
44-
required: false
45-
limit:
46-
name: limit
47-
description: Limiting and Pagination
48-
schema:
49-
type: string
50-
in: query
51-
required: false
52-
example: 10
53-
_block_hash:
54-
deprecated: false
55-
name: _block_hash
56-
description: Block Hash in hex format
57-
schema:
58-
type: string
59-
example: ##_block_hash_param##
60-
in: query
61-
required: true
62-
allowEmptyValue: false
632
_after_block_height:
643
deprecated: false
654
name: _after_block_height
@@ -76,57 +15,17 @@ parameters:
7615
description: Epoch Number to fetch details for
7716
schema:
7817
type: string
79-
example: ##_epoch_no_param##
18+
example: "##_epoch_no_param##"
8019
in: query
8120
required: false
8221
allowEmptyValue: true
83-
_earned_epoch_no:
84-
deprecated: false
85-
name: _epoch_no
86-
description: Filter for earned rewards Epoch Number
87-
schema:
88-
type: string
89-
example: ##_earned_epoch_no_param##
90-
in: query
91-
required: false
92-
allowEmptyValue: true
93-
_any_address:
94-
deprecated: false
95-
name: _address
96-
description: Cardano payment or staking address in bech32 format
97-
schema:
98-
type: string
99-
example: ##_any_address_param##
100-
in: query
101-
required: true
102-
allowEmptyValue: false
103-
_address:
104-
deprecated: false
105-
name: _address
106-
description: Cardano payment address in bech32 format
107-
schema:
108-
type: string
109-
example: ##_address_param##
110-
in: query
111-
required: true
112-
allowEmptyValue: false
113-
_address_assets:
114-
deprecated: false
115-
name: _address
116-
description: Cardano payment address in bech32 format
117-
schema:
118-
type: string
119-
example: ##_address_assets_param##
120-
in: query
121-
required: true
122-
allowEmptyValue: false
12322
_stake_address:
12423
deprecated: false
12524
name: _stake_address
12625
description: Cardano staking address (reward account) in bech32 format
12726
schema:
12827
type: string
129-
example: ##_stake_address_param##
28+
example: "##_stake_address_param##"
13029
in: query
13130
required: true
13231
allowEmptyValue: false
@@ -136,7 +35,7 @@ parameters:
13635
description: Asset Policy ID in hexadecimal format (hex)
13736
schema:
13837
type: string
139-
example: ##_asset_policy_param##
38+
example: "##_asset_policy_param##"
14039
in: query
14140
required: true
14241
allowEmptyValue: false
@@ -146,7 +45,7 @@ parameters:
14645
description: Asset Name in hexadecimal format (hex), empty asset name returns royalties
14746
schema:
14847
type: string
149-
example: "##_asset_name_param##"
48+
example: "##_asset_name_param##"
15049
in: query
15150
required: false
15251
allowEmptyValue: true
@@ -156,7 +55,7 @@ parameters:
15655
description: NFT Policy ID in hexadecimal format (hex)
15756
schema:
15857
type: string
159-
example: ##_asset_policy_nft_param##
58+
example: "##_asset_policy_nft_param##"
16059
in: query
16160
required: true
16261
allowEmptyValue: false
@@ -166,7 +65,7 @@ parameters:
16665
description: NFT Name in hexadecimal format (hex)
16766
schema:
16867
type: string
169-
example: ##_asset_name_nft_param##
68+
example: "##_asset_name_nft_param##"
17069
in: query
17170
required: false
17271
allowEmptyValue: true
@@ -176,7 +75,7 @@ parameters:
17675
description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call
17776
schema:
17877
type: boolean
179-
example: "false"
78+
example: false
18079
in: query
18180
required: false
18281
allowEmptyValue: true
@@ -186,7 +85,7 @@ parameters:
18685
description: Include all historical transactions, setting to false includes only the non-empty ones
18786
schema:
18887
type: boolean
189-
example: "false"
88+
example: false
19089
in: query
19190
required: false
19291
allowEmptyValue: false
@@ -196,7 +95,7 @@ parameters:
19695
description: Include information about nearing but not yet started epoch, to get access to active stake snapshot information if available
19796
schema:
19897
type: boolean
199-
example: "false"
98+
example: false
20099
in: query
201100
required: false
202101
allowEmptyValue: true
@@ -206,7 +105,7 @@ parameters:
206105
description: Pool ID in bech32 format
207106
schema:
208107
type: string
209-
example: ##_pool_bech32_param##
108+
example: "##_pool_bech32_param##"
210109
in: query
211110
required: true
212111
allowEmptyValue: false
@@ -216,7 +115,7 @@ parameters:
216115
description: Pool ID in bech32 format (optional)
217116
schema:
218117
type: string
219-
example: ##_pool_bech32_optional_param##
118+
example: "##_pool_bech32_optional_param##"
220119
in: query
221120
required: false
222121
allowEmptyValue: true
@@ -226,27 +125,7 @@ parameters:
226125
description: Script hash in hexadecimal format (hex)
227126
schema:
228127
type: string
229-
example: ##_script_hash_param##
128+
example: "##_script_hash_param##"
230129
in: query
231130
required: true
232131
allowEmptyValue: false
233-
_first_only:
234-
deprecated: false
235-
name: _first_only
236-
description: Returns the first entry only (overrides _empty to true)
237-
schema:
238-
type: boolean
239-
example: "false"
240-
in: query
241-
required: false
242-
allowEmptyValue: true
243-
_empty:
244-
deprecated: false
245-
name: _empty
246-
description: Include zero quantity entries
247-
schema:
248-
type: boolean
249-
example: "false"
250-
in: query
251-
required: false
252-
allowEmptyValue: true

0 commit comments

Comments
 (0)