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

Support Patch request #48

Closed
benkiefer opened this Issue Jan 1, 2015 · 5 comments

Comments

Projects
None yet
3 participants
@benkiefer
Contributor

benkiefer commented Jan 1, 2015

We are using the documentation for our spring boot app, and would like to be able to document our patch endpoints. As we discussed over on #47, it sounds like you would like more than changes to ApiVerb, particularly some corresponding changes the ui project. Anything else you can think of?

@toranb

This comment has been minimized.

Show comment
Hide comment
@toranb

toranb Jan 1, 2015

Another quick question - we didn't see any test code for the PUT verb - would/should we write a test for PATCH (and PUT as tech debt) ?

toranb commented Jan 1, 2015

Another quick question - we didn't see any test code for the PUT verb - would/should we write a test for PATCH (and PUT as tech debt) ?

@fabiomaffioletti

This comment has been minimized.

Show comment
Hide comment
@fabiomaffioletti

fabiomaffioletti Jan 1, 2015

Owner

Go for it guys, it's an excellent improvement. Regarding the ui, the modification should be very simple: just put something like

.PUT {
    padding-top : 5px;
    background-color: #5bc0de;
}

at the top of the jsondoc.jsp page and everything should be fine. I'll take car of bringing your modification to the new project I am working on (jsondoc-ui-webjar), which is still experimental.

It would be very good to write a test for the PATCH verb, so I'll be glad if you could add it. Regarding the PUT test code, I would very appreciate if you could add a test as well, otherwise I agree to put it as tech debt. Thank you

Owner

fabiomaffioletti commented Jan 1, 2015

Go for it guys, it's an excellent improvement. Regarding the ui, the modification should be very simple: just put something like

.PUT {
    padding-top : 5px;
    background-color: #5bc0de;
}

at the top of the jsondoc.jsp page and everything should be fine. I'll take car of bringing your modification to the new project I am working on (jsondoc-ui-webjar), which is still experimental.

It would be very good to write a test for the PATCH verb, so I'll be glad if you could add it. Regarding the PUT test code, I would very appreciate if you could add a test as well, otherwise I agree to put it as tech debt. Thank you

@benkiefer

This comment has been minimized.

Show comment
Hide comment
@benkiefer

benkiefer Jan 1, 2015

Contributor

Let me know if there is anything else needed. The css change you mentioned was also needed in the css file in the webjar project. Other than that, I was able to stand up a quick example app with a patch method and verify that everything looks great.

Contributor

benkiefer commented Jan 1, 2015

Let me know if there is anything else needed. The css change you mentioned was also needed in the css file in the webjar project. Other than that, I was able to stand up a quick example app with a patch method and verify that everything looks great.

@benkiefer

This comment has been minimized.

Show comment
Hide comment
@benkiefer

benkiefer Jan 2, 2015

Contributor

Also, I tried out the spring boot module, and it works great. Thanks again!

Contributor

benkiefer commented Jan 2, 2015

Also, I tried out the spring boot module, and it works great. Thanks again!

@fabiomaffioletti

This comment has been minimized.

Show comment
Hide comment
@fabiomaffioletti

fabiomaffioletti Jan 2, 2015

Owner

Glad to hear that. I'll maybe set up so more documentation on how to use the spring boot module. Your pull request has been merged and I just released version 1.0.9 on Maven Central. It should take a few hours to be available. Thank you very much for this!

Owner

fabiomaffioletti commented Jan 2, 2015

Glad to hear that. I'll maybe set up so more documentation on how to use the spring boot module. Your pull request has been merged and I just released version 1.0.9 on Maven Central. It should take a few hours to be available. Thank you very much for this!

@fabiomaffioletti fabiomaffioletti added this to the 1.0.7 milestone Jan 2, 2015

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