Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ipfs: fix ipfs/add response size type to string #115

Merged
merged 6 commits into from
Aug 17, 2021
Merged

ipfs: fix ipfs/add response size type to string #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
549f096
ipfs: fix ipfs/add response size type to string
sorki Aug 13, 2021
14bebcb
Fix types of IPFS size examples
sorki Aug 14, 2021
fd04f80
add summary to ipfs/pin/list
sorki Aug 14, 2021
0365586
Fix description/add summary in ipfs/pin/list/<obj>
sorki Aug 14, 2021
de9613e
update CHANGELOG.md
sorki Aug 14, 2021
817aded
Omit 'or directory' from summary of
sorki Aug 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project will adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) once it reaches maturity in v1.

## [0.1.27] - 2021-08-xx

### Fixed

- `/ipfs/add` size response type fixed from integer to string
- types of IPFS size examples
- description of `ipfs/pin/list/<object>`

## [0.1.26] - 2021-08-12

### Fixed
Expand Down
16 changes: 9 additions & 7 deletions swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3304,7 +3304,7 @@ paths:
post:
tags:
- IPFS » Add
summary: Add a file or directory to IPFS
summary: Add a file to IPFS
description: |
You need to `/ipfs/pin/add` an object to avoid it being garbage collected. This usage
is being counted in your user account quota.
Expand Down Expand Up @@ -3332,9 +3332,9 @@ paths:
example: QmZbHqiCxKEVX7QfijzJTkZiSi3WEVTcvANgNAWzDYgZDr
description: IPFS hash of the file
size:
type: integer
example: 125297
description: Size of the file
type: string
example: "125297"
description: IPFS node size in Bytes
required:
- name
- ipfs_hash
Expand Down Expand Up @@ -3437,6 +3437,7 @@ paths:
get:
tags:
- IPFS » Pins
summary: List pinned objects
description: List objects pinned to local storage
parameters:
- in: query
Expand Down Expand Up @@ -3489,7 +3490,7 @@ paths:
size:
type: string
description: Size of the object in Bytes
example: 1615551024
example: "1615551024"
state:
type: string
enum: [queued|pinned|unpinned|failed|gc]
Expand Down Expand Up @@ -3524,7 +3525,8 @@ paths:
get:
tags:
- IPFS » Pins
description: List objects pinned to local storage
summary: Get details about pinned object
description: Get information about locally pinned IPFS object
parameters:
- in: path
required: true
Expand Down Expand Up @@ -3555,7 +3557,7 @@ paths:
size:
type: string
description: Size of the object in Bytes
example: 1615551024
example: "1615551024"
state:
type: string
enum: [queued|pinned|unpinned|failed|gc]
Expand Down