mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-04-20 23:46:14 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Added jsdoc for the node part of etherpad. (#5983)

Browse source
This commit is contained in:
SamTV12345 2023-10-17 12:49:56 +02:00 • committed by GitHub
parent 53d1e8a160
commit ff1b929eb2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 284 additions and 71 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/node/hooks/express/openapi.js
View file

@ -696,10 +696,20 @@ exports.expressPreSession = async (hookName, {app}) => {
}
};
// helper to get api root
/**
* Helper to get the current root path for an API version
* @param {String} version The API version
* @param {APIPathStyle} style The style of the API path
* @return {String} The root path for the API version
*/
const getApiRootForVersion = (version, style = APIPathStyle.FLAT) => `/${style}/${version}`;
// helper to generate an OpenAPI server object when serving definitions
/**
* Helper to generate an OpenAPI server object when serving definitions
* @param {String} apiRoot The root path for the API version
* @param {Request} req The express request object
* @return {url: String} The server object for the OpenAPI definition location
*/
const generateServerForApiVersion = (apiRoot, req) => ({
url: `${settings.ssl ? 'https' : 'http'}://${req.headers.host}${apiRoot}`,
});