cds import : updating doc for asyncapi import #111
Merged
Conversation
This file contains hidden or 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
|
Is the note about OpenAPI in line 206 still valid? |
muskansethi1
commented
May 3, 2023
|
|
||
| | Option | Description | | ||
| | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `--keep-namespace` | Keep the namespace of the existing service. Otherwise, the namespace is changed to the file's base name when converting the file to CSN.<br> **Note:** In this example, it would be still `API_BUSINESS_PARTNER`. | |
There was a problem hiding this comment.
Where do you think that we should give a description of this option? @renejeglinsky
There was a problem hiding this comment.
Overall I felt, that we do have here a lot of reference content that maybe should find a home somewhere else. I'm not sure yet where that home would be. Having said that, I think that it's sufficient to have options documented in CLI help. Everything else is nice to have if it makes sense. So here, we don't use --keep-namespace anymore that's why I don't see the need to explain it here.
It's valid, I will edit it to make it more general |
renejeglinsky
approved these changes
May 3, 2023
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.
Update in documentation for asyncapi import