raymond/analytics-api
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update server.ts for documentation

Browse source
This commit is contained in:
raymond 2025-09-10 06:39:58 +00:00
parent 9d80922f5f
commit 13f3c7b053
2 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api-documentation.html
View file

File diff suppressed because one or more lines are too long

30
server.ts
View file

@ -1244,11 +1244,11 @@ app.post('/api/predict/forecast', (req, res) => {
/** /**
* @swagger * @swagger
* /api/signal/smooth: * /api/series/smooth:
* post: * post:
* summary: Smooth a 1D data series * summary: Smooth a 1D data series
* description: Applies a smoothing filter (Gaussian or Moving Average) to a 1D data series to reduce noise. * description: Applies a smoothing filter (Gaussian or Moving Average) to a 1D data series to reduce noise.
* tags: [Signal Processing] * tags: [Series Operations]
* requestBody: * requestBody:
* required: true * required: true
* content: * content:
@ -1270,7 +1270,7 @@ app.post('/api/predict/forecast', (req, res) => {
* '400': * '400':
* description: Invalid input data * description: Invalid input data
*/ */
app.post('/api/signal/smooth', (req, res) => { app.post('/api/series/smooth', (req, res) => {
try { try {
const { series, options } = req.body; const { series, options } = req.body;
validateSeries(series); validateSeries(series);
@ -1284,11 +1284,11 @@ app.post('/api/signal/smooth', (req, res) => {
/** /**
* @swagger * @swagger
* /api/signal/detect-peaks: * /api/series/detect-peaks:
* post: * post:
* summary: Detect peaks in a 1D data series * summary: Detect peaks in a 1D data series
* description: Identifies local maxima (peaks) in a 1D data series. More robust and accurate logic. * description: Identifies local maxima (peaks) in a 1D data series. More robust and accurate logic.
* tags: [Signal Processing] * tags: [Series Operations]
* requestBody: * requestBody:
* required: true * required: true
* content: * content:
@ -1319,7 +1319,7 @@ app.post('/api/signal/smooth', (req, res) => {
* '400': * '400':
* description: Invalid input data * description: Invalid input data
*/ */
app.post('/api/signal/detect-peaks', (req, res) => { app.post('/api/series/detect-peaks', (req, res) => {
try { try {
const { series, options } = req.body; const { series, options } = req.body;
validateSeries(series); validateSeries(series);
@ -1333,11 +1333,11 @@ app.post('/api/signal/detect-peaks', (req, res) => {
/** /**
* @swagger * @swagger
* /api/signal/detect-valleys: * /api/series/detect-valleys:
* post: * post:
* summary: Detect valleys in a 1D data series * summary: Detect valleys in a 1D data series
* description: Identifies local minima (valleys) in a 1D data series. More robust and accurate logic. * description: Identifies local minima (valleys) in a 1D data series. More robust and accurate logic.
* tags: [Signal Processing] * tags: [Series Operations]
* requestBody: * requestBody:
* required: true * required: true
* content: * content:
@ -1368,7 +1368,7 @@ app.post('/api/signal/detect-peaks', (req, res) => {
* '400': * '400':
* description: Invalid input data * description: Invalid input data
*/ */
app.post('/api/signal/detect-valleys', (req, res) => { app.post('/api/series/detect-valleys', (req, res) => {
try { try {
const { series, options } = req.body; const { series, options } = req.body;
validateSeries(series); validateSeries(series);
@ -1382,11 +1382,11 @@ app.post('/api/signal/detect-valleys', (req, res) => {
/** /**
* @swagger * @swagger
* /api/signal/detect-outliers: * /api/series/detect-outliers:
* post: * post:
* summary: Detect outliers in a 1D data series * summary: Detect outliers in a 1D data series
* description: Identifies outliers in a 1D data series using statistically sound methods. * description: Identifies outliers in a 1D data series using statistically sound methods.
* tags: [Signal Processing] * tags: [Series Operations]
* requestBody: * requestBody:
* required: true * required: true
* content: * content:
@ -1420,7 +1420,7 @@ app.post('/api/signal/detect-valleys', (req, res) => {
* '400': * '400':
* description: Invalid input data * description: Invalid input data
*/ */
app.post('/api/signal/detect-outliers', (req, res) => { app.post('/api/series/detect-outliers', (req, res) => {
try { try {
const { series, options } = req.body; const { series, options } = req.body;
validateSeries(series); validateSeries(series);
@ -1434,11 +1434,11 @@ app.post('/api/signal/detect-outliers', (req, res) => {
/** /**
* @swagger * @swagger
* /api/signal/detect-vertices: * /api/series/detect-vertices:
* post: * post:
* summary: Detect trend vertices (turning points) in a 1D series * summary: Detect trend vertices (turning points) in a 1D series
* description: Identifies all significant peaks and valleys in a data series trend using a robust local maxima/minima search. * description: Identifies all significant peaks and valleys in a data series trend using a robust local maxima/minima search.
* tags: [Signal Processing] * tags: [Series Operations]
* requestBody: * requestBody:
* required: true * required: true
* content: * content:
@ -1473,7 +1473,7 @@ app.post('/api/signal/detect-outliers', (req, res) => {
* '400': * '400':
* description: Invalid input data * description: Invalid input data
*/ */
app.post('/api/signal/detect-vertices', (req, res) => { app.post('/api/series/detect-vertices', (req, res) => {
try { try {
const { series, options } = req.body; const { series, options } = req.body;
validateSeries(series); validateSeries(series);