realloc/frostfs-dev-env
1
0
Fork 0
forked from TrueCloudLab/frostfs-dev-env
Code Issues Pull requests Projects Releases Packages Wiki Activity

[TrueCloudLab#1] Update docs

Browse source 
Signed-off-by: Denis Kirillov <d.kirillov@yadro.com>
This commit is contained in:
Denis Kirillov 2022-12-21 14:59:19 +03:00 • committed by Alex Vanin
parent 6838092a50
commit ffe5012ab6
13 changed files with 93 additions and 225 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/rest_gate.md
View file

@ -1,8 +1,8 @@
# REST Gateway
REST Gateway to access data in NeoFS using REST.
REST Gateway to access data in FrostFS using REST.
Source code and more information can be found in [project's GitHub repository](https://github.com/nspcc-dev/neofs-rest-gw)
Source code and more information can be found in [project's GitHub repository](https://github.com/TrueCloudLab/frostfs-rest-gw)
## .env settings
@ -13,7 +13,7 @@ Image version label to use for containers.
If you want to use locally built image, just set its label here.
Instead of pulling from DockerHub, the local image will be used.
### REST_GW_IMAGE=nspccdev/neofs-rest-gw
### REST_GW_IMAGE=truecloudlab/frostfs-rest-gw
Image label prefix to use for containers.
@ -22,7 +22,7 @@ Image label prefix to use for containers.
- List container for specific owner:
```shell
$ curl http://rest.neofs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM | jq
$ curl http://rest.frostfs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuGeJUoRoi6PErcM | jq
{
"containers": [
{
@ -49,7 +49,7 @@ $ curl http://rest.neofs.devenv:8090/v1/containers?ownerId=NbUgTSFvPmsRxmGeWpuuG
- Get container info:
```shell
$ curl http://rest.neofs.devenv:8090/v1/containers/BKcAvz8awKKy9NGsGKi1Hoxxu9AjTGvjKMNMQamvdLmX | jq
$ curl http://rest.frostfs.devenv:8090/v1/containers/BKcAvz8awKKy9NGsGKi1Hoxxu9AjTGvjKMNMQamvdLmX | jq
{
"attributes": [
{
@ -67,4 +67,4 @@ $ curl http://rest.neofs.devenv:8090/v1/containers/BKcAvz8awKKy9NGsGKi1Hoxxu9AjT
}
```
See all available routes http://rest.neofs.devenv:8090/v1/docs
See all available routes http://rest.frostfs.devenv:8090/v1/docs