Class CustomRulesetRequestDataAttributes

Attributes for creating or updating a custom ruleset. name is required and must equal the resource id; the server rejects a mismatch with a 412 response.

Hierarchy

  • CustomRulesetRequestDataAttributes

Constructors

constructor

Properties

additionalProperties? description? name rules? shortDescription?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional description

description?: string

Base64-encoded full description

name

name: string

Ruleset name, which must be the same as the resource identifier.

Optional rules

rules?: CustomRule[]

Rules in the ruleset

Optional shortDescription

shortDescription?: string

Base64-encoded short description

Settings

Member Visibility

Theme

Generated using TypeDoc