jdoc 0.0.6 → 0.0.7
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 +29 -9
- data/lib/jdoc/property.rb +2 -2
- data/lib/jdoc/version.rb +1 -1
- data/spec/fixtures/schema.yml +14 -0
- data/spec/jdoc/generator_spec.rb +29 -9
- 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: 85929520c47c8da4470fd31511e2ed1fd6339c06
|
|
4
|
+
data.tar.gz: 06fe3649a261ae6c730e6f89e68ef8319a7ee0e1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6df634d0e21e1ac4309b54a9e2999015925fcd7ba129137b4ac53029212b9f414fc46f52c27667519a641187d67c2ffb151daec085ade55212f81d974383e088
|
|
7
|
+
data.tar.gz: aba27404ae762b1822ed67d407b0baef58cf00e052cbf9bad2369eda2679e304367b678330a0943184db894d018ac4085a9c668848ff95bff218bebc04ab44ed
|
data/CHANGELOG.md
CHANGED
|
@@ -11,14 +11,20 @@ An app is a program to be deployed.
|
|
|
11
11
|
|
|
12
12
|
### Properties
|
|
13
13
|
* id - unique identifier of app
|
|
14
|
-
* Example: `01234567-89ab-cdef-0123-456789abcdef`
|
|
14
|
+
* Example: `"01234567-89ab-cdef-0123-456789abcdef"`
|
|
15
15
|
* Type: string
|
|
16
16
|
* Format: uuid
|
|
17
17
|
* ReadOnly: true
|
|
18
18
|
* name - unique name of app
|
|
19
|
-
* Example: `example`
|
|
19
|
+
* Example: `"example"`
|
|
20
20
|
* Type: string
|
|
21
21
|
* Patern: `(?-mix:^[a-z][a-z0-9-]{3,50}$)`
|
|
22
|
+
* private - true if this resource is private use
|
|
23
|
+
* Example: `false`
|
|
24
|
+
* Type: boolean
|
|
25
|
+
* deleted_at - When this resource was deleted at
|
|
26
|
+
* Example: `nil`
|
|
27
|
+
* Type: null
|
|
22
28
|
|
|
23
29
|
### GET /apps
|
|
24
30
|
List existing apps.
|
|
@@ -35,7 +41,9 @@ Content-Type: application/json
|
|
|
35
41
|
|
|
36
42
|
{
|
|
37
43
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
38
|
-
"name": "example"
|
|
44
|
+
"name": "example",
|
|
45
|
+
"private": false,
|
|
46
|
+
"deleted_at": null
|
|
39
47
|
}
|
|
40
48
|
```
|
|
41
49
|
|
|
@@ -48,7 +56,9 @@ Content-Type: application/json
|
|
|
48
56
|
Host: api.example.com
|
|
49
57
|
|
|
50
58
|
{
|
|
51
|
-
"name": "example"
|
|
59
|
+
"name": "example",
|
|
60
|
+
"private": false,
|
|
61
|
+
"deleted_at": null
|
|
52
62
|
}
|
|
53
63
|
```
|
|
54
64
|
|
|
@@ -58,7 +68,9 @@ Content-Type: application/json
|
|
|
58
68
|
|
|
59
69
|
{
|
|
60
70
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
61
|
-
"name": "example"
|
|
71
|
+
"name": "example",
|
|
72
|
+
"private": false,
|
|
73
|
+
"deleted_at": null
|
|
62
74
|
}
|
|
63
75
|
```
|
|
64
76
|
|
|
@@ -77,7 +89,9 @@ Content-Type: application/json
|
|
|
77
89
|
|
|
78
90
|
{
|
|
79
91
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
80
|
-
"name": "example"
|
|
92
|
+
"name": "example",
|
|
93
|
+
"private": false,
|
|
94
|
+
"deleted_at": null
|
|
81
95
|
}
|
|
82
96
|
```
|
|
83
97
|
|
|
@@ -90,7 +104,9 @@ Content-Type: application/json
|
|
|
90
104
|
Host: api.example.com
|
|
91
105
|
|
|
92
106
|
{
|
|
93
|
-
"name": "example"
|
|
107
|
+
"name": "example",
|
|
108
|
+
"private": false,
|
|
109
|
+
"deleted_at": null
|
|
94
110
|
}
|
|
95
111
|
```
|
|
96
112
|
|
|
@@ -100,7 +116,9 @@ Content-Type: application/json
|
|
|
100
116
|
|
|
101
117
|
{
|
|
102
118
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
103
|
-
"name": "example"
|
|
119
|
+
"name": "example",
|
|
120
|
+
"private": false,
|
|
121
|
+
"deleted_at": null
|
|
104
122
|
}
|
|
105
123
|
```
|
|
106
124
|
|
|
@@ -119,7 +137,9 @@ Content-Type: application/json
|
|
|
119
137
|
|
|
120
138
|
{
|
|
121
139
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
122
|
-
"name": "example"
|
|
140
|
+
"name": "example",
|
|
141
|
+
"private": false,
|
|
142
|
+
"deleted_at": null
|
|
123
143
|
}
|
|
124
144
|
```
|
|
125
145
|
|
data/lib/jdoc/property.rb
CHANGED
data/lib/jdoc/version.rb
CHANGED
data/spec/fixtures/schema.yml
CHANGED
|
@@ -25,6 +25,16 @@ definitions:
|
|
|
25
25
|
readOnly: false
|
|
26
26
|
type:
|
|
27
27
|
- string
|
|
28
|
+
private:
|
|
29
|
+
description: true if this resource is private use
|
|
30
|
+
example: false
|
|
31
|
+
type:
|
|
32
|
+
- boolean
|
|
33
|
+
deleted_at:
|
|
34
|
+
description: When this resource was deleted at
|
|
35
|
+
example: null
|
|
36
|
+
type:
|
|
37
|
+
- "null"
|
|
28
38
|
links:
|
|
29
39
|
- description: Create a new app.
|
|
30
40
|
href: "/apps"
|
|
@@ -68,6 +78,10 @@ definitions:
|
|
|
68
78
|
"$ref": "#/definitions/app/definitions/id"
|
|
69
79
|
name:
|
|
70
80
|
"$ref": "#/definitions/app/definitions/name"
|
|
81
|
+
private:
|
|
82
|
+
"$ref": "#/definitions/app/definitions/private"
|
|
83
|
+
deleted_at:
|
|
84
|
+
"$ref": "#/definitions/app/definitions/deleted_at"
|
|
71
85
|
properties:
|
|
72
86
|
app:
|
|
73
87
|
"$ref": "#/definitions/app"
|
data/spec/jdoc/generator_spec.rb
CHANGED
|
@@ -31,14 +31,20 @@ describe Jdoc::Generator do
|
|
|
31
31
|
|
|
32
32
|
### Properties
|
|
33
33
|
* id - unique identifier of app
|
|
34
|
-
* Example: `01234567-89ab-cdef-0123-456789abcdef`
|
|
34
|
+
* Example: `"01234567-89ab-cdef-0123-456789abcdef"`
|
|
35
35
|
* Type: string
|
|
36
36
|
* Format: uuid
|
|
37
37
|
* ReadOnly: true
|
|
38
38
|
* name - unique name of app
|
|
39
|
-
* Example: `example`
|
|
39
|
+
* Example: `"example"`
|
|
40
40
|
* Type: string
|
|
41
41
|
* Patern: `(?-mix:^[a-z][a-z0-9-]{3,50}$)`
|
|
42
|
+
* private - true if this resource is private use
|
|
43
|
+
* Example: `false`
|
|
44
|
+
* Type: boolean
|
|
45
|
+
* deleted_at - When this resource was deleted at
|
|
46
|
+
* Example: `nil`
|
|
47
|
+
* Type: null
|
|
42
48
|
|
|
43
49
|
### GET /apps
|
|
44
50
|
List existing apps.
|
|
@@ -55,7 +61,9 @@ describe Jdoc::Generator do
|
|
|
55
61
|
|
|
56
62
|
{
|
|
57
63
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
58
|
-
"name": "example"
|
|
64
|
+
"name": "example",
|
|
65
|
+
"private": false,
|
|
66
|
+
"deleted_at": null
|
|
59
67
|
}
|
|
60
68
|
```
|
|
61
69
|
|
|
@@ -68,7 +76,9 @@ describe Jdoc::Generator do
|
|
|
68
76
|
Host: api.example.com
|
|
69
77
|
|
|
70
78
|
{
|
|
71
|
-
"name": "example"
|
|
79
|
+
"name": "example",
|
|
80
|
+
"private": false,
|
|
81
|
+
"deleted_at": null
|
|
72
82
|
}
|
|
73
83
|
```
|
|
74
84
|
|
|
@@ -78,7 +88,9 @@ describe Jdoc::Generator do
|
|
|
78
88
|
|
|
79
89
|
{
|
|
80
90
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
81
|
-
"name": "example"
|
|
91
|
+
"name": "example",
|
|
92
|
+
"private": false,
|
|
93
|
+
"deleted_at": null
|
|
82
94
|
}
|
|
83
95
|
```
|
|
84
96
|
|
|
@@ -97,7 +109,9 @@ describe Jdoc::Generator do
|
|
|
97
109
|
|
|
98
110
|
{
|
|
99
111
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
100
|
-
"name": "example"
|
|
112
|
+
"name": "example",
|
|
113
|
+
"private": false,
|
|
114
|
+
"deleted_at": null
|
|
101
115
|
}
|
|
102
116
|
```
|
|
103
117
|
|
|
@@ -110,7 +124,9 @@ describe Jdoc::Generator do
|
|
|
110
124
|
Host: api.example.com
|
|
111
125
|
|
|
112
126
|
{
|
|
113
|
-
"name": "example"
|
|
127
|
+
"name": "example",
|
|
128
|
+
"private": false,
|
|
129
|
+
"deleted_at": null
|
|
114
130
|
}
|
|
115
131
|
```
|
|
116
132
|
|
|
@@ -120,7 +136,9 @@ describe Jdoc::Generator do
|
|
|
120
136
|
|
|
121
137
|
{
|
|
122
138
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
123
|
-
"name": "example"
|
|
139
|
+
"name": "example",
|
|
140
|
+
"private": false,
|
|
141
|
+
"deleted_at": null
|
|
124
142
|
}
|
|
125
143
|
```
|
|
126
144
|
|
|
@@ -139,7 +157,9 @@ describe Jdoc::Generator do
|
|
|
139
157
|
|
|
140
158
|
{
|
|
141
159
|
"id": "01234567-89ab-cdef-0123-456789abcdef",
|
|
142
|
-
"name": "example"
|
|
160
|
+
"name": "example",
|
|
161
|
+
"private": false,
|
|
162
|
+
"deleted_at": null
|
|
143
163
|
}
|
|
144
164
|
```
|
|
145
165
|
|
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.0.
|
|
4
|
+
version: 0.0.7
|
|
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-06-
|
|
11
|
+
date: 2014-06-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: erubis
|