Skip to content

Commit e2d31c6

Browse files
author
Matt Singleton
committed
add tagging source options
1 parent 0e48e64 commit e2d31c6

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

content/api.html

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -469,6 +469,11 @@ <h3 id="tags">Tags</h3>
469469
to hosts by name (<code>yourhost.example.com</code>) or id
470470
(<code>12345</code>).
471471
</p>
472+
<p>
473+
The component of your infrastructure responsible for a tag is identified by
474+
a <code>source</code>. Valid sources are: nagios, hudson, jenkins, users,
475+
feed, chef, puppet, git, bitbucket, fabric, capistrano.
476+
</p>
472477
</div>
473478
</div>
474479

@@ -479,7 +484,9 @@ <h4 id="tags-get">Get Tags</h4>
479484
Return a mapping of tags to hosts for your whole infrastructure.
480485
</p>
481486
<h5>Arguments</h5>
482-
<%= no_args %>
487+
<ul class="arguments">
488+
<%= argument("source", "Only show tags from a particular source. Otherwise shows all tags.", :default => "None") %>
489+
</ul>
483490
</div>
484491
<%= right_side_div %>
485492
<h5>Signature</h5>
@@ -502,7 +509,10 @@ <h4 id="tags-get-host">Get Host Tags</h4>
502509
Return the list of tags that apply to a given host.
503510
</p>
504511
<h5>Arguments</h5>
505-
<%= no_args %>
512+
<ul class="arguments">
513+
<%= argument("source", "Only show tags from a particular source. Otherwise shows all tags.", :default => "None") %>
514+
<%= argument("by_source", "Return tags grouped by source.", :default => "False") %>
515+
</ul>
506516
</div>
507517
<%= right_side_div %>
508518
<h5>Signature</h5>
@@ -527,6 +537,7 @@ <h4 id="tags-add">Add Tags to a Host</h4>
527537
<h5>Arguments</h5>
528538
<ul class="arguments">
529539
<%= argument("tags", "A list of tags to apply to the host") %>
540+
<%= argument("source", "The source of the tags (e.g. chef, puppet).", :default => "users") %>
530541
</ul>
531542
</div>
532543
<%= right_side_div %>
@@ -552,6 +563,7 @@ <h4 id="tags-update">Update Host Tags</h4>
552563
<h5>Arguments</h5>
553564
<ul class="arguments">
554565
<%= argument("tags", "A list of tags") %>
566+
<%= argument("source", "The source of the tags (e.g. chef, puppet).", :default => "users") %>
555567
</ul>
556568
</div>
557569
<%= right_side_div %>
@@ -575,7 +587,9 @@ <h4 id="tags-remove">Remove Host Tags</h4>
575587
This end point allows you to update all tags for a given host.
576588
</p>
577589
<h5>Arguments</h5>
578-
<%= no_args %>
590+
<ul class="arguments">
591+
<%= argument("source", "The source of the tags (e.g. chef, puppet).", :default => "users") %>
592+
</ul>
579593
</div>
580594
<%= right_side_div %>
581595
<h5>Signature</h5>

0 commit comments

Comments
 (0)