yard-restful 1.2.3 → 1.2.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/README.markdown +4 -1
- data/Rakefile +1 -0
- data/templates/default/class/html/resource_details.erb +3 -0
- metadata +12 -15
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 5245817cb4174c3f22ea63b16be2ab9c5ad6375b
|
4
|
+
data.tar.gz: bbf1425d6037334dd4b25c86a5a16868eefe0334
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 0b39ca4fa3801b7d6927b446206f4a8cebb73f851f52431b4e44b3ef4187fce971d2a3e51157fdd656e8b66ca75d1ab9f30042f710a28f0d610a12d2bf3dee3d
|
7
|
+
data.tar.gz: f7b67f5b34a472688cacc3b429b0fa4c389841c62659b8f29b08dc20f381c105bdcf3dd113516349ca1924357d955515c6ce57f1a0ff6f50b308acce87a67377
|
data/README.markdown
CHANGED
@@ -29,10 +29,13 @@ You'll probably want to add these to your .gitignore as well
|
|
29
29
|
So you'll have to re-genenarte your API on every machine. This should encourage more up to dateness
|
30
30
|
|
31
31
|
## Execution
|
32
|
-
It is recommended that you use a .yardopts file
|
32
|
+
It is recommended that you use a .yardopts file. The sample below
|
33
|
+
assumes you are using Markdown in your YARD, as does the sample
|
34
|
+
documentation.
|
33
35
|
|
34
36
|
--title "My API Documentation"
|
35
37
|
--plugin restful
|
38
|
+
--markup markdown
|
36
39
|
--readme API_README
|
37
40
|
--output-dir ./public/api
|
38
41
|
app/models/**/*.rb
|
data/Rakefile
CHANGED
@@ -10,6 +10,7 @@ begin
|
|
10
10
|
gem.email = ''
|
11
11
|
gem.homepage = "https://github.com/kraft001/yard-restful"
|
12
12
|
gem.authors = ['Konstantin Rafalsky']
|
13
|
+
gem.licenses = ['MIT']
|
13
14
|
gem.add_dependency("yard", '~>0.8.3')
|
14
15
|
gem.files = Dir.glob("{lib,templates}/**/*").concat(["Rakefile"])
|
15
16
|
gem.extra_rdoc_files = ['VERSION', 'README.markdown']
|
@@ -28,6 +28,9 @@
|
|
28
28
|
<% else %>
|
29
29
|
<%= yieldall(object: meth, item: :response_field, title: 'Response Fields') %>
|
30
30
|
<% end %>
|
31
|
+
<% if meth.tags(:raise).size > 0 %>
|
32
|
+
<%= yieldall(object: meth, item: :raise, title: 'Errors') %>
|
33
|
+
<% end %>
|
31
34
|
|
32
35
|
<% if meth.tags(:example_request).size > 0 %>
|
33
36
|
<div class="examples">
|
metadata
CHANGED
@@ -1,30 +1,27 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard-restful
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.2.
|
5
|
-
prerelease:
|
4
|
+
version: 1.2.4
|
6
5
|
platform: ruby
|
7
6
|
authors:
|
8
7
|
- Konstantin Rafalsky
|
9
8
|
autorequire:
|
10
9
|
bindir: bin
|
11
10
|
cert_chain: []
|
12
|
-
date:
|
11
|
+
date: 2017-05-22 00:00:00.000000000 Z
|
13
12
|
dependencies:
|
14
13
|
- !ruby/object:Gem::Dependency
|
15
14
|
name: yard
|
16
15
|
requirement: !ruby/object:Gem::Requirement
|
17
|
-
none: false
|
18
16
|
requirements:
|
19
|
-
- - ~>
|
17
|
+
- - "~>"
|
20
18
|
- !ruby/object:Gem::Version
|
21
19
|
version: 0.8.3
|
22
20
|
type: :runtime
|
23
21
|
prerelease: false
|
24
22
|
version_requirements: !ruby/object:Gem::Requirement
|
25
|
-
none: false
|
26
23
|
requirements:
|
27
|
-
- - ~>
|
24
|
+
- - "~>"
|
28
25
|
- !ruby/object:Gem::Version
|
29
26
|
version: 0.8.3
|
30
27
|
description: A customized plugin for Yardoc that produces API documentation for Restful
|
@@ -36,7 +33,9 @@ extra_rdoc_files:
|
|
36
33
|
- README.markdown
|
37
34
|
- VERSION
|
38
35
|
files:
|
36
|
+
- README.markdown
|
39
37
|
- Rakefile
|
38
|
+
- VERSION
|
40
39
|
- lib/yard-restful.rb
|
41
40
|
- lib/yard-restful/html_blocks_helper.rb
|
42
41
|
- lib/yard-restful/rest_filters.rb
|
@@ -58,29 +57,27 @@ files:
|
|
58
57
|
- templates/default/layout/html/index.erb
|
59
58
|
- templates/default/layout/html/layout.erb
|
60
59
|
- templates/default/layout/html/setup.rb
|
61
|
-
- README.markdown
|
62
|
-
- VERSION
|
63
60
|
homepage: https://github.com/kraft001/yard-restful
|
64
|
-
licenses:
|
61
|
+
licenses:
|
62
|
+
- MIT
|
63
|
+
metadata: {}
|
65
64
|
post_install_message:
|
66
65
|
rdoc_options: []
|
67
66
|
require_paths:
|
68
67
|
- lib
|
69
68
|
required_ruby_version: !ruby/object:Gem::Requirement
|
70
|
-
none: false
|
71
69
|
requirements:
|
72
|
-
- -
|
70
|
+
- - ">="
|
73
71
|
- !ruby/object:Gem::Version
|
74
72
|
version: '0'
|
75
73
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
76
|
-
none: false
|
77
74
|
requirements:
|
78
|
-
- -
|
75
|
+
- - ">="
|
79
76
|
- !ruby/object:Gem::Version
|
80
77
|
version: '0'
|
81
78
|
requirements: []
|
82
79
|
rubyforge_project:
|
83
|
-
rubygems_version:
|
80
|
+
rubygems_version: 2.6.8
|
84
81
|
signing_key:
|
85
82
|
specification_version: 4
|
86
83
|
summary: Yardoc plugin for Restful web services
|