Bug 1446858 - EAP 7 documentation: Developing Web Services Applications: Code sample incorrect: Resteasy JSAPI method name wrong
Summary: EAP 7 documentation: Developing Web Services Applications: Code sample incor...
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: JBoss Enterprise Application Platform 6
Classification: JBoss
Component: Documentation
Version: unspecified
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: ---
Assignee: Nidhi
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-04-29 23:07 UTC by Richard Robinson
Modified: 2017-05-02 09:49 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-05-02 09:49:11 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Richard Robinson 2017-04-29 23:07:21 UTC
Document URL: https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html/developing_web_services_applications/developing_jax_rs_web_services#resteasy_javascript_api

Section Number and Name: 2.13.1, About the RESTEasy JavaScript API 

Describe the issue: 2nd of 2 code samples appears to be wrong.

Suggestions for improvement: 
2nd code sample in this section says: 

"Foo.put({$entity: text});"

But the first code sample, to which it refers, has a post method (not a put method). 

The corrected method call should be: 
"Foo.post({$entity: text});" (as there's no put method in the previous code sample, but there are get and post methods)


Additional information:

Comment 1 Richard Robinson 2017-04-29 23:09:26 UTC
It would be also helpful if the documentation included a bit more information as to how exactly the JavaScript API is intended to be used.

Comment 2 Richard Robinson 2017-04-29 23:11:16 UTC
Final note: this "bug" is in the EAP 7 documention, not EAP 6; logged the bug here however EAP 7 is not listed as a choice. (Is the EAP 7 bugzilla elsewhere?).

Comment 3 Betty Prioux 2017-05-01 13:08:35 UTC
(In reply to Richard Robinson from comment #2)
> Final note: this "bug" is in the EAP 7 documention, not EAP 6; logged the
> bug here however EAP 7 is not listed as a choice. (Is the EAP 7 bugzilla
> elsewhere?).

Richard, thanks for reporting these issues.
We'll get a writer to handle this one as needed for EAP 7.

To enter future bugs against EAP 7.x, go to this project:
https://issues.jboss.org/projects/JBEAP/


Note You need to log in before you can comment on or make changes to this bug.