Skip to content
This repository was archived by the owner on May 12, 2021. It is now read-only.

docs: Update the kata api design of the sandbox operation API #727

Closed
YchauWang opened this issue Sep 8, 2020 · 0 comments · Fixed by #728
Closed

docs: Update the kata api design of the sandbox operation API #727

YchauWang opened this issue Sep 8, 2020 · 0 comments · Fixed by #728
Labels
bug Incorrect behaviour needs-review Needs to be assessed by the team.

Comments

@YchauWang
Copy link

Description of problem

Some methods of the sandbox operation api have been removed, such as sandbox.Pause() and sandbox.Resume(). And add some missing methods in this table.

Expected result

Update the sandbox operation api table, sync docs from the runtime codes.

Actual result

The sandbox.Pause() and sandbox.Resume() methods in the table of sandbox operation actually have been removed from the runtime project.
@YchauWang YchauWang added bug Incorrect behaviour needs-review Needs to be assessed by the team. labels Sep 8, 2020
YchauWang pushed a commit to YchauWang/documentation that referenced this issue Sep 8, 2020
@DavidWang-YC
docs: update the sandbox operation API table
05b213b 
Sync the api from the runtime codes to the documentation. Remove
sandbox.Pause() and sandbox.Resume() apis and add some missing methods
in this table.

Fixes: kata-containers#727

Signed-off-by: Ychau Wang <wangyongchao.bj@inspur.com>
@YchauWang YchauWang mentioned this issue Sep 8, 2020
Merged
YchauWang pushed a commit to YchauWang/documentation that referenced this issue Sep 8, 2020
@DavidWang-YC
docs: update the sandbox operation API table
b19b543 
Sync the api from the runtime codes to the documentation. Remove
sandbox.Pause() and sandbox.Resume() apis and add some missing methods
in this table. And sort this table by Feature and Name.

Fixes: kata-containers#727

Signed-off-by: Ychau Wang <wangyongchao.bj@inspur.com>
@YchauWang YchauWang mentioned this issue Sep 10, 2020
Closed
YchauWang pushed a commit to YchauWang/documentation that referenced this issue Oct 10, 2020
@DavidWang-YC
docs: add param to sandbox design api
fcd09f0 
Add param to sandbox design apis doc. Update kata-api-design.md file,
the apis for the sandbox operations.
link to: kata-containers#727

Fixes: kata-containers#729

Signed-off-by: Ychau Wang <wangyongchao.bj@inspur.com>
@YchauWang YchauWang mentioned this issue Oct 10, 2020
Merged
YchauWang pushed a commit to YchauWang/documentation that referenced this issue Oct 15, 2020
@DavidWang-YC
docs: add param to sandbox design api
53cf252 
Add param to sandbox design apis doc. Update kata-api-design.md file,
the apis for the sandbox operations.
link to: kata-containers#727
Update the description of the 1.x sandbox apis by 2.x sandbox apis' description.

Fixes: kata-containers#729

Signed-off-by: Ychau Wang <wangyongchao.bj@inspur.com>
YchauWang pushed a commit to YchauWang/documentation that referenced this issue Oct 15, 2020
@DavidWang-YC
docs: add param to sandbox design api
2f45ca9 
Add param to sandbox design apis doc. Update kata-api-design.md file,
the apis for the sandbox operations.
link to: kata-containers#727
Update the description of the 1.x sandbox apis by 2.x sandbox apis' description.

Fixes: kata-containers#729

Signed-off-by: Ychau Wang <wangyongchao.bj@inspur.com>
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Assignees
No one assigned
Labels
bug Incorrect behaviour needs-review Needs to be assessed by the team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: update the sandbox operation API table YchauWang/documentation
1 participant
@YchauWang