Skip to content

Fix bugs, typos, and parameter naming mismatches in API spec #1

@crtahlin

Description

@crtahlin

Summary

Fix clear-cut errors in openapi/Swarm.yaml that produce incorrect or misleading API documentation.

Changes

  • Wrong description: /pins/check ref parameter currently says "The number of items to skip before starting to collect the result set." — this is copy-pasted from pagination parameters and is incorrect. Should describe the optional reference to validate.
  • Typo: /pins/check summary says "integerity" — should be "integrity".
  • Parameter naming mismatches:
    • HEAD /bytes/{reference} — parameter is named address but path uses {reference}
    • HEAD /bzz/{reference} — parameter is named address but path uses {reference}
    • GET /chunks/{address} — parameter is named reference but path uses {address}

File

openapi/Swarm.yaml

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions