@ApiHideProperty on crud param still showing up in swagger doc

I am trying to use @ApiHideProperty() for swagger docs https://docs.nestjs.com/recipes/swagger#decorators but a param is always showing up because it is specified in the Crud decorator. My configuration:

@OrganizationGuard
@Crud({
  model: {
    type: ServicePackage
  },
  params: {
    organization: { // field I want to hide from docs
      field: 'org',
      type: 'string'
    },
    ...
  }
  ...
})

This is so that I can filter the ServicePackage entity by organization, but this param is provided by @OrganizationGuard which intercepts requests and adds the organization param to the request before Crud executes the query.

@Injectable()
export class OrganizationGuard implements CanActivate {
  canActivate (context: ExecutionContext): boolean {
    const request = context.switchToHttp().getRequest()
    if (request?.user?.org?.id) {
      request.params.organization = request.user.org.id

      return true
    }

    return false
  }

This means that the endpoints must have organization required, but I want to communicate to the docs that it is not required.

[darrenjennings]

@zMotivat0r sorry still new to the framework, so was not immediately obvious that persist is able to handle this.

[darrenjennings]

@zMotivat0r wow thank you so much… this makes way more sense and works perfectly.