| OLD | NEW |
| 1 <html> | 1 <html> |
| 2 <head> | 2 <head> |
| 3 <meta charset="UTF-8"/> | 3 <meta charset="UTF-8"/> |
| 4 <title>Analysis Server API Specification</title> | 4 <title>Analysis Server API Specification</title> |
| 5 </head> | 5 </head> |
| 6 <body> | 6 <body> |
| 7 <h1>Analysis Server API Specification</h1> | 7 <h1>Analysis Server API Specification</h1> |
| 8 <h1 style="color:#999999">WORKING DRAFT - Version <version>0.3</version></h1
> | 8 <h1 style="color:#999999">WORKING DRAFT - Version <version>0.3</version></h1
> |
| 9 <p> | 9 <p> |
| 10 This document contains a specification of the API provided by | 10 This document contains a specification of the API provided by |
| (...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 51 <p> | 51 <p> |
| 52 There is no guarantee concerning the order in which responses | 52 There is no guarantee concerning the order in which responses |
| 53 will be returned, but there is a guarantee that the server will | 53 will be returned, but there is a guarantee that the server will |
| 54 process requests in the order in which they are sent as long as | 54 process requests in the order in which they are sent as long as |
| 55 the transport mechanism also makes this guarantee. Responses can | 55 the transport mechanism also makes this guarantee. Responses can |
| 56 be returned in an order that is different from the order in | 56 be returned in an order that is different from the order in |
| 57 which the requests were received because some requests take | 57 which the requests were received because some requests take |
| 58 longer to process than others. | 58 longer to process than others. |
| 59 </p> | 59 </p> |
| 60 <p> | 60 <p> |
| 61 Every request is required to have two fields and may have an | 61 Every request is required to have two fields and may have two |
| 62 optional third field. The first required field is the ‘id’ | 62 additional optional fields. The first required field is the ‘id’ |
| 63 field, which is only used by the server to associate a response | 63 field, which is only used by the server to associate a response |
| 64 with the request that generated the response. The second | 64 with the request that generated the response. The second |
| 65 required field is the ‘method’ field, which is used to determine | 65 required field is the ‘method’ field, which is used to determine |
| 66 what the server is being requested to do. The optional field is | 66 what the server is being requested to do. One optional field is |
| 67 the ‘params’ field, whose structure is dependent on the method | 67 the ‘params’ field, whose structure is dependent on the method |
| 68 being requested. The structure of this field is described with | 68 being requested. The structure of this field is described with |
| 69 each request for which it is required. | 69 each request for which it is required. The other optional field |
| 70 is the 'clientRequestTime' field, which is a number indicating |
| 71 the time at which the client made the request (milliseconds |
| 72 since epoch). Providing clientRequestTime helps us track |
| 73 how responsive analysis server is to client requests |
| 74 and better address any issues that occur. |
| 70 </p> | 75 </p> |
| 71 <p> | 76 <p> |
| 72 Every response has up to three fields. The first field is the | 77 Every response has up to three fields. The first field is the |
| 73 ‘id’ field, which is always present and whose value is the | 78 ‘id’ field, which is always present and whose value is the |
| 74 identifier that was passed to the request that generated the | 79 identifier that was passed to the request that generated the |
| 75 response. The second field is the ‘error’ field, which is only | 80 response. The second field is the ‘error’ field, which is only |
| 76 present if an error was encountered while processing the | 81 present if an error was encountered while processing the |
| 77 request. The third field is the ‘result’ field, whose structure | 82 request. The third field is the ‘result’ field, whose structure |
| 78 is dependent on the method being responded to, and is described | 83 is dependent on the method being responded to, and is described |
| 79 with each request that will produce it. | 84 with each request that will produce it. |
| (...skipping 3655 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3735 <h2>Errors</h2> | 3740 <h2>Errors</h2> |
| 3736 <p> | 3741 <p> |
| 3737 This section contains a list of all of the errors that are | 3742 This section contains a list of all of the errors that are |
| 3738 produced by the server and the data that is returned with each. | 3743 produced by the server and the data that is returned with each. |
| 3739 </p> | 3744 </p> |
| 3740 <p> | 3745 <p> |
| 3741 TBD | 3746 TBD |
| 3742 </p> | 3747 </p> |
| 3743 </body> | 3748 </body> |
| 3744 </html> | 3749 </html> |
| OLD | NEW |