jdoc 0.1.9 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -0
- data/example-api-documentation.md +1 -0
- data/lib/jdoc/schema.rb +9 -0
- data/lib/jdoc/version.rb +1 -1
- data/template.md.erb +1 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c55cb2cd6e9fb7c413955cb27466ea7166210666
|
|
4
|
+
data.tar.gz: 4dd21023b7af214e1eb448d3bd3410e00e4a0e36
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: cd723d33c3bfeff779db5a8725829c4895d38a63c7ea6ee787a6c31d6879e95c0e41577975115f2c8688f874325b9f6d353777e43451d6375e275f369654f0cb
|
|
7
|
+
data.tar.gz: daba310565e86e8d309582676311b396a76bccbf48b9e4c932b0d616107db36c2d92a66ce62c26df4f1ad4bd00726f526f8fcba9ce7f188c8a07739fb568f1b6
|
data/CHANGELOG.md
CHANGED
data/lib/jdoc/schema.rb
CHANGED
|
@@ -21,6 +21,15 @@ module Jdoc
|
|
|
21
21
|
@json_schema.title
|
|
22
22
|
end
|
|
23
23
|
|
|
24
|
+
# @return [String, nil] Description property of this schema
|
|
25
|
+
# @example
|
|
26
|
+
# schema.description #=> "A schema for a small example API."
|
|
27
|
+
def description
|
|
28
|
+
if @json_schema.description
|
|
29
|
+
"#{@json_schema.description}\n\n"
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
|
|
24
33
|
# @return [String]
|
|
25
34
|
# @example
|
|
26
35
|
# host_with_port #=> "api.example.com"
|
data/lib/jdoc/version.rb
CHANGED
data/template.md.erb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jdoc
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ryo Nakamura
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2014-
|
|
11
|
+
date: 2014-07-01 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: activesupport
|