Add comments for required params for register #1020
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
jihoon-seo
reviewed
Jan 25, 2022
| @@ -30,6 +30,7 @@ import ( | |||
| // @Accept json | |||
| // @Produce json | |||
| // @Param nsId path string true "Namespace ID" default(ns01) | |||
| // @Param option query string false "Option: [required params for register] connectionName, name, cspSshKeyId, fingerprint, username, publicKey, privateKey" Enums(register) | |||
There was a problem hiding this comment.
cloud-barista/cb-spider#560 에서 어떻게 결정되는지에 따라서,
추후 이 라인에도 변경이 필요할 수도 있겠습니다. 😊
| @@ -30,7 +30,7 @@ import ( | |||
| // @Accept json | |||
| // @Produce json | |||
| // @Param nsId path string true "Namespace ID" default(ns01) | |||
| // @Param option query string false "Option" Enums(register) | |||
| // @Param option query string false "Option: [required params for register] connectionName, name, cspVNetId" Enums(register) | |||
There was a problem hiding this comment.
- Request body 에
cspVNetId필드를 빈칸으로 두면
=> 사용자가 Request body 에 명시한connectionName과name으로 CB-Spider에 조회하여
Get 성공하면 TB object로 등록- Request body 에
cspVNetId필드를 명시하면
=> CB-Spider의regvpcAPI를 호출하여
CSP에만 있는 자원을 SP에도 등록하고 TB에도 등록하도록 하였습니다.
즉, 상황 별 required fields는 다음과 같습니다.
- CSP에 있는 자원이 SP에 등록되어 있고, TB에도 등록하는 경우
=>connectionName,name - CSP만 있는 자원을 SP에도 등록하고 TB에도 등록하는 경우
=>connectionName,name,cspVNetId
훔.. 이를 잘 표현할 수 있는 좋은 방법이 있을까요? 😊
(SG, SSH Key 에 대해서도 동일 이슈 존재)
There was a problem hiding this comment.
@jihoon-seo
사용자에게 1. CSP에 있는 자원이 SP에 등록되어 있고, TB에도 등록하는 경우 기능이
API로 노출되면 사용자에게 너무 복잡하게 느껴지지 않을까 싶습니다.
해당 기능은 CB-TB 내부적으로는 활용하고
해당 설명 문구에서는 제외하여, 사용자 혼동을 줄이는 것이 어떨까용?
(일반 사용자가 option=register 를 사용하는 것은 CSP만 가진 자원을 TB에 등록하는 것으로 생각)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.