api_sketch 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f99281e8061a73b54dd8af84f8fd076e023702e2
-  data.tar.gz: ce73daea2b0aa4850805c6dbe639f999c77593f5
+  metadata.gz: 8e6352e10485a0dd6459be63fa12a04346b34098
+  data.tar.gz: 37407cc18194ff48ad3144ce084241fe3690e55d
 SHA512:
-  metadata.gz: 6f46717a180c8ad6936f0aed8301244034a8244422cacfce639a51d74446669ffa40ad96aae12bae119d03317eb5e7555950b0fc80ea692eee0568f629059ad3
-  data.tar.gz: bbc627ba68f4b96a3e12b1adaadec474d2699e35d531107c7bfd88dc071dbe9d84e5fdf61f4e29625f582763bd941a5a4f3de341ba7b246e985d34eaac509002
+  metadata.gz: f9a6db241e83a09c79c931298a8de9f0ac2252ac11243990f448fc88a161198c608f3f4d0ef76d2ed4a7cab0042b15cf86bc06b5b5844a03d68626f7ebe1e340
+  data.tar.gz: 4ed5f29efcbc4cb6e9e963fc44eaeae94ba9ddd16e654e6eb833d4eb60b77f32b8cdf7aad9e713cb93f756f5d57dac9bbc17674b75c0af5f552ab0920531c2fe

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.1.5 / 2015-06-23
+- Add links to index page.
+- Add sample_call keyword for CURL examples
+
 # 0.1.4 / 2015-06-22
 - Fix issue with excessive document brackets at examples server
 

data/README.md

@@ -145,6 +145,8 @@ Each `resource` could have many `responses` with different `context`. For exampl
 
 Resource `parameters` section's syntax it the same as for `resource` request parameters.
 
+Resource attribute `sample_call` is used to provide example request to this endpoint. You may put thare some CURL request commands or some any other text data.
+
 ```ruby
 resource "Update user profile" do # Resource name
   action "update"
@@ -371,6 +373,8 @@ resource "Update user profile" do # Resource name
       end
     end
   end
+  
+  sample_call 'curl -v -H "Authorization: Token token=CFd6Sh_dCRT1DhwQQg9N" -H "Accept: application/json" -H "Content-type: application/json" -X PUT -d \'{ "user" : { "email" : "user.test@mail.com", "password" : "test_password" } }\' http://:domain/api/users/me.json'
 end
 ```
 

data/examples/api_project/resources/places.rb

@@ -63,6 +63,8 @@ resource "Create place" do
     end
   end
 
+  sample_call 'curl -v -H "Authorization: Token token=CFd6Sh_dCRT1DhwQQg9N" -H "Accept: application/json" -H "Content-type: application/json" -X POST -d \'{ "name" : "Cafe", "area" : "123.5" }\' http://:domain/api/places.json'
+
 end
 
 

data/lib/api_sketch/model/resource.rb

@@ -1,6 +1,6 @@
 class ApiSketch::Model::Resource < ApiSketch::Model::Base
 
-  attr_accessor :namespace, :action, :path, :http_method, :format, :headers, :parameters, :responses
+  attr_accessor :namespace, :action, :path, :http_method, :format, :headers, :parameters, :responses, :sample_call
 
   # TODO: update this method to provide better id that is used as part of filename
   def id

data/lib/api_sketch/templates/bootstrap/index.html.erb

@@ -61,7 +61,9 @@
           <div id="endpoints">
             <% @resources.sort_by { |r| r.id }.each do |resource| %>
               <div class="panel panel-default">
-                <div class="panel-heading"><%= resource.name %></div>
+                <div class="panel-heading">
+                  <a href="<%= nesting_path_prefix %>docs/<%= @generator.filename_for(resource) %>"><%= resource.name %></a>
+                </div>
                 <div class="panel-body">
                   <%= "#{resource.http_method} #{resource.path}" %>
                   <% if !(resource.description.nil? || resource.description.empty?) %>

data/lib/api_sketch/templates/bootstrap/resource.html.erb

@@ -201,6 +201,13 @@
               <% end %>
             </div>
           <% end %>
+
+          <% if !(@resource.sample_call.nil? || @resource.sample_call.empty?) %>
+            <div class="panel panel-default">
+              <div class="panel-heading">Sample Call</div>
+              <div class="panel-body"><%= @resource.sample_call %></div>
+            </div>
+          <% end %>
       </div>
     </div>
 

data/lib/api_sketch/version.rb

@@ -1,3 +1,3 @@
 module ApiSketch
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_sketch
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Alexey Suhoviy