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

Enhance spec and migration doc a bit #211

Merged
merged 4 commits into from
May 30, 2024
Merged

Enhance spec and migration doc a bit #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3a5b234
spec: mark old APIs as deprecate, document migration
roman-khimov May 29, 2024
7af6031
spec: reference search in get_by_attribute
roman-khimov May 29, 2024
ecb56bc
spec: clarify special expiration attributes a bit
roman-khimov May 29, 2024
c560c82
docs: a bit more on migration from native REST APIs
roman-khimov May 29, 2024
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
14 changes: 14 additions & 0 deletions docs/migration-new-upload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,15 @@ NeoFS. All attributes are passed directly to NeoFS. Additionally,
`X-Neofs-EXPIRATION*` headers are available to set object expiration. Learn
more in the Swagger documentation (`/v1/docs`).

Notice that while the `/upload` API required you to create a multipart/form-data
payload, with new API you can just push object payload in the HTTP BODY.
However, whereas previously you always had a file name passed with the form
data, now you need to pass it as an attribute.

Compared to the old `/objects` API you no longer need to serialize object
payload into JSON which is more effective, container ID is passed in the path
and attributes can be added via `X-Attributes`.

Also, please note that the object attribute "Timestamp" can now be filled in
three ways: through the header `X-Attributes`, automatically if
"DefaultTimestamp" is enabled by settings, or in a new third way. The `Date`
Expand All @@ -32,3 +41,8 @@ approach is searching for an object by attribute with a GET request to
both requests, all custom object attributes will be placed in the
`X-Attributes` header. Additionally, you can send a HEAD request to both paths
to get object information without the object itself.

Compared to the old `/objects/{containerId}/{objectId}` API you now get
payload in HTTP BODY which is easier to integrate for most applications. You
no longer can request a range of an object, if you need it please submit an
issue.
Loading
Loading