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

docs: Add types to sandbox design API #729

Closed
c3d opened this issue Sep 8, 2020 · 0 comments · Fixed by #745
Closed

docs: Add types to sandbox design API #729

c3d opened this issue Sep 8, 2020 · 0 comments · Fixed by #745
Labels
enhancement Improvement to an existing feature needs-review Needs to be assessed by the team.

Comments

@c3d
Copy link
Member

c3d commented Sep 8, 2020

The sandbox design API document https://github.com/kata-containers/documentation/blob/master/design/kata-api-design.md has references to data types in examples such as CreateSandbox(SandboxConfig), but the SandboxConfig type is not defined in the documentation.

Types to document: SandboxStatus, SandboxStats, SandboxConfig and Sandbox.
@c3d c3d added enhancement Improvement to an existing feature needs-review Needs to be assessed by the team. labels Sep 8, 2020
@c3d c3d mentioned this issue Sep 8, 2020
Merged
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>
@cmaf cmaf closed this as completed in #745 Oct 15, 2020
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Assignees
No one assigned
Labels
enhancement Improvement to an existing feature 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: add param to sandbox design api YchauWang/documentation
1 participant
@c3d