[rust-server] Added client documentation to rust-server #2159
Conversation
|
👍 Thanks for opening this issue! The team will review the labels and make any necessary changes. |
Herrera93
force-pushed
the
rust_server_docs
branch
from
a6ccc6b
to
c2f9668
Compare
There was a problem hiding this comment.
Thanks for the PR! I always ❤️ people who want to improve the documentation.
A few comments below - nothing major.
I think I have an overarching question, though, as to approach. Currently, this information should all be in the doc comments. Is that not the case? I guess my concern is about the maintenance burden of having the information duplicated between doc comments and files in the repo.
So I think I want to understand why you think this is necessary. I'm very open to merging this if there is a need not met by the current approach.
...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/RustServerCodegen.java
Outdated
Show resolved
Hide resolved
modules/openapi-generator/src/main/resources/rust-server/README.mustache
Show resolved
Hide resolved
|
@bjgill Mainly There are doc comments but they only contain operation and model descriptions but do not contain parameters or properties descriptions. I wanted to create centralized documentation for the client that can be explored in an interactive way so if there is a possibility that the user wants to expose the client. |
Herrera93
force-pushed
the
rust_server_docs
branch
from
fe22bf9
to
0ce084f
Compare
|
Ah, right. I see. In general, my preference would be to improve the doc comments rather than adding this parallel documentation. However, you've done this useful work, so I'll not let the perfect stand in the way of the good. I'll give this a couple of days for other reviews, and then 🚢 |
|
@Herrera93 thanks for the PR 👍 @bjgill thanks for the review. Merging this into master to avoid too many outstanding PRs in this repo. |
* master: (40 commits) [Python] remove default value from being fallback to example (#2213) Add petstore integration tests to Ruby OAS3 client (#2211) Gradle - make GenerateTask properties optional (#2185) skip bats installation (#2198) Something in the dependencies changed. This switch is no longer needed. (#1850) Use oauth token for basic bearer auth in Rust. (#2161) Fix missing nullable (#2189) Enable error handling in Java WebClient library, fixes #1243 (#1244) [core] fix referenced enum case (#2175) rest-template: allow array parameters in path using collectionFormat (#2177) update go petstore samples Fix string types for cpprestsdk client generator (#1676) update kotline samples Remove API Key Authentication code for go when cookie is used. (#1601) changed the package install instructions to install the .tgz package … (#1989) okhttp-gson: allow array parameters in path using collectionFormat (#2137) [Ruby] Fix regualr expression in error message (#2069) (#2139) [kotlin][client] bytearray conversion (#2166) [rust-server] Added client documentation to rust-server (#2159) [Java] Getter/Setter naming convention not followed in generated models (#2095) ...
…#2159) * Added client documentation to rust-server * Removed comments * Removed go auth example
PR checklist
./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.shand./bin/openapi3/security/{LANG}-petstore.shif 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\.master,. Default:3.4.x,4.0.xmaster.Description of the PR
I added documentation for the client generated by
rust-server. This documentation is based onrustclient docs with some modifications to fit the use of variables.I modified
RustServerCodegento includeStringas 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:
HashMap<String, HashMap<String, String>>