Definition Field
definitions_Field.html#/definitions/Field/properties/entropy definitions_Field.html#/definitions/Field/properties/generate definitions_Field.html#/definitions/Field/properties/id definitions_Field.html#/definitions/Field/properties/label definitions_Field.html#/definitions/Field/properties/purpose definitions_Field.html#/definitions/Field/properties/recipe definitions_Field.html#/definitions/Field/properties/section definitions_Field.html#/definitions/Field/properties/type definitions_Field.html#/definitions/Field/properties/value
Diagram
Type object
Properties
Name Occurrence
entropy
generate
id
label
purpose
recipe
section
type
value
 optional
optional
required
optional
optional
optional
optional
required
optional
Additional Properties true
Used by
Source
 

 "Field": {
  "type": "object",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "entropy": {
      "type": "number",
      "description": "For fields with a purpose of `PASSWORD` this is the entropy of the value",
      "readOnly": true
    },
    "generate": {
      "description": "If value is not present then a new value should be generated for this field",
      "default": false,
      "type": "boolean"
    },
    "id": {"type": "string"},
    "label": {"type": "string"},
    "purpose": {
      "description": "Some item types, Login and Password, have fields used for autofill. This property indicates that purpose and is required for some item types.",
      "type": "string",
      "enum": [
        "",
        "NOTES",
        "PASSWORD",
        "USERNAME"
      ]
    },
    "recipe": {"$ref": "#/definitions/GeneratorRecipe"},
    "section": {
      "type": "object",
      "properties": {}
    },
    "type": {
      "default": "STRING",
      "type": "string",
      "enum": [
        "TOTP",
        "DATE",
        "MONTH_YEAR",
        "CONCEALED",
        "STRING",
        "MENU",
        "EMAIL",
        "URL"
      ]
    },
    "value": {"type": "string"}
  }
}

Definition entropy
Annotations
 
Description  For fields with a purpose of `PASSWORD` this is the entropy of the value
Diagram
Type number
Used by
Schema
Field
Source
 

 "entropy": {
  "type": "number",
  "description": "For fields with a purpose of `PASSWORD` this is the entropy of the value",
  "readOnly": true
}

Definition generate
false
Annotations
 
Description  If value is not present then a new value should be generated for this field
Diagram
Type boolean
Used by
Schema
Field
Source
 

 "generate": {
  "description": "If value is not present then a new value should be generated for this field",
  "default": false,
  "type": "boolean"
}

Definition id
Diagram
Type string
Used by
Schema
Field
Source
 

 "id": {"type": "string"}

Definition label
Diagram
Type string
Used by
Schema
Field
Source
 

 "label": {"type": "string"}

Definition purpose
Annotations
 
Description  Some item types, Login and Password, have fields used for autofill. This property indicates that purpose and is required for some item types.
Diagram
Type string
Enumeration
Values
NOTES
PASSWORD
USERNAME
Used by
Schema
Field
Source
 

 "purpose": {
  "description": "Some item types, Login and Password, have fields used for autofill. This property indicates that purpose and is required for some item types.",
  "type": "string",
  "enum": [
    "",
    "NOTES",
    "PASSWORD",
    "USERNAME"
  ]
}

Definition recipe
definitions_GeneratorRecipe.html#/definitions/GeneratorRecipe
Diagram
Type reference
Refers GeneratorRecipe
Used by
Schema
Field
Source
 

 "recipe": {"$ref": "#/definitions/GeneratorRecipe"}

Definition section
definitions_Field.html#/definitions/Field/properties/section/properties/id
Diagram
Type object
Properties
Name Occurrence
id
 optional
Additional Properties true
Used by
Schema
Field
Source
 

 "section": {
  "type": "object",
  "properties": {
    "id": {"type": "string"}
  }
}

Definition id
Diagram
Type string
Used by
Source
 

 "id": {"type": "string"}

Definition type
Diagram
Type string
Constraints
 
Default : STRING
Enumeration
Values
TOTP
DATE
MONTH_YEAR
CONCEALED
STRING
MENU
EMAIL
URL
Used by
Schema
Field
Source
 

 "type": {
  "default": "STRING",
  "type": "string",
  "enum": [
    "TOTP",
    "DATE",
    "MONTH_YEAR",
    "CONCEALED",
    "STRING",
    "MENU",
    "EMAIL",
    "URL"
  ]
}

Definition value
Diagram
Type string
Used by
Schema
Field
Source
 

 "value": {"type": "string"}