Skip to content
GitLab

[rust-server] Added client documentation to rust-server

Merged Administrator requested to merge github/fork/joylabs/rust_server_docs into master

Created by: Herrera93

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, ./bin/security/{LANG}-petstore.sh and ./bin/openapi3/security/{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\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language. @frol @farcaller @bjgill

Description of the PR

I added documentation for the client generated by rust-server. This documentation is based on rust client docs with some modifications to fit the use of variables.

I modified RustServerCodegen to include String as a primitive type and determine if a model property is a primitive, this way it won't show a reference to file if the property is primitive.

Some modifications that need to be done are: