Skip to content

feat: fetch Kuzzle Application OpenAPI specs to prefill documented options #1010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 17, 2025
Merged

feat: fetch Kuzzle Application OpenAPI specs to prefill documented options #1010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a5f963
feat: fetch Kuzzle Application OpenAPI specs to prefill controller:ac…
alexandrebouthinon Jan 17, 2025
cd831cc
fix: make body content reset when selecting an other controller:action
alexandrebouthinon Jan 17, 2025
efa2bbb
fix: handle all the official OpenAPI types
alexandrebouthinon Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/components/ApiAction.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,11 +308,17 @@ export default {
},
async getKuzzleOpenApi() {
try {
const openApi = await this.$kuzzle.query({
const openApiKuzzle = await this.$kuzzle.query({
controller: 'server',
action: 'openapi',
scope: 'kuzzle',
});
this.openapi = openApi.paths;
const openApiApp = await this.$kuzzle.query({
controller: 'server',
action: 'openapi',
scope: 'app',
});
this.openapi = { ...openApiApp.paths, ...openApiKuzzle.paths };
} catch (error) {
this.$log.error(error);
this.$bvToast.toast(
Expand Down
27 changes: 26 additions & 1 deletion src/components/ApiAction/QueryCard.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ export default {
const obj = {
controller: query.controller,
action: query.action,
body: query.body,
body: {},
};
this.jsonQuery = JSON.stringify(obj, null, 2);
this.$refs[`queryEditorWrapper-${this.tabIdx}`].setContent(this.jsonQuery);
Expand All @@ -246,6 +246,31 @@ export default {
query[param.name] = '';
}
}
const body = _.get(this.openapi, `${openApiPath}.${verb}.requestBody`, null);
if (body && body.content['application/json']) {
const prefilledBody = body.content['application/json'].schema.properties;
for (const key of Object.keys(prefilledBody)) {
switch (prefilledBody[key].type) {
case 'string':
query.body[key] = '';
break;
case 'number' || 'integer':
query.body[key] = 0;
break;
case 'boolean':
query.body[key] = false;
break;
case 'array':
query.body[key] = [];
break;
case 'object':
query.body[key] = {};
break;
default:
query.body[key] = '';
}
}
}
this.jsonQuery = JSON.stringify(query, null, 2);
this.$refs[`queryEditorWrapper-${this.tabIdx}`].setContent(this.jsonQuery);
},
Expand Down
Loading