Add SwaggerEditor link to Readme #143
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
README.md
Outdated
| @@ -9,3 +9,6 @@ | |||
| [](https://github.com/swissfintechinnovations/ca-mortgage/blob/main/LICENSE) | |||
|
|
|||
| This is the official SFTI repo for the mortgage API. Documentations may be found in the [Wiki](https://github.com/swissfintechinnovations/ca-mortgage/wiki). | |||
|
|
|||
| We refer to the SwaggerEditor for a graphical representation and source-file based documentation of the latest API state: | |||
There was a problem hiding this comment.
May I suggest the following wording instead: "An easy-to-read representation of the Mortgage API is accessible via the following link (please note that if you click on the following link, you will leave GitHub unless you use your browser's "open link in new tab/window" feature):"?
There was a problem hiding this comment.
@juergen-petry I'd suggest not to mention any redirection comments. I hope everyone knows how links work these days and it distracts from the essential. Do you agree? If yes, I'd adopt your suggestion.
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 Readme