Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 408145

Summary: Orion Server API wiki pages appear to be out of date
Product: [ECD] Orion Reporter: Chris McGee <cbmcgee>
Component: DocAssignee: Project Inbox <orion.doc-inbox>
Status: RESOLVED WONTFIX QA Contact:
Severity: normal    
Priority: P3    
Version: unspecified   
Target Milestone: ---   
Hardware: PC   
OS: Linux   
Whiteboard:

Description Chris McGee CLA 2013-05-15 11:46:34 EDT
I have been working on a custom server that implements the server API's (file, prefs, workspace, etc.). I have been using the wiki pages as a guide for the implementation: http://wiki.eclipse.org/Orion/Server_API. The Orion version I am using is the latest available in the git repo.

I have noticed a number of discrepancies between these pages and the way that the orion interacts with the node server.

A couple of examples:

In the File API (http://wiki.eclipse.org/Orion/Server_API/File_API) there are a number of entries showing the property "Directory" with a stringified boolean value (e.g. "false" or "true"). When I implemented it this way it was clear that the editor was expecting literal boolean values (ie. false or true).

In a number of places in the File API and Workspace API it shows the "Location" and "ContentLocation" properties having full URI string values (e.g. "Location" : "http://example.com/file/MyProj/myfile.txt") but when my server returns full URI's the editor produces error. I have found through experimentation that the editor prefers relative paths (e.g. "Location" : "/file/MyProj/myfile.txt").

Once I started reverse engineering the protocol using the node server things started working much better.
Comment 1 John Arthorne CLA 2015-05-05 14:39:00 EDT
Closing as part of a mass clean up of inactive bugs. Please reopen if this problem still occurs or is relevant to you. For more details see:

https://dev.eclipse.org/mhonarc/lists/orion-dev/msg03444.html