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.

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

[Rust Server] Fix server-writing docs for rust-server #19367

Merged
merged 2 commits into from
Aug 17, 2024

Conversation

richardwhiuk
Copy link
Contributor

The generated README says

You can use the example server and client as a basis for your own code.
See below for [more detail on implementing a server](#writing-a-server).

but the Writing a server section was removed in #3552, and replaced by a briefer note under Using the generated library.

This fixes the link to point to a section that exists.

This fix was contributed by @kw217

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Rust Technical Committee: @frol @farcaller @paladinzh @jacob-pro

Fix broken link in generated README for rust-server.
@wing328 wing328 removed the rust label Aug 17, 2024
@wing328 wing328 merged commit 172fafe into OpenAPITools:master Aug 17, 2024
19 checks passed
@wing328 wing328 added this to the 7.8.0 milestone Aug 17, 2024
@richardwhiuk richardwhiuk deleted the rust-server-readme-fix branch August 20, 2024 13:28
@kw217
Copy link
Contributor

kw217 commented Sep 27, 2024

Thanks @richardwhiuk and @wing328 !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants