Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion api/src/admin.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import { resolve } from 'node:path'
import { readFile } from 'node:fs/promises'
import { Router } from 'express'
import { session } from '@data-fair/lib-express/index.js'
import { reqOrigin, session } from '@data-fair/lib-express'
import getApiDoc from './utils/api-docs.ts'

const router = Router()
export default router
Expand All @@ -17,3 +18,8 @@ try { info = JSON.parse(await readFile(resolve(import.meta.dirname, '../../BUILD
router.get('/info', (req, res) => {
res.send(info)
})

// Get the full API documentation of the service
router.get('/api-docs.json', async (req, res) => {
res.json(getApiDoc(reqOrigin(req)))
})
13 changes: 12 additions & 1 deletion api/src/routers/processings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ import path from 'path'
import resolvePath from 'resolve-path'
import { nanoid } from 'nanoid'

import { session } from '@data-fair/lib-express/index.js'
import { reqOrigin, session } from '@data-fair/lib-express/index.js'
import { httpError } from '@data-fair/lib-utils/http-errors.js'
import { createNext } from '@data-fair/processings-shared/runs.ts'
import { applyProcessing, deleteProcessing } from '../utils/runs.ts'
import mongo from '#mongo'
import config from '#config'
import locks from '#locks'
import { resolvedSchema as processingSchema } from '#types/processing/index.ts'
import getApiDoc from '../utils/api-docs.ts'
import findUtils from '../utils/find.ts'
import permissions from '../utils/permissions.ts'

Expand Down Expand Up @@ -356,3 +357,13 @@ router.post('/:id/_trigger', async (req, res) => {
if (!processing.active) return res.status(409).send('Le traitement n\'est pas actif')
res.send(await createNext(mongo.db, locks, processing, true, req.query.delay ? Number(req.query.delay) : 0))
})

// Get the API documentation of a processing
router.get('/:id/api-docs.json', permissions.isSuperAdmin, async (req, res) => {
const processing = await mongo.processings.findOne({ _id: req.params.id })
if (!processing) return res.status(404).send()
const pluginPath = path.join(pluginsDir, processing.plugin, 'plugin.json')
if (!await fs.pathExists(pluginPath)) return res.status(404).send('Plugin not found')
const plugin = await fs.readJson(pluginPath)
res.json(getApiDoc(reqOrigin(req), { processing, plugin }))
})
Loading