@cparra/apexdocs 2.12.0-alpha.0 → 2.12.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.
- package/docs/Main/nspc.SampleClass.md +192 -192
- package/docs/Misc-Group/nspc.MemberGrouping.md +13 -13
- package/docs/Misc-Group/nspc.SampleRestResource.md +106 -106
- package/docs/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +14 -14
- package/docs/README.md +81 -81
- package/package.json +1 -1
- package/src/transpiler/openapi/__tests__/open-api-docs-processor.spec.ts +2 -2
|
@@ -1,192 +1,192 @@
|
|
|
1
|
-
# nspc.SampleClass
|
|
2
|
-
|
|
3
|
-
`NAMESPACEACCESSIBLE`
|
|
4
|
-
|
|
5
|
-
`APIVERSION: 54`
|
|
6
|
-
|
|
7
|
-
`STATUS: ACTIVE`
|
|
8
|
-
|
|
9
|
-
This is a class description. This class relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
10
|
-
But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
|
|
11
|
-
You can also link using this syntax [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
**Group** Main
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
**CustomAnnotation** A Custom annotation
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
**Author** Cesar Parra
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
**See** [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
24
|
-
|
|
25
|
-
## Constructors
|
|
26
|
-
### My Super Group
|
|
27
|
-
##### `SampleClass()`
|
|
28
|
-
|
|
29
|
-
`NAMESPACEACCESSIBLE`
|
|
30
|
-
|
|
31
|
-
Constructs a SampleClass without any arguments. This relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
32
|
-
|
|
33
|
-
###### Throws
|
|
34
|
-
|
|
35
|
-
|Exception|Description|
|
|
36
|
-
|---|---|
|
|
37
|
-
|`ExcName`|some exception|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
**CustomAnnotation** A Custom method annotation
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
**See** [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
44
|
-
|
|
45
|
-
###### Example
|
|
46
|
-
```apex
|
|
47
|
-
// Example
|
|
48
|
-
SampleClass sampleInstance = new SampleClass();
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
---
|
|
53
|
-
### Other
|
|
54
|
-
##### `SampleClass(String argument1, String argument2)`
|
|
55
|
-
|
|
56
|
-
Constructs a SampleClass with an argument.
|
|
57
|
-
|
|
58
|
-
###### Parameters
|
|
59
|
-
|
|
60
|
-
|Param|Description|
|
|
61
|
-
|---|---|
|
|
62
|
-
|`argument1`|Argument1 definition|
|
|
63
|
-
|`argument2`|Argument2 definition|
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
## Fields
|
|
67
|
-
### Common Constants
|
|
68
|
-
|
|
69
|
-
* `ANOTHER_CONSTANT` → `String`
|
|
70
|
-
* `A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ] - This is a constant.
|
|
71
|
-
* `listOfStrings` → `List<String>`
|
|
72
|
-
---
|
|
73
|
-
### 'General' Constants
|
|
74
|
-
|
|
75
|
-
* `GENERAL_ANOTHER_CONSTANT` → `String`
|
|
76
|
-
* `GENERAL_A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ] - This is a constant.
|
|
77
|
-
---
|
|
78
|
-
### Other variables
|
|
79
|
-
|
|
80
|
-
* `someVariable` → `String`
|
|
81
|
-
---
|
|
82
|
-
## Properties
|
|
83
|
-
|
|
84
|
-
### `AnotherProp` → `Decimal`
|
|
85
|
-
|
|
86
|
-
`AURAENABLED`
|
|
87
|
-
|
|
88
|
-
This is a Decimal property.
|
|
89
|
-
|
|
90
|
-
### `MyProp` → `String`
|
|
91
|
-
|
|
92
|
-
`AURAENABLED`
|
|
93
|
-
`DEPRECATED`
|
|
94
|
-
|
|
95
|
-
This is a String property.
|
|
96
|
-
|
|
97
|
-
---
|
|
98
|
-
## Methods
|
|
99
|
-
### A method group
|
|
100
|
-
##### `static sampleMethod(String argument1, String argument2)`
|
|
101
|
-
|
|
102
|
-
`NAMESPACEACCESSIBLE`
|
|
103
|
-
|
|
104
|
-
Executes commands based on the passed in argument.
|
|
105
|
-
|
|
106
|
-
###### Parameters
|
|
107
|
-
|
|
108
|
-
|Param|Description|
|
|
109
|
-
|---|---|
|
|
110
|
-
|`argument1`|Argument1 to debug|
|
|
111
|
-
|`argument2`|Argument2 to debug|
|
|
112
|
-
|
|
113
|
-
###### Return
|
|
114
|
-
|
|
115
|
-
**Type**
|
|
116
|
-
|
|
117
|
-
String
|
|
118
|
-
|
|
119
|
-
**Description**
|
|
120
|
-
|
|
121
|
-
Empty string
|
|
122
|
-
|
|
123
|
-
###### Example
|
|
124
|
-
```apex
|
|
125
|
-
String result = SampleClass.testMethod();
|
|
126
|
-
System.debug(result);
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
##### `static anotherSampleMethod(String arg1)`
|
|
131
|
-
|
|
132
|
-
Something here
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
**Arg1** The arg1 description
|
|
136
|
-
|
|
137
|
-
---
|
|
138
|
-
### Other
|
|
139
|
-
##### `static call()`
|
|
140
|
-
|
|
141
|
-
Calls the method. This methods allows you to call it.
|
|
142
|
-
|
|
143
|
-
---
|
|
144
|
-
## Enums
|
|
145
|
-
### InnerEnum
|
|
146
|
-
|
|
147
|
-
`NAMESPACEACCESSIBLE`
|
|
148
|
-
|
|
149
|
-
This is a namespace accessible enum
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
---
|
|
153
|
-
## Classes
|
|
154
|
-
### AnotherInnerClass
|
|
155
|
-
|
|
156
|
-
Inner class belonging to SampleClass.
|
|
157
|
-
|
|
158
|
-
#### Properties
|
|
159
|
-
|
|
160
|
-
##### `InnerProp` → `String`
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
Description of the inner property.
|
|
164
|
-
|
|
165
|
-
---
|
|
166
|
-
#### Methods
|
|
167
|
-
##### `innerMethod()`
|
|
168
|
-
|
|
169
|
-
Executes from the inner class.
|
|
170
|
-
|
|
171
|
-
---
|
|
172
|
-
|
|
173
|
-
### InnerClass
|
|
174
|
-
|
|
175
|
-
Inner class belonging to SampleClass.
|
|
176
|
-
|
|
177
|
-
#### Properties
|
|
178
|
-
|
|
179
|
-
##### `InnerProp` → `String`
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
Description of the inner property.
|
|
183
|
-
|
|
184
|
-
---
|
|
185
|
-
#### Methods
|
|
186
|
-
##### `innerMethod()`
|
|
187
|
-
|
|
188
|
-
Executes from the inner class.
|
|
189
|
-
|
|
190
|
-
---
|
|
191
|
-
|
|
192
|
-
---
|
|
1
|
+
# nspc.SampleClass
|
|
2
|
+
|
|
3
|
+
`NAMESPACEACCESSIBLE`
|
|
4
|
+
|
|
5
|
+
`APIVERSION: 54`
|
|
6
|
+
|
|
7
|
+
`STATUS: ACTIVE`
|
|
8
|
+
|
|
9
|
+
This is a class description. This class relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
10
|
+
But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
|
|
11
|
+
You can also link using this syntax [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
**Group** Main
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
**CustomAnnotation** A Custom annotation
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
**Author** Cesar Parra
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
**See** [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
24
|
+
|
|
25
|
+
## Constructors
|
|
26
|
+
### My Super Group
|
|
27
|
+
##### `SampleClass()`
|
|
28
|
+
|
|
29
|
+
`NAMESPACEACCESSIBLE`
|
|
30
|
+
|
|
31
|
+
Constructs a SampleClass without any arguments. This relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
32
|
+
|
|
33
|
+
###### Throws
|
|
34
|
+
|
|
35
|
+
|Exception|Description|
|
|
36
|
+
|---|---|
|
|
37
|
+
|`ExcName`|some exception|
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
**CustomAnnotation** A Custom method annotation
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
**See** [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
44
|
+
|
|
45
|
+
###### Example
|
|
46
|
+
```apex
|
|
47
|
+
// Example
|
|
48
|
+
SampleClass sampleInstance = new SampleClass();
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
### Other
|
|
54
|
+
##### `SampleClass(String argument1, String argument2)`
|
|
55
|
+
|
|
56
|
+
Constructs a SampleClass with an argument.
|
|
57
|
+
|
|
58
|
+
###### Parameters
|
|
59
|
+
|
|
60
|
+
|Param|Description|
|
|
61
|
+
|---|---|
|
|
62
|
+
|`argument1`|Argument1 definition|
|
|
63
|
+
|`argument2`|Argument2 definition|
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
## Fields
|
|
67
|
+
### Common Constants
|
|
68
|
+
|
|
69
|
+
* `ANOTHER_CONSTANT` → `String`
|
|
70
|
+
* `A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ] - This is a constant.
|
|
71
|
+
* `listOfStrings` → `List<String>`
|
|
72
|
+
---
|
|
73
|
+
### 'General' Constants
|
|
74
|
+
|
|
75
|
+
* `GENERAL_ANOTHER_CONSTANT` → `String`
|
|
76
|
+
* `GENERAL_A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ] - This is a constant.
|
|
77
|
+
---
|
|
78
|
+
### Other variables
|
|
79
|
+
|
|
80
|
+
* `someVariable` → `String`
|
|
81
|
+
---
|
|
82
|
+
## Properties
|
|
83
|
+
|
|
84
|
+
### `AnotherProp` → `Decimal`
|
|
85
|
+
|
|
86
|
+
`AURAENABLED`
|
|
87
|
+
|
|
88
|
+
This is a Decimal property.
|
|
89
|
+
|
|
90
|
+
### `MyProp` → `String`
|
|
91
|
+
|
|
92
|
+
`AURAENABLED`
|
|
93
|
+
`DEPRECATED`
|
|
94
|
+
|
|
95
|
+
This is a String property.
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
## Methods
|
|
99
|
+
### A method group
|
|
100
|
+
##### `static sampleMethod(String argument1, String argument2)`
|
|
101
|
+
|
|
102
|
+
`NAMESPACEACCESSIBLE`
|
|
103
|
+
|
|
104
|
+
Executes commands based on the passed in argument.
|
|
105
|
+
|
|
106
|
+
###### Parameters
|
|
107
|
+
|
|
108
|
+
|Param|Description|
|
|
109
|
+
|---|---|
|
|
110
|
+
|`argument1`|Argument1 to debug|
|
|
111
|
+
|`argument2`|Argument2 to debug|
|
|
112
|
+
|
|
113
|
+
###### Return
|
|
114
|
+
|
|
115
|
+
**Type**
|
|
116
|
+
|
|
117
|
+
String
|
|
118
|
+
|
|
119
|
+
**Description**
|
|
120
|
+
|
|
121
|
+
Empty string
|
|
122
|
+
|
|
123
|
+
###### Example
|
|
124
|
+
```apex
|
|
125
|
+
String result = SampleClass.testMethod();
|
|
126
|
+
System.debug(result);
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
##### `static anotherSampleMethod(String arg1)`
|
|
131
|
+
|
|
132
|
+
Something here
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
**Arg1** The arg1 description
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
### Other
|
|
139
|
+
##### `static call()`
|
|
140
|
+
|
|
141
|
+
Calls the method. This methods allows you to call it.
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
## Enums
|
|
145
|
+
### InnerEnum
|
|
146
|
+
|
|
147
|
+
`NAMESPACEACCESSIBLE`
|
|
148
|
+
|
|
149
|
+
This is a namespace accessible enum
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
## Classes
|
|
154
|
+
### AnotherInnerClass
|
|
155
|
+
|
|
156
|
+
Inner class belonging to SampleClass.
|
|
157
|
+
|
|
158
|
+
#### Properties
|
|
159
|
+
|
|
160
|
+
##### `InnerProp` → `String`
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
Description of the inner property.
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
#### Methods
|
|
167
|
+
##### `innerMethod()`
|
|
168
|
+
|
|
169
|
+
Executes from the inner class.
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
### InnerClass
|
|
174
|
+
|
|
175
|
+
Inner class belonging to SampleClass.
|
|
176
|
+
|
|
177
|
+
#### Properties
|
|
178
|
+
|
|
179
|
+
##### `InnerProp` → `String`
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
Description of the inner property.
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
#### Methods
|
|
186
|
+
##### `innerMethod()`
|
|
187
|
+
|
|
188
|
+
Executes from the inner class.
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
---
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
# nspc.MemberGrouping
|
|
2
|
-
## Fields
|
|
3
|
-
### Group old syntax
|
|
4
|
-
|
|
5
|
-
* `anotherInGroup1` → `String`
|
|
6
|
-
* `inGroup1` → `String`
|
|
7
|
-
---
|
|
8
|
-
### Group new syntax
|
|
9
|
-
Group's description
|
|
10
|
-
|
|
11
|
-
* `anotherInGroup2` → `String`
|
|
12
|
-
* `inGroup2` → `String` - Description for constant in group 2
|
|
13
|
-
---
|
|
1
|
+
# nspc.MemberGrouping
|
|
2
|
+
## Fields
|
|
3
|
+
### Group old syntax
|
|
4
|
+
|
|
5
|
+
* `anotherInGroup1` → `String`
|
|
6
|
+
* `inGroup1` → `String`
|
|
7
|
+
---
|
|
8
|
+
### Group new syntax
|
|
9
|
+
Group's description
|
|
10
|
+
|
|
11
|
+
* `anotherInGroup2` → `String`
|
|
12
|
+
* `inGroup2` → `String` - Description for constant in group 2
|
|
13
|
+
---
|
|
@@ -1,106 +1,106 @@
|
|
|
1
|
-
# nspc.SampleRestResource
|
|
2
|
-
|
|
3
|
-
`RESTRESOURCE`
|
|
4
|
-
|
|
5
|
-
Account related operations
|
|
6
|
-
|
|
7
|
-
## Methods
|
|
8
|
-
### `static doDelete()`
|
|
9
|
-
|
|
10
|
-
`HTTPDELETE`
|
|
11
|
-
|
|
12
|
-
Sample HTTP Delete method with references to other types.
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
**Http Parameter** name: limit in: header required: true description: My sample description. schema: SampleClass
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
**Http Response** statusCode: 200 schema: SampleClass
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
**Http Response** statusCode: 500 schema: SampleClass
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
**Http Response** statusCode: 304 schema: ChildClass
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
**Http Response** statusCode: 305 schema: Reference1
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
**Http Response** statusCode: 306 schema: List<Reference1>
|
|
31
|
-
|
|
32
|
-
### `static doGet()`
|
|
33
|
-
|
|
34
|
-
`HTTPGET`
|
|
35
|
-
|
|
36
|
-
This is a sample HTTP Get method
|
|
37
|
-
|
|
38
|
-
#### Return
|
|
39
|
-
|
|
40
|
-
**Type**
|
|
41
|
-
|
|
42
|
-
Account
|
|
43
|
-
|
|
44
|
-
**Description**
|
|
45
|
-
|
|
46
|
-
An Account SObject.
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
**Http Parameter** name: limit in: query required: true description: Limits the number of items on a page schema: type: integer
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
**Http Parameter** name: complex in: cookie description: A more complex schema schema: type: array items: type: object properties: name: type: string
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
**Http Response** statusCode: 200 schema: type: object properties: id: type: string description: The super Id. name: type: string phone: type: string format: byte
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
**Http Response** statusCode: 500 schema: type: string
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
**Http Response** statusCode: 304 schema: type: object properties: error: type: string
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
**Http Response** statusCode: 400 schema: type: array items: type: object properties: name: type: string
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
**Http Response** statusCode: 100 schema: type: object properties: anotherObject: description: An object inside of an object type: object properties: message: type: string somethingElse: type: number
|
|
68
|
-
|
|
69
|
-
### `static doPost(String name, String phone, String website)`
|
|
70
|
-
|
|
71
|
-
`HTTPPOST`
|
|
72
|
-
|
|
73
|
-
This is a sample HTTP Post method
|
|
74
|
-
|
|
75
|
-
#### Return
|
|
76
|
-
|
|
77
|
-
**Type**
|
|
78
|
-
|
|
79
|
-
String
|
|
80
|
-
|
|
81
|
-
**Description**
|
|
82
|
-
|
|
83
|
-
A String SObject.
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
**Http Parameter** name: limit in: query required: true description: Limits the number of items on a page schema: type: integer
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
**Http Parameter** name: complex in: cookie description: A more complex schema schema: type: array items: type: object properties: name: type: string
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
**Http Request Body** description: This is an example of a request body required: true schema: type: array items: type: object properties: name: type: string
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
**Http Response** statusCode: 200 schema: type: object properties: id: type: string description: The super Id. name: type: string phone: type: string format: byte
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
**Http Response** statusCode: 500 schema: type: string
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
**Http Response** statusCode: 304 schema: type: object properties: error: type: string
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
**Http Response** statusCode: 400 schema: type: array items: type: object properties: name: type: string
|
|
105
|
-
|
|
106
|
-
---
|
|
1
|
+
# nspc.SampleRestResource
|
|
2
|
+
|
|
3
|
+
`RESTRESOURCE`
|
|
4
|
+
|
|
5
|
+
Account related operations
|
|
6
|
+
|
|
7
|
+
## Methods
|
|
8
|
+
### `static doDelete()`
|
|
9
|
+
|
|
10
|
+
`HTTPDELETE`
|
|
11
|
+
|
|
12
|
+
Sample HTTP Delete method with references to other types.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
**Http Parameter** name: limit in: header required: true description: My sample description. schema: SampleClass
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
**Http Response** statusCode: 200 schema: SampleClass
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
**Http Response** statusCode: 500 schema: SampleClass
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
**Http Response** statusCode: 304 schema: ChildClass
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
**Http Response** statusCode: 305 schema: Reference1
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
**Http Response** statusCode: 306 schema: List<Reference1>
|
|
31
|
+
|
|
32
|
+
### `static doGet()`
|
|
33
|
+
|
|
34
|
+
`HTTPGET`
|
|
35
|
+
|
|
36
|
+
This is a sample HTTP Get method
|
|
37
|
+
|
|
38
|
+
#### Return
|
|
39
|
+
|
|
40
|
+
**Type**
|
|
41
|
+
|
|
42
|
+
Account
|
|
43
|
+
|
|
44
|
+
**Description**
|
|
45
|
+
|
|
46
|
+
An Account SObject.
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
**Http Parameter** name: limit in: query required: true description: Limits the number of items on a page schema: type: integer
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
**Http Parameter** name: complex in: cookie description: A more complex schema schema: type: array items: type: object properties: name: type: string
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
**Http Response** statusCode: 200 schema: type: object properties: id: type: string description: The super Id. name: type: string phone: type: string format: byte
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
**Http Response** statusCode: 500 schema: type: string
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
**Http Response** statusCode: 304 schema: type: object properties: error: type: string
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
**Http Response** statusCode: 400 schema: type: array items: type: object properties: name: type: string
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
**Http Response** statusCode: 100 schema: type: object properties: anotherObject: description: An object inside of an object type: object properties: message: type: string somethingElse: type: number
|
|
68
|
+
|
|
69
|
+
### `static doPost(String name, String phone, String website)`
|
|
70
|
+
|
|
71
|
+
`HTTPPOST`
|
|
72
|
+
|
|
73
|
+
This is a sample HTTP Post method
|
|
74
|
+
|
|
75
|
+
#### Return
|
|
76
|
+
|
|
77
|
+
**Type**
|
|
78
|
+
|
|
79
|
+
String
|
|
80
|
+
|
|
81
|
+
**Description**
|
|
82
|
+
|
|
83
|
+
A String SObject.
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
**Http Parameter** name: limit in: query required: true description: Limits the number of items on a page schema: type: integer
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
**Http Parameter** name: complex in: cookie description: A more complex schema schema: type: array items: type: object properties: name: type: string
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
**Http Request Body** description: This is an example of a request body required: true schema: type: array items: type: object properties: name: type: string
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
**Http Response** statusCode: 200 schema: type: object properties: id: type: string description: The super Id. name: type: string phone: type: string format: byte
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
**Http Response** statusCode: 500 schema: type: string
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
**Http Response** statusCode: 304 schema: type: object properties: error: type: string
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
**Http Response** statusCode: 400 schema: type: array items: type: object properties: name: type: string
|
|
105
|
+
|
|
106
|
+
---
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
# nspc.SampleRestResourceWithoutApexDocs
|
|
2
|
-
|
|
3
|
-
`RESTRESOURCE`
|
|
4
|
-
|
|
5
|
-
Order related operations
|
|
6
|
-
|
|
7
|
-
## Methods
|
|
8
|
-
### `static doGet(String param1, Reference1 param2)`
|
|
9
|
-
|
|
10
|
-
`HTTPGET`
|
|
11
|
-
### `static doPatch(String param1, Reference1 param2)`
|
|
12
|
-
|
|
13
|
-
`HTTPPATCH`
|
|
14
|
-
---
|
|
1
|
+
# nspc.SampleRestResourceWithoutApexDocs
|
|
2
|
+
|
|
3
|
+
`RESTRESOURCE`
|
|
4
|
+
|
|
5
|
+
Order related operations
|
|
6
|
+
|
|
7
|
+
## Methods
|
|
8
|
+
### `static doGet(String param1, Reference1 param2)`
|
|
9
|
+
|
|
10
|
+
`HTTPGET`
|
|
11
|
+
### `static doPatch(String param1, Reference1 param2)`
|
|
12
|
+
|
|
13
|
+
`HTTPPATCH`
|
|
14
|
+
---
|
package/docs/README.md
CHANGED
|
@@ -1,81 +1,81 @@
|
|
|
1
|
-
# Classes
|
|
2
|
-
## Misc Group
|
|
3
|
-
|
|
4
|
-
### [nspc.AnotherInterface](/Misc-Group/nspc.AnotherInterface.md)
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
### [nspc.ChildClass](/Misc-Group/nspc.ChildClass.md)
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
### [nspc.GrandparentClass](/Misc-Group/nspc.GrandparentClass.md)
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
### [nspc.InterfaceWithInheritance](/Misc-Group/nspc.InterfaceWithInheritance.md)
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
### [nspc.MemberGrouping](/Misc-Group/nspc.MemberGrouping.md)
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
### [nspc.ParentClass](/Misc-Group/nspc.ParentClass.md)
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
### [nspc.Reference1](/Misc-Group/nspc.Reference1.md)
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
### [nspc.Reference2](/Misc-Group/nspc.Reference2.md)
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
### [nspc.Reference3](/Misc-Group/nspc.Reference3.md)
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
### [nspc.Reference4](/Misc-Group/nspc.Reference4.md)
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
### [nspc.Reference5](/Misc-Group/nspc.Reference5.md)
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
### [nspc.Reference6](/Misc-Group/nspc.Reference6.md)
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
### [nspc.SampleClassWithoutModifier](/Misc-Group/nspc.SampleClassWithoutModifier.md)
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
### [nspc.SampleRestResource](/Misc-Group/nspc.SampleRestResource.md)
|
|
44
|
-
|
|
45
|
-
Account related operations
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
### [nspc.SampleRestResourceWithInnerClass](/Misc-Group/nspc.SampleRestResourceWithInnerClass.md)
|
|
50
|
-
|
|
51
|
-
Contact related operations
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
### [nspc.SampleRestResourceWithoutApexDocs](/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md)
|
|
56
|
-
|
|
57
|
-
Order related operations
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
## Main
|
|
61
|
-
|
|
62
|
-
### [nspc.GroupedClass](/Main/nspc.GroupedClass.md)
|
|
63
|
-
|
|
64
|
-
Uses a block style apex doc
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
### [nspc.SampleClass](/Main/nspc.SampleClass.md)
|
|
69
|
-
|
|
70
|
-
This is a class description. This class relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
71
|
-
But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
|
|
72
|
-
You can also link using this syntax [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
## Sample Interfaces
|
|
76
|
-
|
|
77
|
-
### [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
78
|
-
|
|
79
|
-
This is an interface description.
|
|
80
|
-
|
|
81
|
-
|
|
1
|
+
# Classes
|
|
2
|
+
## Misc Group
|
|
3
|
+
|
|
4
|
+
### [nspc.AnotherInterface](/Misc-Group/nspc.AnotherInterface.md)
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
### [nspc.ChildClass](/Misc-Group/nspc.ChildClass.md)
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
### [nspc.GrandparentClass](/Misc-Group/nspc.GrandparentClass.md)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### [nspc.InterfaceWithInheritance](/Misc-Group/nspc.InterfaceWithInheritance.md)
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### [nspc.MemberGrouping](/Misc-Group/nspc.MemberGrouping.md)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### [nspc.ParentClass](/Misc-Group/nspc.ParentClass.md)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### [nspc.Reference1](/Misc-Group/nspc.Reference1.md)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### [nspc.Reference2](/Misc-Group/nspc.Reference2.md)
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
### [nspc.Reference3](/Misc-Group/nspc.Reference3.md)
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
### [nspc.Reference4](/Misc-Group/nspc.Reference4.md)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### [nspc.Reference5](/Misc-Group/nspc.Reference5.md)
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
### [nspc.Reference6](/Misc-Group/nspc.Reference6.md)
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### [nspc.SampleClassWithoutModifier](/Misc-Group/nspc.SampleClassWithoutModifier.md)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
### [nspc.SampleRestResource](/Misc-Group/nspc.SampleRestResource.md)
|
|
44
|
+
|
|
45
|
+
Account related operations
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### [nspc.SampleRestResourceWithInnerClass](/Misc-Group/nspc.SampleRestResourceWithInnerClass.md)
|
|
50
|
+
|
|
51
|
+
Contact related operations
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
### [nspc.SampleRestResourceWithoutApexDocs](/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md)
|
|
56
|
+
|
|
57
|
+
Order related operations
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
## Main
|
|
61
|
+
|
|
62
|
+
### [nspc.GroupedClass](/Main/nspc.GroupedClass.md)
|
|
63
|
+
|
|
64
|
+
Uses a block style apex doc
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
### [nspc.SampleClass](/Main/nspc.SampleClass.md)
|
|
69
|
+
|
|
70
|
+
This is a class description. This class relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
71
|
+
But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
|
|
72
|
+
You can also link using this syntax [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
## Sample Interfaces
|
|
76
|
+
|
|
77
|
+
### [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
|
|
78
|
+
|
|
79
|
+
This is an interface description.
|
|
80
|
+
|
|
81
|
+
|
package/package.json
CHANGED
|
@@ -21,7 +21,7 @@ it('should add a path based on the @UrlResource annotation on the class', functi
|
|
|
21
21
|
const processor = new OpenApiDocsProcessor();
|
|
22
22
|
processor.onProcess(classMirror);
|
|
23
23
|
|
|
24
|
-
expect(processor.openApiModel.paths).toHaveProperty('/Account
|
|
24
|
+
expect(processor.openApiModel.paths).toHaveProperty('/Account/');
|
|
25
25
|
});
|
|
26
26
|
|
|
27
27
|
it('should contain a path with a description when the class has an ApexDoc comment', function () {
|
|
@@ -37,5 +37,5 @@ it('should contain a path with a description when the class has an ApexDoc comme
|
|
|
37
37
|
const processor = new OpenApiDocsProcessor();
|
|
38
38
|
processor.onProcess(classMirror);
|
|
39
39
|
|
|
40
|
-
expect(processor.openApiModel.paths['/Account
|
|
40
|
+
expect(processor.openApiModel.paths['/Account/'].description).toBe('My Description');
|
|
41
41
|
});
|