-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
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
[Slim] Update main documentation #839
Conversation
Kotlin server README has been used as a ref. There are no links to apis and models docs, because Slim codegen doesn't provide them right now. Also I'm not sure about white spaces, but we can change it anytime in future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The revised doc looks much better 👍
@@ -1,12 +1,58 @@ | |||
# OpenAPI generated server | |||
# php-base - PHP Slim Server library for OpenAPI Petstore *_/ ' \" =end -- \\r\\n \\n \\r |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We may want to update php-base
(packageName) with a better default value in another PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@wing328 Got any suggestion for default value?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ybelenko since it's used by both PHP client and server generators, what about naming the default as "openapi-package"?
* [Slim] Update main documentation Kotlin server README has been used as a ref. There are no links to apis and models docs, because Slim codegen doesn't provide them right now. Also I'm not sure about white spaces, but we can change it anytime in future. * [Slim] Refresh samples
PR checklist
./bin/
to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.sh
and./bin/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\
.master
,3.3.x
,4.0.x
. Default:master
.Description of the PR
@wing328 suggested to use Kotlin readme as a ref. The only significant difference is that I've removed links to apis and models docs as soon as SlimCodegen doesn't provide them for now.
@jebentier @dkarlovi @mandrean @jfastnacht @ackintosh