mark collections api as beta

test plan: generate the api documentation, the collections api should
have a beta warning (but none of the other pages)

Change-Id: I0d7401566cbb3ec9ef76bad79094dad1628ef11c
Reviewed-on: https://gerrit.instructure.com/10720
Reviewed-by: Simon Williams <simon@instructure.com>
Tested-by: Jenkins <jenkins@instructure.com>

app/controllers/collections_controller.rb

@@ -18,6 +18,8 @@
 
 # @API Collections
 #
+# @beta
+#
 # Collections are buckets of content that can be used to organize links to
 # helpful resources. For instance, a user could create a collection storing a
 # set of links to various web sites containing potential discussion questions.

doc/api/fulldoc/html/css/common.css

@@ -38,6 +38,12 @@ h2 {
   font-size: 1.4em;
   margin-top: 30px;
 }
+h3.beta {
+  border: 1px solid black;
+  background-color: #E5E8FF;
+  text-align: center;
+  padding: 6px;
+}
 
 #sidebar {
   background-color: #F2F5F7;

doc/api/topic/html/header.erb

@@ -4,6 +4,9 @@
   <% else %>
     <h1>All API Resources</h1>
   <% end %>
+  <% if @beta %>
+    <h3 class='beta'>BETA: This API resource is not finalized, and there could be breaking changes before its final release.</h3>
+  <% end %>
   <table id='quicklinks'>
   </table>
   <%= yieldall %>

doc/api/topic/html/setup.rb

@@ -23,6 +23,7 @@ def init
   else
     sections :header, [:topic_doc, :method_details_list, [T('method_details')]]
     @resource = object
+    @beta = options[:controllers].any? { |c| c.tag('beta') }
   end
 end
 

lib/api_routes.rb

@@ -30,6 +30,7 @@ YARD::Tags::Library.define_tag("API response field", :response_field)
 YARD::Tags::Library.define_tag("API example request", :example_request)
 YARD::Tags::Library.define_tag("API example response", :example_response)
 YARD::Tags::Library.define_tag("API subtopic", :subtopic)
+YARD::Tags::Library.define_tag("API resource is Beta", :beta)
 
 module YARD::Templates::Helpers
   module BaseHelper