Browse Source

API update version to V1.11 and document changes

Kano 14 years ago
parent
commit
977aecc4a6
2 changed files with 14 additions and 2 deletions
  1. 13 1
      API-README
  2. 1 1
      api.c

+ 13 - 1
API-README

@@ -200,6 +200,8 @@ The list of requests - a (*) means it requires privileged access - and replies a
                none           There is no reply section just the STATUS section
                none           There is no reply section just the STATUS section
                               stating success or failure saving the cgminer config
                               stating success or failure saving the cgminer config
                               to filename
                               to filename
+                              The filename is optional and will use the cgminer
+                              default if not specified
 
 
  quit (*)      none           There is no status section but just a single "BYE"
  quit (*)      none           There is no status section but just a single "BYE"
                               reply before cgminer quits
                               reply before cgminer quits
@@ -283,7 +285,17 @@ miner.php - an example web page to access the API
 Feature Changelog for external applications using the API:
 Feature Changelog for external applications using the API:
 
 
 
 
-API V1.10
+API V1.11
+
+Modified API commands:
+ 'save' no longer requires a filename (use default if not specified)
+
+'save' incorrectly returned status E (error) on success before.
+It now correctly returns S (success)
+
+----------
+
+API V1.10 (cgminer v2.4.1)
 
 
 Added API commands:
 Added API commands:
  'stats'
  'stats'

+ 1 - 1
api.c

@@ -158,7 +158,7 @@ static const char SEPARATOR = '|';
 #define SEPSTR "|"
 #define SEPSTR "|"
 static const char GPUSEP = ',';
 static const char GPUSEP = ',';
 
 
-static const char *APIVERSION = "1.10";
+static const char *APIVERSION = "1.11";
 static const char *DEAD = "Dead";
 static const char *DEAD = "Dead";
 static const char *SICK = "Sick";
 static const char *SICK = "Sick";
 static const char *NOSTART = "NoStart";
 static const char *NOSTART = "NoStart";