@stackql/provider-utils 0.4.5 → 0.4.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.
- package/package.json +1 -1
- package/src/docgen/resource/examples/delete-example.js +1 -1
- package/src/docgen/resource/examples/exec-example.js +1 -1
- package/src/docgen/resource/examples/insert-example.js +2 -2
- package/src/docgen/resource/examples/select-example.js +1 -1
- package/src/docgen/resource/examples/update-example.js +49 -46
package/package.json
CHANGED
|
@@ -87,9 +87,9 @@ export function createInsertExamples(providerName, serviceName, resourceName, re
|
|
|
87
87
|
}
|
|
88
88
|
|
|
89
89
|
if (isNumber || isBoolean) {
|
|
90
|
-
return '{{ ' + paramName + ' }}' + (isRequiredBodyParam ? '
|
|
90
|
+
return '{{ ' + paramName + ' }}' + (isRequiredBodyParam ? ' /* required */' : '');
|
|
91
91
|
} else {
|
|
92
|
-
return '\'{{ ' + paramName + ' }}\'' + (isRequiredBodyParam ? '
|
|
92
|
+
return '\'{{ ' + paramName + ' }}\'' + (isRequiredBodyParam ? ' /* required */' : '');
|
|
93
93
|
}
|
|
94
94
|
});
|
|
95
95
|
|
|
@@ -84,56 +84,59 @@ export function createUpdateExamples(providerName, serviceName, resourceName, re
|
|
|
84
84
|
methodDetails.requestBody.properties[prop].readOnly !== true)
|
|
85
85
|
: [];
|
|
86
86
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
let clauseCount = 0;
|
|
91
|
-
|
|
92
|
-
// Add required query/path/header params
|
|
93
|
-
requiredParams.forEach(param => {
|
|
94
|
-
if (clauseCount > 0) content += '\nAND ';
|
|
95
|
-
content += param + ' = \'{{ ' + param + ' }}\' --required';
|
|
96
|
-
clauseCount++;
|
|
97
|
-
});
|
|
98
|
-
|
|
99
|
-
// Add required body params (only non-readonly ones)
|
|
100
|
-
requiredBodyProps.forEach(prop => {
|
|
101
|
-
if (clauseCount > 0) content += '\nAND ';
|
|
102
|
-
|
|
103
|
-
const propDetails = methodDetails.requestBody.properties[prop];
|
|
104
|
-
const isBoolean = propDetails.type === 'boolean';
|
|
105
|
-
|
|
106
|
-
if (isBoolean) {
|
|
107
|
-
content += 'data__' + prop + ' = {{ ' + prop + ' }} --required';
|
|
108
|
-
} else {
|
|
109
|
-
content += 'data__' + prop + ' = \'{{ ' + prop + ' }}\' --required';
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
clauseCount++;
|
|
113
|
-
});
|
|
114
|
-
|
|
115
|
-
// Add optional parameters
|
|
116
|
-
optionalParams.forEach(param => {
|
|
117
|
-
if (clauseCount > 0) content += '\nAND ';
|
|
87
|
+
if (requiredParams.length > 0 || requiredBodyProps.length > 0 || optionalParams.length > 0) {
|
|
88
|
+
|
|
89
|
+
content += '\nWHERE \n';
|
|
118
90
|
|
|
119
|
-
//
|
|
120
|
-
|
|
121
|
-
const isBoolean = paramDetails.type === 'boolean';
|
|
122
|
-
const defaultValue = paramDetails.default;
|
|
91
|
+
// Add required parameters
|
|
92
|
+
let clauseCount = 0;
|
|
123
93
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
content += param + ' = \'{{ ' + param + '}}\'';
|
|
128
|
-
|
|
94
|
+
// Add required query/path/header params
|
|
95
|
+
requiredParams.forEach(param => {
|
|
96
|
+
if (clauseCount > 0) content += '\nAND ';
|
|
97
|
+
content += param + ' = \'{{ ' + param + ' }}\' --required';
|
|
98
|
+
clauseCount++;
|
|
99
|
+
});
|
|
129
100
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
101
|
+
// Add required body params (only non-readonly ones)
|
|
102
|
+
requiredBodyProps.forEach(prop => {
|
|
103
|
+
if (clauseCount > 0) content += '\nAND ';
|
|
104
|
+
|
|
105
|
+
const propDetails = methodDetails.requestBody.properties[prop];
|
|
106
|
+
const isBoolean = propDetails.type === 'boolean';
|
|
107
|
+
|
|
108
|
+
if (isBoolean) {
|
|
109
|
+
content += 'data__' + prop + ' = {{ ' + prop + ' }} --required';
|
|
110
|
+
} else {
|
|
111
|
+
content += 'data__' + prop + ' = \'{{ ' + prop + ' }}\' --required';
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
clauseCount++;
|
|
115
|
+
});
|
|
133
116
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
117
|
+
// Add optional parameters
|
|
118
|
+
optionalParams.forEach(param => {
|
|
119
|
+
if (clauseCount > 0) content += '\nAND ';
|
|
120
|
+
|
|
121
|
+
// For boolean parameters, we can add a comment about their default value
|
|
122
|
+
const paramDetails = methodDetails.optionalParams[param];
|
|
123
|
+
const isBoolean = paramDetails.type === 'boolean';
|
|
124
|
+
const defaultValue = paramDetails.default;
|
|
125
|
+
|
|
126
|
+
if (isBoolean) {
|
|
127
|
+
content += param + ' = {{ ' + param + '}}';
|
|
128
|
+
} else {
|
|
129
|
+
content += param + ' = \'{{ ' + param + '}}\'';
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
if (isBoolean && defaultValue !== undefined) {
|
|
133
|
+
content += ' -- default: ' + defaultValue;
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
clauseCount++;
|
|
137
|
+
});
|
|
138
|
+
}
|
|
139
|
+
|
|
137
140
|
// returning clause if properties exist
|
|
138
141
|
if (methodDetails.properties && Object.keys(methodDetails.properties).length > 0) {
|
|
139
142
|
content += '\nRETURNING\n';
|