How to document optional attributes with buildTemplatedApiExceptionDecorator?

[lzkill]

I have this template decorator:

import { buildTemplatedApiExceptionDecorator } from '@nanogiants/nestjs-swagger-api-exception-decorator';

export const TemplatedApiException = buildTemplatedApiExceptionDecorator({
  statusCode: '$status',
  clientCode: 'number',
  message: '$description',
  errors: [
    {
      string: 'string',
    },
  ],
  path: 'string',
  timestamp: '1970-01-01T15:30:11',
});

It matches my exception filter custom json. But some attributes are optional. Hoe can I document this on Swagger?

[jsproede]

Hi @lzkill, with the @TemplatedApiException decorator currently it is not possible to mark attributes as optional.

What do you think about an optional array which can contain the required attributes? For example:

export const TemplatedApiException = buildTemplatedApiExceptionDecorator({
  statusCode: '$status',
  clientCode: 'number',
  message: '$description',
  errors: [
    {
      string: 'string',
    },
  ],
  path: 'string',
  timestamp: '1970-01-01T15:30:11',
}, ['statusCode', 'message', 'timestamp']);

[lzkill]

Hi my friend. I guess this array would pretty much fit my needs. Without this the api consumer is not aware until the first errors start to return.

[jsproede]

Hi @lzkill,

we've extended the Options interface with requiredProperties. For example:

export const TemplatedApiException = buildTemplatedApiExceptionDecorator(
  {
    statusCode: '$status',
    clientCode: 'number',
    message: '$description',
    errors: [
      {
        string: 'string',
      },
    ],
    path: 'string',
    timestamp: '1970-01-01T15:30:11',
  },
  { requiredProperties: ['statusCode', 'message', 'timestamp'] },
);

We'll release a new version (v1.3.0) soon :)

[lzkill]

Thank you again, my friend!

[lzkill]

@jsproede What do you think about having a similar array for custom placeholders?

[jsproede]

@lzkill Do you have an example? :)

[lzkill]

Something like this:

export const TemplatedApiException = buildTemplatedApiExceptionDecorator(
  {
    statusCode: '$status',
    clientCode: '$clientCode',
    message: '$description',
    errors: [
      {
        string: 'string',
      },
    ],
    path: 'string',
    timestamp: '1970-01-01T15:30:11',
  },
  {
    requiredProperties: ['statusCode', 'message', 'timestamp'],
    placeholders: {
       'clientCode': (e) => { (e as BaseException).getClientCode(); }
    }
  },
);

(I'm sorry for my poor typescript)

[jsproede]

@lzkill Great idea! I've moved your suggestion regarding custom placeholders into a new issue :)

[jsproede]

Hi @lzkill, I just wanted to notify you, that a new version including the requiredProperties property has been released :) The new release also includes custom placeholders. We described the new properties in our documentation.

[lzkill]

Hi my friend. I was already using your first commit. :)

Thank you very much for your superb work!