Skip to content

Commit 0e627ac

Browse files
committed
Remove unused governance proposal endpoints from OpenAPI spec and clean up nullable metadata definitions
1 parent c2b5694 commit 0e627ac

File tree

1 file changed

+10
-138
lines changed

1 file changed

+10
-138
lines changed

API/openapi.yaml

Lines changed: 10 additions & 138 deletions
Original file line numberDiff line numberDiff line change
@@ -217,134 +217,6 @@ paths:
217217
'500':
218218
$ref: '#/components/responses/internal_error'
219219

220-
'/governance/proposals/{tx_hash}/{cert_index}':
221-
get:
222-
tags:
223-
- Cardano » Governance
224-
summary: Specific proposal
225-
description: Detailed information about a specific governance proposal.
226-
parameters:
227-
- in: path
228-
name: tx_hash
229-
required: true
230-
schema:
231-
type: string
232-
description: Transaction hash (hex-encoded)
233-
- in: path
234-
name: cert_index
235-
required: true
236-
schema:
237-
type: integer
238-
description: Certificate index within the transaction (u8)
239-
responses:
240-
'200':
241-
description: Return the proposal information
242-
content:
243-
application/json:
244-
schema:
245-
$ref: '#/components/schemas/proposal'
246-
'400':
247-
$ref: '#/components/responses/bad_request'
248-
'404':
249-
$ref: '#/components/responses/not_found'
250-
'500':
251-
$ref: '#/components/responses/internal_error'
252-
253-
'/governance/proposals/{tx_hash}/{cert_index}/parameters':
254-
get:
255-
tags:
256-
- Cardano » Governance
257-
summary: Proposal parameters
258-
description: Protocol parameter changes proposed (not yet implemented).
259-
parameters:
260-
- in: path
261-
name: tx_hash
262-
required: true
263-
schema:
264-
type: string
265-
- in: path
266-
name: cert_index
267-
required: true
268-
schema:
269-
type: integer
270-
responses:
271-
'501':
272-
$ref: '#/components/responses/not_implemented'
273-
274-
'/governance/proposals/{tx_hash}/{cert_index}/metadata':
275-
get:
276-
tags:
277-
- Cardano » Governance
278-
summary: Proposal metadata
279-
description: Metadata associated with a specific proposal (not yet implemented).
280-
parameters:
281-
- in: path
282-
name: tx_hash
283-
required: true
284-
schema:
285-
type: string
286-
- in: path
287-
name: cert_index
288-
required: true
289-
schema:
290-
type: integer
291-
responses:
292-
'501':
293-
$ref: '#/components/responses/not_implemented'
294-
295-
'/governance/proposals/{tx_hash}/{cert_index}/withdrawals':
296-
get:
297-
tags:
298-
- Cardano » Governance
299-
summary: Proposal withdrawals
300-
description: Treasury withdrawal details for a specific proposal (not yet implemented).
301-
parameters:
302-
- in: path
303-
name: tx_hash
304-
required: true
305-
schema:
306-
type: string
307-
- in: path
308-
name: cert_index
309-
required: true
310-
schema:
311-
type: integer
312-
responses:
313-
'501':
314-
$ref: '#/components/responses/not_implemented'
315-
316-
'/governance/proposals/{tx_hash}/{cert_index}/votes':
317-
get:
318-
tags:
319-
- Cardano » Governance
320-
summary: Proposal votes
321-
description: All votes cast on a specific governance proposal.
322-
parameters:
323-
- in: path
324-
name: tx_hash
325-
required: true
326-
schema:
327-
type: string
328-
- in: path
329-
name: cert_index
330-
required: true
331-
schema:
332-
type: integer
333-
responses:
334-
'200':
335-
description: Return votes on the proposal
336-
content:
337-
application/json:
338-
schema:
339-
type: array
340-
items:
341-
$ref: '#/components/schemas/proposal_votes'
342-
'400':
343-
$ref: '#/components/responses/bad_request'
344-
'404':
345-
$ref: '#/components/responses/not_found'
346-
'500':
347-
$ref: '#/components/responses/internal_error'
348220

349221
# ============================================
350222
# EPOCHS ENDPOINTS
@@ -1532,6 +1404,7 @@ components:
15321404
amount: '18605647'
15331405
drep_metadata:
15341406
type: object
1407+
nullable: true
15351408
properties:
15361409
drep_id:
15371410
type: string
@@ -1553,11 +1426,10 @@ components:
15531426
- type: object
15541427
additionalProperties: true
15551428
- type: array
1556-
items: {}
1429+
items: { }
15571430
- type: integer
15581431
- type: number
15591432
- type: boolean
1560-
- type: 'null'
15611433
description: Content of the JSON metadata (validated CIP-119)
15621434
bytes:
15631435
type: string
@@ -2253,6 +2125,7 @@ components:
22532125
vote: abstain
22542126
proposal_metadata:
22552127
type: object
2128+
nullable: true
22562129
properties:
22572130
tx_hash:
22582131
type: string
@@ -2276,11 +2149,10 @@ components:
22762149
- type: object
22772150
additionalProperties: true
22782151
- type: array
2279-
items: {}
2152+
items: { }
22802153
- type: integer
22812154
- type: number
22822155
- type: boolean
2283-
- type: 'null'
22842156
description: Content of the JSON metadata (validated CIP-108)
22852157
bytes:
22862158
type: string
@@ -4237,6 +4109,7 @@ components:
42374109
count: '16321'
42384110
tx_metadata_label_json:
42394111
type: array
4112+
nullable: true
42404113
items:
42414114
type: object
42424115
properties:
@@ -4249,11 +4122,10 @@ components:
42494122
- type: object
42504123
additionalProperties: true
42514124
- type: array
4252-
items: {}
4125+
items: { }
42534126
- type: integer
42544127
- type: number
42554128
- type: boolean
4256-
- type: 'null'
42574129
description: Content of the JSON metadata
42584130
required:
42594131
- tx_hash
@@ -5535,18 +5407,18 @@ components:
55355407
- serialised_size
55365408
script_json:
55375409
type: object
5410+
nullable: true
55385411
properties:
55395412
json:
55405413
anyOf:
55415414
- type: string
55425415
- type: object
55435416
additionalProperties: true
55445417
- type: array
5545-
items: {}
5418+
items: { }
55465419
- type: integer
55475420
- type: number
55485421
- type: boolean
5549-
- type: 'null'
55505422
description: 'JSON contents of the `timelock` script, null for `plutus` scripts'
55515423
required:
55525424
- json
@@ -5948,7 +5820,7 @@ components:
59485820
- type: string
59495821
- type: object
59505822
- type: array
5951-
items: {}
5823+
items: { }
59525824
- type: integer
59535825
- type: number
59545826
- type: boolean
@@ -5990,7 +5862,7 @@ components:
59905862
- type: string
59915863
- type: object
59925864
- type: array
5993-
items: {}
5865+
items: { }
59945866
- type: integer
59955867
- type: number
59965868
- type: boolean

0 commit comments

Comments
 (0)