= Helix Web Services Guide: 2016.1.0 Alpha Tristan Juricek <tjuricek@perforce.com> v2016.1.0.alpha :toc: right :sectlinks: include::00_preface.asc[] include::01_overview.asc[] include::02_deploy.asc[] include::03_configuration.asc[] include::04_clientprog.asc[] == HTTP Method Reference === Default Methods Most paths start with the platform version in the URL. include::paths-default.adoc[] === Alpha Methods The following methods are in an alpha state, which means that they are not considered stable and may change in future versions. If you choose to work with these methods your client code is not guaranteed to work in the future. include::paths-alpha.adoc[] === JSON Definitions include::definitions.adoc[] include::10_appendices.asc[]
| # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #17 | 19860 | swellard | Remove reference to Java SDK | ||
| #16 | 19665 | swellard | Remove unsupported client docs | ||
| #15 | 19012 | tjuricek | Revised Java client SDK, added ApiClient reference, restructured documentation. | ||
| #14 | 19011 | tjuricek |
Removing a lot of "definition" references which will be replaced by language-specific model sections. This breaks the DocBook styling mechanism when placed later in the document. |
||
| #13 | 19010 | tjuricek |
Reorganize the main information flow of the documentation. The HTTP Method Reference was moved towards the end, since it is probably only going to be referenced for creating a new client SDK. Sections were added for "models" for each language. |
||
| #12 | 18946 | tjuricek | Add preliminary docs for PHP and Python client SDKs | ||
| #11 | 18943 | tjuricek | Integrate Ruby client SDK into user guide. | ||
| #10 | 18941 | tjuricek | JavaScript Client SDK integration into the user guide. | ||
| #9 | 18924 | tjuricek |
First cut at including the Java client SDK docs as part of the main guide. This includes a new "object model" that knows how to generally convert to the different Java types, which greatly simplifies the templating logic. The final result is likely going to need some real ironing out. I'm going to basically get things wired up, and iterate on overall format and styling once all languages are represented. |
||
| #8 | 18820 | tjuricek | Change version in documentation. | ||
| #7 | 18819 | tjuricek | Split out the alpha-tagged paths into a separate documentation chapter. | ||
| #6 | 18798 | tjuricek |
Report supported platform versions in the default request, if we accept application/json. Added a method to the Java client SDK to check if it's a supported version. |
||
| #5 | 18693 | tjuricek |
Move from swagger2markdown project to custom asciidoc generator. This gives us flexibility to do include the context path, for example, or alter the output fairly easily. While StringTemplate is a little tricky to get to know, it works pretty well for our needs, and offers a lot more flexibility for reorganization later. Note: I might change the status method to be version-specific, but in the future, we'll have a method "what versions do you support" which will *not* be version-specific. |
||
| #4 | 18551 | tjuricek |
Switch to using swagger-based HTTP methods. Remove old java_client. The swagger documentation generates asciidoc, which is included in the current user guide. We lose some control over the formatting. |
||
| #3 | 18033 | tjuricek |
As it turns out the :toc declaration doesn't seem to affect the DocBook XML, so put it back. Add a minor note in the internal guide regarding SSL. |
||
| #2 | 17339 | tjuricek |
Removed obsolete documentation no longer relevant to JVM-based installation, and created framework for new installation. I do not have exact details on the new system just yet, but I know we'll want the PDF as part of the installation. |
||
| #1 | 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. |
||
| //guest/perforce_software/helix-web-services/main/source/doc/hws.asc | |||||
| #2 | 17225 | tjuricek | Adding hws-internal documentation for internal users. | ||
| #1 | 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. |
||
| //guest/perforce_software/helix-web-services/main/source/doc/p4ws.asc | |||||
| #2 | 15717 | tjuricek |
Added notes on post-install configuration and uninstallation. It's unclear to me if we should invest significant time into configuration yet or not. |
||
| #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/p4ws.asc | |||||
| #6 | 15530 | tjuricek | Add basic development guide | ||
| #5 | 15090 | tjuricek |
Update _proposed_ API for project services. This is *very likely* to change, and will not be implemented until reviewed. |
||
| #4 | 15038 | tjuricek | Document 'login' auth method and client programming overview. | ||
| #3 | 15032 | tjuricek |
Starting config and doc revisions. System is now broken while revisions underway. Configuration of the p4d connection is now done via a single HWSSettings middleware object injected into the Rack env. The HWSP4Cleanup middleware now cleans up any p4 injected into the Rack env. The Auth::App class now mostly just contains one method to generate a p4 ticket. /auth/v1/login. Added yard documentation for the main project. Yard docs have been reconfigured to dump into build/ directories. This should probably be done with each release. Hm... The top level rake file contains a task, 'all:doc', to update our documentation. This should probably be run for each checkin. Hm... Specs are now using Rack::Test on top of a 'live' p4d. I'd suggest you still use the p4util mechanism, which now dumps to a /tmp folder, so we can safely add P4IGNORE rules back into your local .p4config file. Old 'perforce' application now called 'helix_versioning_engine'. Removing cache data. Helix Sync may be slow. It may also get axed. We'll see. |
||
| #2 | 14980 | tjuricek |
Starting to make revisions to the Asciidoc guide. These are just revisions to the preable sections. |
||
| #1 | 13555 | tjuricek |
Starting Asciidoc conversion of documentation. Removed the "Shared Quality" document, that basically is online now at: https://confluence.perforce.com:8443/display/PWS/Quality+Assurance Adding some topology graphviz images used for online documentation. |
||