Skip to content

Commit

Permalink
docs: query params examples (#55)
Browse files Browse the repository at this point in the history
closes #54
  • Loading branch information
lidel committed Aug 26, 2020
1 parent 2af7f77 commit 434132e
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions ipfs-pinning-service.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -481,13 +481,7 @@ components:
maxItems: 1000
style: form # ?cid=Qm1,Qm2,bafy3
explode: false
examples:
oneId:
summary: Example of a single CID
value: [QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR] # ?cid=Qm
multipleIds:
summary: Example of multiple CIDs
value: [QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR,bafkreigtdgsgv2f3bkhsmxvku3bpnnqzubcxeupf7fff5f7l7tlm2v237a] # ?cid=Qm,bafy
example: ["Qm1","Qm2","bafy3"]

name:
description: Return pin objects with names that contain provided value (partial or full match)
Expand All @@ -512,6 +506,7 @@ components:
minItems: 1
style: form # ?status=queued,pinning
explode: false
example: ["queued","pinning"]

meta:
description: Return pin objects that match specified metadata
Expand Down

0 comments on commit 434132e

Please sign in to comment.