ocs-apiserver/docs/README.txt

0001 README
0002 ======
0003
0004 This directory should be used to place project specfic documentation including
0005 but not limited to project notes, generated API/phpdoc documentation, or
0006 manual files generated or hand written.  Ideally, this directory would remain
0007 in your development environment only and should not be deployed with your
0008 application to it's final production location.
0009
0010
0011 Setting Up Your VHOST
0012 =====================
0013
0014 The following is a sample VHOST you might want to consider for your project.
0015
0016 <VirtualHost *:80>
0017    DocumentRoot "D:/Projekte/ocs-api/public"
0018    ServerName .local
0019
0020    # This should be omitted in the production environment
0021    SetEnv APPLICATION_ENV development
0022
0023    <Directory "D:/Projekte/ocs-api/public">
0024        Options Indexes MultiViews FollowSymLinks
0025        AllowOverride All
0026        Order allow,deny
0027        Allow from all
0028    </Directory>
0029
0030 </VirtualHost>
0031
0032
0033 Added functionality for OCS v1 spec
0034 ======================================
0035
0036   OCS specification:
0037   http://www.freedesktop.org/wiki/Specifications/open-collaboration-services/
0038
0039   ----
0040
0041   Allow delimiter ',' of value of parameter 'categories'
0042
0043   Example:
0044   /content/data?categories=1,2,3
0045   /content/data?categories=1x2x3
0046
0047   ----
0048
0049   Additional URL queries to '/content/data'
0050
0051   xdg_types
0052   package_types
0053
0054   Example:
0055   /content/data?xdg_types=icons,themes,wallpapers
0056   /content/data?package_types=1,2,3
0057
0058   package_types:
0059   1 = AppImage
0060   2 = Android (apk)
0061   3 = OS X compatible
0062   4 = Windows executable
0063   5 = Debian
0064   6 = Snappy
0065   7 = Flatpak
0066   8 = Electron-Webapp
0067   9 = Arch
0068   10 = open/Suse
0069   11 = Redhat
0070   12 = Source Code
0071
0072   ----
0073
0074   Additional data field of '/content/categories'
0075
0076   display_name
0077   parent_id
0078   xdg_type
0079
0080   ----
0081
0082   Additional data field of '/content/data'
0083
0084   xdg_type
0085   download_package_type{n}
0086   download_package_arch{n}
0087
0088   ----
0089
0090   Additional data field of '/content/download'
0091
0092   download_package_type
0093   download_package_arch
0094
0095   ----
0096
0097   Additional API method for preview picture
0098
0099   /content/previewpic/{contentid}
0100
0101   Example:
0102   /content/previewpic/123456789
0103   /content/previewpic/123456789?size=medium