serverless-openapi-documenter 0.0.19 → 0.2.2

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.
Files changed (15) hide show
  1. package/README.md +13 -13
  2. package/package.json +3 -3
  3. package/src/definitionGenerator.js +25 -32
  4. package/test/unit/definitionGenerator.spec.js +8 -72
  5. package/test/serverless 1/package-lock.json +0 -15981
  6. package/test/serverless 1/package.json +0 -14
  7. package/test/serverless 1/serverless.docs.yml +0 -62
  8. package/test/serverless 1/serverless.yml +0 -79
  9. package/test/serverless 2/index.js +0 -220
  10. package/test/serverless 2/package-lock.json +0 -12898
  11. package/test/serverless 2/package.json +0 -14
  12. package/test/serverless 2/serverless.docs.yml +0 -62
  13. package/test/serverless 2/serverless.yml +0 -121
  14. package/test/serverless 3/serverless.docs.yml +0 -62
  15. package/test/serverless 3/serverless.yml +0 -88
package/test/serverless 2/package.json DELETED
@@ -1,14 +0,0 @@
1
- {
2
- "name": "serverless-2",
3
- "version": "1.0.0",
4
- "description": "",
5
- "main": "index.js",
6
- "scripts": {
7
- "test": "echo \"Error: no test specified\" && exit 1"
8
- },
9
- "author": "",
10
- "license": "ISC",
11
- "devDependencies": {
12
- "serverless": "^2.72.3"
13
- }
14
- }
package/test/serverless 2/serverless.docs.yml DELETED
@@ -1,62 +0,0 @@
1
- endpoints:
2
- createUser:
3
- summary: Create User
4
- description: Creates a user and then sends a generated password email
5
- requestBody:
6
- description: A user information object
7
- requestModels:
8
- application/json: PutDocumentRequest
9
- pathParams:
10
- - name: username
11
- description: The username for a user to create
12
- schema:
13
- type: string
14
- pattern: "^[-a-z0-9_]+$"
15
- queryParams:
16
- - name: membershipType
17
- description: The user's Membership Type
18
- schema:
19
- type: string
20
- enum:
21
- - premium
22
- - standard
23
- cookieParams:
24
- - name: SessionId
25
- description: A Session ID variable
26
- schema:
27
- type: string
28
- methodResponses:
29
- - statusCode: 201
30
- responseBody:
31
- description: A user object along with generated API Keys
32
- responseModels:
33
- application/json: PutDocumentResponse
34
- - statusCode: 500
35
- responseBody:
36
- description: An error message when creating a new user
37
- responseModels:
38
- application/json: ErrorResponse
39
-
40
- documentation:
41
- models:
42
- - name: ErrorResponse
43
- description: This is an error
44
- contentType: application/json
45
- schema: ${file(models/ErrorResponse.json)}
46
-
47
- - name: PutDocumentResponse
48
- description: PUT Document response model (external reference example)
49
- contentType: application/json
50
- schema: ${file(models/PutDocumentResponse.json)}
51
-
52
- - name: PutDocumentRequest
53
- description: PUT Document request model (inline example)
54
- contentType: application/json
55
- schema:
56
- $schema: http://json-schema.org/draft-04/schema#
57
- properties:
58
- SomeObject:
59
- type: object
60
- properties:
61
- SomeAttribute:
62
- type: string
package/test/serverless 2/serverless.yml DELETED
@@ -1,121 +0,0 @@
1
- service: serverless-openapi-doc-demo
2
- frameworkVersion: ">=2.0.0 < 3.0.0"
3
- provider:
4
- name: aws
5
- runtime: nodejs14.x
6
-
7
- plugins:
8
- - ../../index.js
9
-
10
- functions:
11
- createUser:
12
- handler: handler.create
13
- description: blah blah
14
- summary: a function
15
- events:
16
- - http:
17
- path: create/{username}
18
- method: post
19
- documentation:
20
- summary: Create User
21
- description: Creates a user and then sends a generated password email
22
- tags:
23
- - jesus
24
- externalDocumentation:
25
- url: https://bing.com
26
- description: A link to bing
27
- requestBody:
28
- description: A user information object
29
- requestModels:
30
- application/json: PutDocumentRequest
31
- pathParams:
32
- - name: username
33
- description: The username for a user to create
34
- schema:
35
- type: string
36
- pattern: "^[-a-z0-9_]+$"
37
- queryParams:
38
- - name: membershipType
39
- description: The user's Membership Type
40
- schema:
41
- type: string
42
- enum:
43
- - premium
44
- - standard
45
- cookieParams:
46
- - name: SessionId
47
- description: A Session ID variable
48
- schema:
49
- type: string
50
- methodResponses:
51
- - statusCode: 201
52
- responseBody:
53
- description: A user object along with generated API Keys
54
- responseModels:
55
- application/json: PutDocumentResponse
56
- - statusCode: 500
57
- responseBody:
58
- description: An error message when creating a new user
59
- responseModels:
60
- application/json: ErrorResponse
61
- deleteUser:
62
- handler: handler.delete
63
- events:
64
- - http:
65
- path: delete
66
- method: delete
67
- patchUser:
68
- handler: handler.patch
69
- events:
70
- - httpApi:
71
- path: /patch/
72
- method: PATCH
73
- documentation:
74
- summary: Patch a User
75
- description: Patch details about the user
76
- tags:
77
- - patching
78
- methodResponses:
79
- - statusCode: 200
80
- responseBody:
81
- description: A user object along with generated API Keys
82
- responseModels:
83
- application/json: PutDocumentResponse
84
- custom:
85
- documentation:
86
- description: This is a description of what this does
87
- version: 1.0.0
88
- tags:
89
- - name: jesus
90
- description: jesus was a man
91
- externalDocumentation:
92
- url: https://whitehouse.gov
93
- description: a link to the whitehouse
94
- externalDocumentation:
95
- url: https://google.com
96
- description: A link to google
97
- models:
98
- - name: ErrorResponse
99
- description: This is an error
100
- content:
101
- application/json:
102
- schema: ${file(../models/ErrorResponse.json)}
103
-
104
- - name: PutDocumentResponse
105
- description: PUT Document response model (external reference example)
106
- content:
107
- application/json:
108
- schema: ${file(../models/PutDocumentResponse.json)}
109
-
110
- - name: PutDocumentRequest
111
- description: PUT Document request model (inline example)
112
- content:
113
- application/json:
114
- schema:
115
- $schema: http://json-schema.org/draft-04/schema#
116
- properties:
117
- SomeObject:
118
- type: object
119
- properties:
120
- SomeAttribute:
121
- type: string
package/test/serverless 3/serverless.docs.yml DELETED
@@ -1,62 +0,0 @@
1
- endpoints:
2
- createUser:
3
- summary: Create User
4
- description: Creates a user and then sends a generated password email
5
- requestBody:
6
- description: A user information object
7
- requestModels:
8
- application/json: PutDocumentRequest
9
- pathParams:
10
- - name: username
11
- description: The username for a user to create
12
- schema:
13
- type: string
14
- pattern: "^[-a-z0-9_]+$"
15
- queryParams:
16
- - name: membershipType
17
- description: The user's Membership Type
18
- schema:
19
- type: string
20
- enum:
21
- - premium
22
- - standard
23
- cookieParams:
24
- - name: SessionId
25
- description: A Session ID variable
26
- schema:
27
- type: string
28
- methodResponses:
29
- - statusCode: 201
30
- responseBody:
31
- description: A user object along with generated API Keys
32
- responseModels:
33
- application/json: PutDocumentResponse
34
- - statusCode: 500
35
- responseBody:
36
- description: An error message when creating a new user
37
- responseModels:
38
- application/json: ErrorResponse
39
-
40
- documentation:
41
- models:
42
- - name: ErrorResponse
43
- description: This is an error
44
- contentType: application/json
45
- schema: ${file(models/ErrorResponse.json)}
46
-
47
- - name: PutDocumentResponse
48
- description: PUT Document response model (external reference example)
49
- contentType: application/json
50
- schema: ${file(models/PutDocumentResponse.json)}
51
-
52
- - name: PutDocumentRequest
53
- description: PUT Document request model (inline example)
54
- contentType: application/json
55
- schema:
56
- $schema: http://json-schema.org/draft-04/schema#
57
- properties:
58
- SomeObject:
59
- type: object
60
- properties:
61
- SomeAttribute:
62
- type: string
package/test/serverless 3/serverless.yml DELETED
@@ -1,88 +0,0 @@
1
- service: serverless-openapi-doc-demo
2
- frameworkVersion: ">=3.0.0 < 4.0.0"
3
- provider:
4
- name: aws
5
- runtime: nodejs14.x
6
-
7
- plugins:
8
- - ../../index.js
9
-
10
- functions:
11
- createUser:
12
- handler: handler.create
13
- events:
14
- - http:
15
- path: create/{username}
16
- method: post
17
- documentation:
18
- summary: Create User
19
- description: Creates a user and then sends a generated password email
20
- tags:
21
- - jesus
22
- externalDocumentation:
23
- url: https://bing.com
24
- description: A link to bing
25
- requestBody:
26
- description: A user information object
27
- requestModels:
28
- application/json: PutDocumentRequest
29
- pathParams:
30
- - name: username
31
- description: The username for a user to create
32
- schema:
33
- type: string
34
- pattern: "^[-a-z0-9_]+$"
35
- queryParams:
36
- - name: membershipType
37
- description: The user's Membership Type
38
- schema:
39
- type: string
40
- enum:
41
- - premium
42
- - standard
43
- cookieParams:
44
- - name: SessionId
45
- description: A Session ID variable
46
- schema:
47
- type: string
48
- methodResponses:
49
- - statusCode: 201
50
- responseBody:
51
- description: A user object along with generated API Keys
52
- responseModels:
53
- application/json: PutDocumentResponse
54
- - statusCode: 500
55
- responseBody:
56
- description: An error message when creating a new user
57
- responseModels:
58
- application/json: ErrorResponse
59
-
60
- custom:
61
- documentation:
62
- description: This is a description of what this does
63
- version: 1.0.0
64
- models:
65
- - name: ErrorResponse
66
- description: This is an error
67
- content:
68
- application/json:
69
- schema: ${file(../models/ErrorResponse.json)}
70
-
71
- - name: PutDocumentResponse
72
- description: PUT Document response model (external reference example)
73
- content:
74
- application/json:
75
- schema: ${file(../models/PutDocumentResponse.json)}
76
-
77
- - name: PutDocumentRequest
78
- description: PUT Document request model (inline example)
79
- content:
80
- application/json:
81
- schema:
82
- $schema: http://json-schema.org/draft-04/schema#
83
- properties:
84
- SomeObject:
85
- type: object
86
- properties:
87
- SomeAttribute:
88
- type: string