Documentation for schema

Diagram

Type

object

Properties

Name	Occurrence
id section type purpose label value generate recipe entropy	required optional required optional optional optional optional optional optional

Used by

Schema

Field

Source


 "Field": {
  "type": "object",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {"type": "string"},
    "section": {
      "type": "object",
      "properties": {}
    },
    "type": {
      "default": "STRING",
      "type": "string",
      "enum": [
        "TOTP",
        "DATE",
        "MONTH_YEAR",
        "CONCEALED",
        "STRING",
        "MENU",
        "EMAIL",
        "URL"
      ]
    },
    "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"
      ]
    },
    "label": {"type": "string"},
    "value": {"type": "string"},
    "generate": {
      "description": "If value is not present then a new value should be generated for this field",
      "default": false,
      "type": "boolean"
    },
    "recipe": {"ref": "#/components/schemas/GeneratorRecipe"},
    "entropy": {
      "type": "number",
      "description": "For fields with a purpose of `PASSWORD` this is the entropy of the value",
      "readOnly": true
    }
  }
}

Diagram

Type

string

Used by

Schema

Field

Field/properties/id

Source


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

Diagram

Type

object

Properties

Name	Occurrence
id	optional

Used by

Schema

Field

Field/properties/section

Source


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

Diagram

Type

string

Used by

Schema

Field/properties/section

Field/properties/section/properties/id

Source


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

Diagram

Type

string

Constraints

Default : STRING

Enumeration

Values

TOTP

DATE

MONTH_YEAR

CONCEALED

STRING

URL

Used by

Schema

Field

Field/properties/type

Source


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

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

Field/properties/purpose

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"
  ]
}

Diagram

Type

string

Used by

Schema

Field

Field/properties/label

Source


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

Diagram

Type

string

Used by

Schema

Field

Field/properties/value

Source


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

Annotations

Description  If value is not present then a new value should be generated for this field

Diagram

Type

boolean

Default value :

false

Used by

Schema

Field

Field/properties/generate

Source


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

Diagram

Type

empty schema

Used by

Schema

Field

Field/properties/recipe

Source


 "recipe": {"ref": "#/components/schemas/GeneratorRecipe"}

Annotations

Description  For fields with a purpose of `PASSWORD` this is the entropy of the value

Diagram

Type

number

Used by

Schema

Field

Field/properties/entropy

Source


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