update openapi spec generator

Properly document GET API endpoints.
Added Bearer token authentication.
This commit is contained in:
Johann150 2022-07-18 18:37:41 +02:00
parent 4ca48908be
commit 0131ec4a58
Signed by untrusted user: Johann150
GPG key ID: 9EE6577A2A06F8F1

View file

@ -33,6 +33,11 @@ export function genOpenapiSpec() {
in: 'body', in: 'body',
name: 'i', name: 'i',
}, },
// TODO: change this to oauth2 when the remaining oauth stuff is set up
Bearer: {
type: 'http',
scheme: 'bearer',
}
}, },
}, },
}; };
@ -71,6 +76,19 @@ export function genOpenapiSpec() {
schema.required.push('file'); schema.required.push('file');
} }
const security = [
{
ApiKeyAuth: [],
},
{
Bearer: [],
},
];
if (!endpoint.meta.requireCredential) {
// add this to make authentication optional
security.push({});
}
const info = { const info = {
operationId: endpoint.name, operationId: endpoint.name,
summary: endpoint.name, summary: endpoint.name,
@ -79,14 +97,8 @@ export function genOpenapiSpec() {
description: 'Source code', description: 'Source code',
url: `https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/${endpoint.name}.ts`, url: `https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/${endpoint.name}.ts`,
}, },
...(endpoint.meta.tags ? { tags: endpoint.meta.tags || undefined,
tags: [endpoint.meta.tags[0]], security,
} : {}),
...(endpoint.meta.requireCredential ? {
security: [{
ApiKeyAuth: [],
}],
} : {}),
requestBody: { requestBody: {
required: true, required: true,
content: { content: {
@ -181,9 +193,16 @@ export function genOpenapiSpec() {
}, },
}; };
spec.paths['/' + endpoint.name] = { const path = {
post: info, post: info,
}; };
if (endpoint.meta.allowGet) {
path.get = { ...info };
// API Key authentication is not permitted for GET requests
path.get.security = path.get.security.filter(elem => !Object.prototype.hasOwnProperty.call(elem, 'ApiKeyAuth'));
}
spec.paths['/' + endpoint.name] = path;
} }
return spec; return spec;