Merge branch 'master' of ssh://github.com/onesimus-systems/onesimus-s…

…ystems.github.io

CNAME

@@ -1 +1 @@
-onesimussystems.com
+blog.onesimussystems.com

_config.yml

@@ -1,9 +1,9 @@
 # Site settings
 title: Onesimus Systems
-email: onesimussystems@gmail.com
+email: lee@onesimussystems.com
 description: "Official blog and news source for Onesimus Systems."
 baseurl: ""
-url: "http://onesimussystems.com"
+url: "http://blog.onesimussystems.com"
 github_username:  onesimus-systems
 
 # Build settings

_posts/2015-06-30-dandelion-6-released.md

@@ -18,4 +18,4 @@ From this point forward, all major releases will have a code name along with the
 
 The time has come! Take back the time you've wasted keeping up with written logs! Download Dandelion "Phoenix" and taste the true power of logging.
 
-Download version 6 on [Github today](https://github.com/onesimus-systems/dandelion/releases/tag/v6.0.0)!
+Download version 6 on [Github today](https://github.com/onesimus-systems/dandelion/releases/tag/v6.0.4)!

_posts/2015-11-15-dandelion-610-feature-freeze.md

@@ -0,0 +1,20 @@
+---
+layout: post
+title:  "Dandelion 6.1.0 Feature Freeze"
+author: "Lee Keitel"
+date:   2015-11-15
+categories: dandelion
+---
+
+As the smell of turkey and your weird aunt Margaret grow ever stronger, Dandelion has been shaping up for its 6.1.0 release. The scheduled release date is December 19. Beginning today, 6.1.0 will be in feature freeze. This means no new features will be added or developed for 6.1. I'll be focusing on getting the installation and upgrade procedures working correctly, update any lingering documentation, and fix any bugs in existing features.
+
+As of now the new feature list of 6.1 includes:
+
+- Disable users (to keep name information)
+- Single-threaded log comments
+- Permalink for logs
+- Validation of API parameters
+- Better internal handling of permissions
+- Misc. bug fixes and internal improvements
+
+There will be an upgrade path from 6.0.x to 6.1. There are a few database changes that need to be ran before using. All of this will be taken care of in a PHP script. Installation of a fresh instance won't change much. You can always see the current development version on the develop branch [on GitHub](https://github.com/onesimus-systems/dandelion/tree/develop). Report any bugs to the [Issue Tracker](https://github.com/onesimus-systems/dandelion/issues).

dandelion/api/dandelion.md

@@ -0,0 +1,50 @@
+---
+layout: page-no-title
+title: Dandelion - API - Dandelion
+permalink: /dandelion/api/dandelion/
+---
+
+Dandelion - API Documentation - Dandelion
+-----------------------------------------
+
+Module name: dandelion
+
+Notes:
+
+- Added in version 6.1.0
+
+Index
+-----
+
+- [version](#version)
+
+version
+-------
+
+**Endpoint**: `/api/dandelion/version`
+
+**Parameters**: None
+
+**Description**: Get the version of Dandelion.
+
+**Example Return Data**:
+
+{% highlight json %}
+{
+	"data": {"6.1.0"}
+}
+{% endhighlight %}
+
+**Returned Values**:
+
+- (string) Version number of Dandelion.
+
+**Permissions Needed**:
+
+- None
+
+[⇑ Top](#index)
+
+* * * * *
+
+[⇐ API Documentation](/dandelion/api)

dandelion/api/index.md

@@ -13,13 +13,16 @@ All requests must pass the parameter `apikey` containing the user's key. If this
 
 Below are links to docs for the available endpoints, their paths, parameters, and what they do.
 
+If a documented endpoint has a Dandelion Version section, that is the minimum version necessary for the endpoint to work. If no version exists, then the endpoint has existed since v6.0.0 when the API was introduced.
+
 Each request will return a standard JSON object in the format:
 
 {% highlight json %}
 {
 	"status": "Status message",
 	"errorcode": 0,
 	"module": "Requested module",
+	"requestTime": "12.01ms",
 	"data": {}
 }
 {% endhighlight %}
@@ -40,6 +43,8 @@ The `module` field is simply the module that was requested. Example, `logs`, `ch
 
 The `data` field is where the good stuff is. This can range from a string, to a JS object. You will have to refer to the documentation for each endpoint to know what kind of data to expect.
 
+The `requestTime` field is how long the API call took to complete. This time does not include the time for setup and teardown the request. Added in v6.1.0.
+
 API Enpoints
 ------------
 
@@ -51,8 +56,10 @@ API Enpoints
 
 [User Settings](/dandelion/api/user-settings)
 
-[Rights Management](/dandelion/api/rights)
+[Groups Management](/dandelion/api/groups)
 
 [User Management](/dandelion/api/users)
 
 [Key Management](/dandelion/api/key-mgnt)
+
+[Dandelion](/dandelion/api/dandelion)

dandelion/api/key-mgnt.md

@@ -7,23 +7,53 @@ permalink: /dandelion/api/key-mgnt/
 Dandelion - API Documentation - Key Management
 ----------------------------------------------
 
-Module name: keyanager
+Module name: keymanager
 
 Index
 -----
 
+- [get](#get)
 - [test](#test)
 - [revoke](#revoke)
 - [generate](#generate)
 
+get
+---
+
+**Endpoint**: `/api/key/get`
+
+**Parameters**: None
+
+**Description**: Gets the api key of the use associated with the request. Yes right now it's useless, but soon it won't be.
+
+**Example Return Data**:
+
+{% highlight json %}
+{
+	"data": "apikey123456"
+}
+{% endhighlight %}
+
+**Permissions Needed**:
+
+- None
+
+**Dandelion Version**
+
+- 6.1.0
+
+[⇑ Top](#index)
+
+* * * * *
+
 test
 ----
 
 **Endpoint**: `/api/key/test`
 
 **Parameters**: None
 
-**Description**: Tests that the apikey is valid. This is a useful endpoint for extensions. An easy way to check the success is to check the `errorcode` field of the return object. A value of 0 means success, other values indicate failure means failure.
+**Description**: Tests that the apikey is valid. This is a useful endpoint for extensions. An easy way to check the success is to check the `errorcode` field of the return object. A value of 0 means success, other values indicate failure.
 
 **Example Return Data**:
 
@@ -52,7 +82,7 @@ revoke
 |-----------|--------|---------|----------|
 | `uid`     | int    | User ID | false    |
 
-**Description**: Revoke the API key for the user with `uid`. The default value for `uid` is the ID associated with the API key being used to make the request. Because of this, if `uid` is not defined, the key being used with no longer be valid.
+**Description**: Revoke the API key for the user with `uid`. The default value for `uid` is the ID associated with the API key being used to make the request. Because of this, if `uid` is not defined, the key being used will no longer be valid.
 
 **Example Return Data**:
 

dandelion/api/rights.md

@@ -1,13 +1,13 @@
 ---
 layout: page-no-title
-title: Dandelion - API - Rights
-permalink: /dandelion/api/rights/
+title: Dandelion - API - Groups
+permalink: /dandelion/api/groups/
 ---
 
 Dandelion - API Documentation - Rights
 --------------------------------------
 
-Module name: rights
+Module name: groups
 
 Index
 -----
@@ -22,7 +22,7 @@ Index
 getlist
 -------
 
-**Endpoint**: `/api/rights/getlist`
+**Endpoint**: `/api/groups/getlist`
 
 **Parameters**: None
 
@@ -65,7 +65,7 @@ getlist
 getgroup
 --------
 
-**Endpoint**: `/api/rights/getgroup`
+**Endpoint**: `/api/groups/getgroup`
 
 **Parameters**: `groupid`
 
@@ -114,7 +114,7 @@ getgroup
 create
 ------
 
-**Endpoint**: `/api/rights/create`
+**Endpoint**: `/api/groups/create`
 
 **Parameters**: `name`, `rights`
 
@@ -148,7 +148,7 @@ create
 edit
 ----
 
-**Endpoint**: `/api/rights/edit`
+**Endpoint**: `/api/groups/edit`
 
 **Parameters**: `groupid`, `rights`
 
@@ -182,7 +182,7 @@ edit
 delete
 ------
 
-**Endpoint**: `/api/rights/delete`
+**Endpoint**: `/api/groups/delete`
 
 **Parameters**: `groupid`
 
@@ -215,7 +215,7 @@ delete
 getuserrights
 -------------
 
-**Endpoint**: `/api/rights/getuserrights`
+**Endpoint**: `/api/groups/getuserrights`
 
 **Parameters**: None
 
@@ -266,4 +266,3 @@ Full permission list:
 * * * * *
 
 [⇐ API Documentation](/dandelion/api)
-