=== Helix Sync Clients [[post_helix_sync_v1_clients]] ==== `POST /helix_sync/v1/clients` Creates a new client workspace for use by helix sync. This method can have multiple implementations. To use a "Helix Versioning Engine Project" as defined in <<appendix_hve_project_json>>, you will need to ensure the `HVE_PROJECT_PATH` is set. This can be set on a request, or on the system as a whole. ===== Request Headers [cols="2*", options="header"] |=== | Header Name | Notes | `Authorization` | See <<authentication>> | `Accept` | `application/json` | `Content-Type` | `application/json` | `X-Perforce-Helix_Web_Services-*` | See <<per_request_configuration>> |=== ===== Request Body JSON Requires a JSON object with the following parameters: [cols="2*", options="header"] |=== | Property | Description | `project` | The project ID, see <<appendix_project_json>> | `device` | A unique ID for the device in use. | `root` | The directory path on the user's machine to use. |=== ===== Response Headers [cols="2*", options="header"] |=== | Header Name | Notes | `Content-Type` | `application/json` |=== ===== Response Body JSON Returns a JSON object with a `client` property, indicating the client name to use.
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#6 | 17323 | tjuricek |
Revise the documentation to use the JVM-based asciidoctor. This will generate the DocBook XML. I'm still ironing out exactly what the CD process is here. |
||
#5 | 17090 | tjuricek |
Revised documentation based on edits received (on paper). Removed Helix Web Services ruby client references, since there is no publication plan for this API. |
||
#4 | 16106 | tjuricek |
Revise the URLs for Helix Sync client workspaces. Added *stubs* for deleting the clients for a user, implementations will follow. |
||
#3 | 16096 | tjuricek | Rename '/helix_sync' URLs to '/helix-sync' | ||
#2 | 15757 | tjuricek |
Add resolve implementation for submitting from shelves for Helix Sync Includes additional concepts for creating a "helix sync shelf client" vs a "helix sync device client". It's expected that there's basically one shelf client per user per project. The "device" client is an additional client per user per project per machine. The HWS services will submit via the "shelf client". The resolve implementation remains untested at the moment in order to get the client changes in the hands of Helix Sync developers. |
||
#1 | 15622 | tjuricek |
Move source code to 'source/' subdirectory of branch. build/ will remain where it is. |
||
//guest/perforce_software/helix-web-services/main/doc/helix_sync/clients.asc | |||||
#3 | 15479 | tjuricek | Added a basic "HVE project" implementation for creating clients. | ||
#2 | 15435 | tjuricek |
Add proposed HTTP methods for Helix Sync. It's a little unclear to me why you would need a local root directory to create the shared shelving changelist for a particular project (and user). So I didn't add that. |
||
#1 | 15242 | tjuricek | Add Helix Sync stubs and documentation |