update openapi spec generator

This commit is contained in:
Johann150 2022-07-18 18:37:41 +02:00
parent edac21e8f7
commit 660f6dba30
Signed by: Johann150
GPG key ID: 9EE6577A2A06F8F1

View file

@ -15,7 +15,7 @@ export function genOpenapiSpec() {
externalDocs: {
description: 'Repository',
url: 'https://github.com/misskey-dev/misskey',
url: 'https://akkoma.dev/FoundKeyGang/FoundKey',
},
servers: [{
@ -33,6 +33,11 @@ export function genOpenapiSpec() {
in: 'body',
name: 'i',
},
// TODO: change this to oauth2 when the remaining oauth stuff is set up
Bearer: {
type: 'http',
scheme: 'bearer',
}
},
},
};
@ -71,22 +76,29 @@ export function genOpenapiSpec() {
schema.required.push('file');
}
const security = [
{
ApiKeyAuth: [],
},
{
Bearer: [],
},
];
if (!endpoint.meta.requireCredential) {
// add this to make authentication optional
security.push({});
}
const info = {
operationId: endpoint.name,
summary: endpoint.name,
description: desc,
externalDocs: {
description: 'Source code',
url: `https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/${endpoint.name}.ts`,
url: `https://akkoma.dev/FoundKeyGang/FoundKey/src/branch/main/packages/backend/src/server/api/endpoints/${endpoint.name}.ts`,
},
...(endpoint.meta.tags ? {
tags: [endpoint.meta.tags[0]],
} : {}),
...(endpoint.meta.requireCredential ? {
security: [{
ApiKeyAuth: [],
}],
} : {}),
tags: endpoint.meta.tags || undefined,
security,
requestBody: {
required: true,
content: {
@ -181,9 +193,16 @@ export function genOpenapiSpec() {
},
};
spec.paths['/' + endpoint.name] = {
const path = {
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;