Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixes #223,#330,#357 #358

Closed
wants to merge 10 commits into from
1 change: 1 addition & 0 deletions _includes/sidemenu_worker.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ <h4>Reference</h4>
<li><a {% if page.url == "/worker/reference/api/index.html" %}class="selected"{% endif %} href="/worker/reference/api">REST/HTTP API</a></li>
<li><a {% if page.url == "/worker/libraries/index.html" %}class="selected"{% endif %} href="/worker/libraries">Client Libraries</a></li>
<li><a {% if page.url == "/worker/reference/environment/index.html" %}class="selected"{% endif %} href="/worker/reference/environment">System Environment</a></li>
<li><a {% if page.url == "/worker/reference/security/index.html" %}class="selected"{% endif %} href="/worker/reference/security">Security</a></li>
<li><a {% if page.url == "/worker/reference/configuration/index.html" %}class="selected"{% endif %} href="/worker/reference/configuration">Configuration</a></li>
<li><a {% if page.url == "/worker/reference/security/index.html" %}class="selected" {% endif %}href="/worker/reference/security" title="Security">Securing your Workers</a></li>
<li><a {% if page.url == "/worker/reference/dotworker/index.html" %}class="selected"{% endif %} href="/worker/reference/dotworker">.worker Files</a></li>
Expand Down
3 changes: 3 additions & 0 deletions cache/reference/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,9 @@ The success or failure of a request is indicated by an HTTP status code. A 2xx s
<tr>
<td>401</td><td>Unauthorized: The OAuth token is either not provided or invalid.</td>
</tr>
<tr>
<td>403</td><td>Project suspected, resource limits.</td>
</tr>
<tr>
<td>404</td><td>Not Found: The resource, project, or endpoint being requested doesn’t exist.</td>
</tr>
Expand Down
2 changes: 0 additions & 2 deletions mq/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,6 @@ <h3>Response</h3>
<p>Make sure you've <a href="/mq/reference/configuration">set up your configuration file</a>.</p>

{% highlight php %}
<?php
$ironmq = new IronMQ();
$ironmq->postMessage("test_queue", "Hello world!");
{% endhighlight %}</div>
Expand Down Expand Up @@ -234,7 +233,6 @@ <h3>Response</h3>
<p>Make sure you've <a href="/mq/reference/configuration">set up your configuration file</a>.</p>

{% highlight php %}
<?php
$ironmq = new IronMQ();
$ironmq->getMessage("test_queue");
{% endhighlight %}</div>
Expand Down
3 changes: 3 additions & 0 deletions mq/reference/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,9 @@ The success failure for request is indicated by an HTTP status code. A 2xx statu
<tr>
<td>401</td><td>Unauthorized: The OAuth token is either not provided or invalid.</td>
</tr>
<tr>
<td>403</td><td>Project suspected, resource limits.</td>
</tr>
<tr>
<td>404</td><td>Not Found: The resource, project, or endpoint being requested doesn’t exist.</td>
</tr>
Expand Down
28 changes: 28 additions & 0 deletions worker/reference/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,31 @@ breadcrumbs:

IronWorker provides a RESTful HTTP API to allow you to interact programmatically with our service and your workers.

<section id="toc">
<h3>Table of Contents</h3>
<ul>
<li><a href="#endpoints">Endpoints</a></li>
<li><a href="#authentication">Authentication</a></li>
<li>
<a href="#requests">Requests</a>
<ul>
<li><a href="#base-url">Base URL</a></li>
<li><a href="#pagination">Pagination</a></li>
</ul>
</li>
<li>
<a href="#responses">Responses</a>
<ul>
<li><a href="#status-codes">Status Codes</a></li>
<li><a href="#exponential-backoff">Exponential Backoff</a></li>
</ul>
</li>
<li><a href="#code-packages">Code Packages</a></li>
<li><a href="#tasks">Tasks</a></li>
<li><a href="#scheduled-tasks">Scheduled Tasks</a></li>
</ul>
</section>

## Endpoints

### Code Packages
Expand Down Expand Up @@ -177,6 +202,9 @@ The success failure for request is indicated by an HTTP status code. A 2xx statu
<tr>
<td>401</td><td>Invalid authentication: The OAuth token is either not provided or invalid.</td>
</tr>
<tr>
<td>403</td><td>Project suspected, resource limits.</td>
</tr>
<tr>
<td>404</td><td>Invalid endpoint: The resource, project, or endpoint being requested doesn’t exist.</td>
</tr>
Expand Down
4 changes: 2 additions & 2 deletions worker/reference/security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ IronWorker provides an AWS security group and [IP ranges](https://forums.aws.ama
<table>
<thead>
<tr>
<th>EC2 Security Group</th><th>Account ID</th><th>Security Group String</th>
<th>EC2 Security Group</th><th>Account ID</th><th>Security Group String</th><th>Security Group ID</th>
</tr>
</thead>
<tbody>
<tr>
<td>simple_worker_sg</td><td>7227-1646-5567</td><td>722716465567/simple_worker_sg</td>
<td>simple_worker_sg</td><td>7227-1646-5567</td><td>722716465567/simple_worker_sg</td><td>sg-0d500c64</td>
</tr>
</tbody>
</table>
Expand Down