docs: fix broken links and clarify myAPI variable in README#283
Open
mixelburg wants to merge 1 commit intoAPIDevTools:mainfrom
Open
docs: fix broken links and clarify myAPI variable in README#283mixelburg wants to merge 1 commit intoAPIDevTools:mainfrom
mixelburg wants to merge 1 commit intoAPIDevTools:mainfrom
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
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.
Fixes two README issues reported separately:
Fixes #281 — The API documentation links were pointing to
apidevtools.com/swagger-parser/docs/(returns 404). This PR updates all the broken/docs/paths to the correct working URLs:docs/swagger-parser.html#...→swagger-parser.html#...docs/#circular-refs→#circular-refsdocs/→/Fixes #280 — The example code snippets used a bare
myAPIvariable with no context on what it represents (a file path, a URL, an object?). Added a comment and variable declarationconst myAPI = "./path/to/my-api.yaml";above each example to make it immediately clear.