Skip to content

Commit d251fb8

Browse files
committed
Fix typos and parameter naming in OpenAPI spec
- Fix parameter name mismatch in /bytes/{reference} HEAD: address -> reference - Fix parameter name mismatch in /bzz/{reference} HEAD: address -> reference - Fix parameter name mismatch in /chunks/{address} GET: reference -> address - Fix typo: integerity -> integrity in /pins/check summary - Fix incorrect description for /pins/check ref parameter
1 parent ee5bf4e commit d251fb8

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

openapi/Swarm.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -232,11 +232,11 @@ paths:
232232
- Bytes
233233
parameters:
234234
- in: path
235-
name: address
235+
name: reference
236236
schema:
237237
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
238238
required: true
239-
description: Swarm address of chunk
239+
description: Swarm address reference to content
240240
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmActTimestamp"
241241
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmActPublisher"
242242
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
@@ -447,11 +447,11 @@ paths:
447447
- BZZ
448448
parameters:
449449
- in: path
450-
name: address
450+
name: reference
451451
schema:
452452
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
453453
required: true
454-
description: Swarm address of chunk
454+
description: Swarm address reference to content
455455
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmActTimestamp"
456456
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmActPublisher"
457457
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmActHistoryAddress"
@@ -729,7 +729,7 @@ paths:
729729

730730
"/pins/check":
731731
get:
732-
summary: Validate pinned chunks integerity
732+
summary: Validate pinned chunks integrity
733733
tags:
734734
- Pinning
735735
parameters:
@@ -738,7 +738,7 @@ paths:
738738
schema:
739739
$ref: "SwarmCommon.yaml#/components/schemas/SwarmOnlyReference"
740740
required: false
741-
description: The number of items to skip before starting to collect the result set.
741+
description: Swarm reference of the pinned root hash to check. If omitted, all pinned content is checked.
742742
responses:
743743
"200":
744744
description: List of checked root hash references
@@ -1289,7 +1289,7 @@ paths:
12891289
- Chunk
12901290
parameters:
12911291
- in: path
1292-
name: reference
1292+
name: address
12931293
schema:
12941294
$ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
12951295
required: true

0 commit comments

Comments
 (0)