johan/FoundKey
1
0
Fork 0
forked from FoundKeyGang/FoundKey
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix HTTP GET parameters in OpenAPI docs

Browse source 
HTTP GET parameters are not to be specified in the requestBody but in
the parameters. This commit fixes that although admittedly it is kind
of a bodge and not perfect, but it is a start.

Changelog: Fixed
This commit is contained in:
Johann150 2022-09-19 10:54:23 +02:00
parent 668181fb44
commit f0b91a62c9
Signed by untrusted user: Johann150
GPG key ID: 9EE6577A2A06F8F1
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
packages/backend/src/server/api/openapi/gen-spec.ts
View file

@ -200,6 +200,17 @@ export function genOpenapiSpec() {
path.get = { ...info }; path.get = { ...info };
// API Key authentication is not permitted for GET requests // API Key authentication is not permitted for GET requests
path.get.security = path.get.security.filter(elem => !Object.prototype.hasOwnProperty.call(elem, 'ApiKeyAuth')); path.get.security = path.get.security.filter(elem => !Object.prototype.hasOwnProperty.call(elem, 'ApiKeyAuth'));
// fix the way parameters are passed
delete path.get.requestBody;
path.get.parameters = [];
for (const name in schema.properties) {
path.get.parameters.push({
name,
in: 'query',
schema: schema.properties[name],
required: schema.required?.includes(name),
});
}
} }
spec.paths['/' + endpoint.name] = path; spec.paths['/' + endpoint.name] = path;