Google style custom methods in routes with colon

[chincheta]

I am trying to replicate this way of defining custom verbs:

https://cloud.google.com/apis/design/custom_methods

Example:

https://service.name/v1/some/resource/name:customVerb

I can't get the route to match. This is my code:

router.post('/:jobId[:]change-status', async (req, res, next) => {
    console.log('CALLED!!');
    const jobs = getDb().collection('jobs');
    const result = await jobs.updateOne(
        { id: req.params.jobId },
        { $set: { status: 'completed', completedDate: DateTime.now().toISO() } },
        { upsert: false });
    res.status(200).send(`Job ${req.params.jobId} marked as completed.`);
});

What's the proper syntax? The documentation is not clear.

Regards.

[TommyRiquet]

We're missing a lot of context about your route, but it looks like the problem comes from the colon in /:jobId[:]change-status that's not part of the parameter syntax. It should only be /:jobId/change-status to match the correct URL format.

Here's the code corrected :

router.post('/:jobId/change-status', async (req, res, next) => {
    console.log('CALLED!!');
    const jobs = getDb().collection('jobs');
    const result = await jobs.updateOne(
        { id: req.params.jobId },
        { $set: { status: 'completed', completedDate: DateTime.now().toISO() } },
        { upsert: false });
    res.status(200).send(`Job ${req.params.jobId} marked as completed.`);
});

[chincheta]

I finally corrected it with this syntax:

'/:jobId[(\:)]change-status'

I cannot find the documentation but if I recall correctly is wrong as it states ([\:]) instead.

[TommyRiquet]

Well done, I'm lacking documentation too, it's weird to do so but if it works fine then ¯\_(ツ )_/¯