src/issuer/status-list/dto/update-status-list-config.dto.ts

Description

DTO for updating status list configuration. All fields are optional - only provided fields will be updated. Set a field to null to reset it to the global default.

Extends

createZodDto( UpdateStatusListConfigSchema, )

Relationships

Used by

No results matching.

Index

Properties

Properties

Optional bits
Type : BitsPerStatus | null
Decorators :
@ApiPropertyOptional({description: 'Bits per status entry. Set to null to reset to global default.', enum: undefined, nullable: true})

The number of bits used per status entry. Set to null to reset to global default.

Optional capacity
Type : number | null
Decorators :
@ApiPropertyOptional({description: 'The capacity of the status list. Set to null to reset to global default.', example: 10000, minimum: 100, nullable: true})

The capacity of the status list (number of entries). Set to null to reset to global default.

Optional enableAggregation
Type : boolean | null
Decorators :
@ApiPropertyOptional({description: 'If true, include aggregation_uri in status list JWTs for pre-fetching support. Set to null to reset to default (true).', nullable: true})

Whether to include aggregation_uri in status list JWTs. Set to null to reset to global default (true).

Optional immediateUpdate
Type : boolean | null
Decorators :
@ApiPropertyOptional({description: 'If true, regenerate JWT on every status change. Set to null to reset to default (false).', nullable: true})

If true, regenerate JWT immediately on status changes. Set to null to reset to global default (false).

Optional ttl
Type : number | null
Decorators :
@ApiPropertyOptional({description: 'TTL in seconds for the status list JWT. Set to null to reset to global default.', example: 3600, minimum: 60, nullable: true})

Time-to-live in seconds for the status list JWT. Set to null to reset to global default.

import { ApiPropertyOptional } from "@nestjs/swagger";
import { BitsPerStatus } from "@owf/token-status-list";
import { createZodDto } from "nestjs-zod";
import { UpdateStatusListConfigSchema } from "./status-list.schema";

/**
 * DTO for updating status list configuration.
 * All fields are optional - only provided fields will be updated.
 * Set a field to null to reset it to the global default.
 */
export class UpdateStatusListConfigDto extends createZodDto(
    UpdateStatusListConfigSchema,
) {
    /**
     * The capacity of the status list (number of entries).
     * Set to null to reset to global default.
     */
    @ApiPropertyOptional({
        description:
            "The capacity of the status list. Set to null to reset to global default.",
        example: 10000,
        minimum: 100,
        nullable: true,
    })
    capacity?: number | null;

    /**
     * The number of bits used per status entry.
     * Set to null to reset to global default.
     */
    @ApiPropertyOptional({
        description:
            "Bits per status entry. Set to null to reset to global default.",
        enum: [1, 2, 4, 8],
        nullable: true,
    })
    bits?: BitsPerStatus | null;

    /**
     * Time-to-live in seconds for the status list JWT.
     * Set to null to reset to global default.
     */
    @ApiPropertyOptional({
        description:
            "TTL in seconds for the status list JWT. Set to null to reset to global default.",
        example: 3600,
        minimum: 60,
        nullable: true,
    })
    ttl?: number | null;

    /**
     * If true, regenerate JWT immediately on status changes.
     * Set to null to reset to global default (false).
     */
    @ApiPropertyOptional({
        description:
            "If true, regenerate JWT on every status change. Set to null to reset to default (false).",
        nullable: true,
    })
    immediateUpdate?: boolean | null;

    /**
     * Whether to include aggregation_uri in status list JWTs.
     * Set to null to reset to global default (true).
     */
    @ApiPropertyOptional({
        description:
            "If true, include aggregation_uri in status list JWTs for pre-fetching support. Set to null to reset to default (true).",
        nullable: true,
    })
    enableAggregation?: boolean | null;
}

results matching ""

    No results matching ""