const pkg = require('../../package.json'); module.exports = { openapi: '3.0.1', info: { title: 'GROWI REST API v3', version: pkg.version, }, servers: [ { url: '{server}/_api/v3', variables: { server: { default: 'https://demo.growi.org', description: 'The base URL for the GROWI API except for the version path (/_api/v3). This can be set to your GROWI instance URL.', }, }, }, { url: 'https://demo.growi.org/_api/v3', }, ], security: [ { bearer: [], accessTokenInQuery: [], }, ], components: { securitySchemes: { bearer: { type: 'http', scheme: 'bearer', description: 'Access token generated by each GROWI users', }, accessTokenInQuery: { type: 'apiKey', name: 'access_token', in: 'query', description: 'Access token generated by each GROWI users', }, cookieAuth: { type: 'apiKey', in: 'cookie', name: 'connect.sid', }, transferHeaderAuth: { type: 'apiKey', in: 'header', name: 'x-growi-transfer-key', }, }, parameters: { MimeTypePathParam: { name: 'mimeType', in: 'path', required: true, description: 'Configurable MIME type (e.g., image/png, application/pdf)', schema: { type: 'string', enum: [ 'image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/bmp', 'image/tiff', 'image/x-icon', 'application/pdf', 'text/plain', 'video/mp4', 'video/webm', 'video/ogg', 'audio/mpeg', 'audio/ogg', 'audio/wav', 'text/html', 'text/javascript', 'application/javascript', 'image/svg+xml', 'application/xml', 'application/json', 'application/x-sh', 'application/x-msdownload', 'application/octet-stream', 'application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/zip', 'application/x-rar-compressed', 'text/csv', ], }, }, }, }, 'x-tagGroups': [ { name: 'User API', tags: [ 'Attachment', 'Bookmarks', 'BookmarkFolders', 'Page', 'Pages', 'PageListing', 'Revisions', 'ShareLinks', 'Users', 'UserUISettings', ], }, { name: 'User Personal Settings API', tags: [ 'GeneralSetting', 'EditorSetting', 'InAppNotificationSettings', ], }, { name: 'System Management API', tags: [ 'Home', 'Activity', 'AdminHome', 'AppSettings', 'ExternalUserGroups', 'SecuritySetting', 'MarkDownSetting', 'CustomizeSetting', 'Import', 'Export', 'GROWI to GROWI Transfer', 'MongoDB', 'NotificationSetting', 'Plugins', 'Questionnaire', 'QuestionnaireSetting', 'SlackIntegration', 'SlackIntegrationSettings', 'SlackIntegrationSettings (with proxy)', 'SlackIntegrationSettings (without proxy)', 'SlackIntegrationLegacySetting', 'ShareLink Management', 'Templates', 'Staff', 'UserGroupRelations', 'UserGroups', 'Users Management', 'FullTextSearch Management', 'Install', ], }, { name: 'Public API', tags: [ 'Healthcheck', 'Statistics', ], }, ], };