Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix links to other files #4120

Merged
merged 1 commit into from
Oct 10, 2019
Merged

Fix links to other files #4120

merged 1 commit into from
Oct 10, 2019

Conversation

vitorvezani
Copy link
Contributor

@vitorvezani vitorvezani commented Oct 10, 2019 •
edited
Loading

Suffix .md was needed to make links works

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

(details of the change, additional tests that have been done, reference to the issue for tracking, etc)

@vitorvezani
Fix links to other files
98c23b5 
Suffix `.md` was needed to make links works
wing328
wing328 approved these changes Oct 10, 2019
View reviewed changes
Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix. Did a quick test to confirm the issue and your fix works as expected

@wing328 wing328 marked this pull request as ready for review October 10, 2019 13:30
@wing328 wing328 merged commit 958d7e4 into OpenAPITools:master Oct 10, 2019
@wing328 wing328 added this to the 4.2.0 milestone Oct 10, 2019
@jimschubert
Copy link
Member

@vitorvezani these links are working and will most likely be broken by this merge. See https://openapi-generator.tech/docs/generators

Did you maybe mistake docs/generators.md (used by docusaurus) for https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/README.md (browsable via GitHub)? If so, maybe docs/generators.md needs a note at the top.

cc @wing328

@wing328
Copy link
Member

wing328 commented Oct 11, 2019

I've reverted the change via 10e4246

jimschubert added a commit that referenced this pull request Oct 14, 2019
@jimschubert
Merge branch 'master' into feature-sets-meta
9cdce66 
* master: (78 commits)
  Replaced dashes with underscores in build.gradle files. (#4092)
  [cxf-cdi] use @FormParam for form parameters when it is not Multipart (#4125)
  Corrections to script names (#4135)
  [python] Add missing keywords python (#4134)
  Update PULL_REQUEST_TEMPLATE.md (#4080)
  revert the fix to broken links
  Rename property name from propertyRawName to propertyBaseName (#4124)
  [Go] Fix go.mod and go.sum for 1.13 (#4084)
  [kotlin] add option for non public api (#4089)
  Added new discriminator RawName property to preserve declared discriminator for @JsonTypeInfo annotations (#3320)
  Fix links to other files (#4120)
  [JAVA][JAXRS] Fix parameters validation (#3862)
  Make Resttemplate thread safe by using the withHttpInfo pattern used by many other generated clients (#4049)
  Disabling linting for typescript-fetch (#4110)
  [Kotlin][Client] fix missing curly bracket when the model contains enum property (#4118)
  Fix NPE in Elm path parameter (#4116)
  test aiohttp first (#4117)
  add back ruby client folders
  update petstore samples
  [CLI] Initial implementation for batch generation (#3789)
  ...
@jimschubert jimschubert mentioned this pull request Oct 16, 2019
Merged
5 tasks
@jimschubert
Copy link
Member

I've made changes to the CLI helpers which output generators.md and generators/*.md so that this fix doesn't break the docsite. I attributed the regeneration of generators.md so the commit looks like the commit from this PR. See #4167.

Thanks for the contribution, this was definitely something that needed to be fixed and it adds a lot of value to the community!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wing328 wing328 wing328 approved these changes

Assignees
No one assigned
Labels
Issue: Non-operational
Projects
None yet
Milestone
4.2.0
Development

Successfully merging this pull request may close these issues.
3 participants
@vitorvezani @jimschubert @wing328