Merge pull request #52 from alphagov/api-reference-is-optional

Fix bug with api_path config being mandatory and bump version
alphagov · Sep 13, 2018 · c583614 · c583614
2 parents 2040ce6 + 3c1d64a
commit c583614
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## 1.6.1
+
+### Make `api_path` configuration optional
+
+A bug in the previous release prevented the docs from being generated if
+`api_path` was missing. This is now fixed.
+
 ## 1.6.0
 
 Version 1.6.0 adds API reference generation, and improves the search function.

diff --git a/lib/govuk_tech_docs/api_reference/api_reference_extension.rb b/lib/govuk_tech_docs/api_reference/api_reference_extension.rb
@@ -17,7 +17,8 @@ def initialize(app, options_hash = {}, &block)
 
         # If no api path then just return.
         if @config['api_path'].to_s.empty?
-          raise 'No api path defined in tech-docs.yml'
+          @api_parser = false
+          return
         end
 
         # Is the api_path a url or path?

diff --git a/lib/govuk_tech_docs/version.rb b/lib/govuk_tech_docs/version.rb
@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "1.6.0".freeze
+  VERSION = "1.6.1".freeze
 end