Merge pull request #439 from alphagov/component-documentation-api

Serve govuk-component documentation as JSON
alphagov · Aug 15, 2014 · e604489 · e604489
2 parents 7cc1233 + 5e40135
commit e604489
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/app/controllers/root_controller.rb b/app/controllers/root_controller.rb
@@ -1,7 +1,7 @@
 class RootController < ApplicationController
   layout false
 
-  before_filter :validate_template_param
+  before_filter :validate_template_param, :except => [:govuk_component_docs]
 
   rescue_from ActionView::MissingTemplate, :with => :error_404
 
@@ -15,6 +15,11 @@ def raw_govuk_component_template
     render_raw_template("govuk_component", params[:template])
   end
 
+  def govuk_component_docs
+    component_doc = JSON.parse(File.read(File.join(Rails.root, 'app', 'views', 'govuk_component', 'docs.json')))
+    render :json => component_doc
+  end
+
   NON_LAYOUT_TEMPLATES = %w(
     alpha_label
     barclays_epdq

diff --git a/app/views/govuk_component/docs.json b/app/views/govuk_component/docs.json
@@ -0,0 +1,8 @@
+[
+  {
+    "id": "beta_label",
+    "name": "Beta Banner",
+    "description": "A banner than indicates content is in a beta phase",
+    "fixtures": {}
+  }
+]
diff --git a/config/routes.rb b/config/routes.rb
@@ -3,6 +3,7 @@
   controller "root", :format => false do
     get "/templates/:template.raw.html.erb" => :raw_root_template
     get "/templates/govuk_component/:template.raw.html.erb" => :raw_govuk_component_template
+    get "/templates/govuk_component/docs" => :govuk_component_docs
     get "/templates/:template.html.erb" => :template
   end