Service - Variant Standard: Difference between revisions

From Izara Wiki
Jump to navigation Jump to search
(Created page with "= Overview = Handler service for the standard variant type. = Repository = XXXX = DynamoDB tables = == Standard Config Table Per Service == === Configuration tags ==...")
 
 
(17 intermediate revisions by 2 users not shown)
Line 5: Line 5:
= Repository =
= Repository =


XXXX
https://bitbucket.org/izara-market-products/izara-market-products-variant-standard/src/master/
 
= DynamoDB tables =
 
== [[Standard Config Table Per Service]] ==
 
=== Configuration tags ===


= Schemas =
==ObjectSchemas==
=== variantStandard ===
<syntaxhighlight lang="JavaScript">
<syntaxhighlight lang="JavaScript">
{
{
configTag: "VariantServiceNameTag"
  "objectType": "variantStandard",
configKey: "VariantServiceNameTag"
  "extendObjType": {
configValue: xxx // this own services ServiceNameTag, eg "VariantStandard"
    "serviceTag": "VariantManager",
    "objectType": "variant"
  },
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    },
    "dynamoDB": {
      "storageType": "dynamoDB",
      "tableName": "VariantRecord",
      "serviceTag": "VariantManager"
    }
  },
  "fieldNames": {
    "variantId": {
      "storageResourceTags": [
        "graph",
        "dynamoDB"
      ]
    }
  },
  "generatedBy": "userGenerated"
}
}
</syntaxhighlight>
</syntaxhighlight>


=== variantProductLink ===
<syntaxhighlight lang="JavaScript">
<syntaxhighlight lang="JavaScript">
{
{
configTag: "ProductsGraphServiceName"
  "objectType": "variantProductLink",
configKey: "ProductsGraphServiceName"
  "canDelete": true,
configValue: xxx // eg: "ProductsGraph"
  "belongTo": {
    "serviceTag": "UserAccount",
    "objectType": "user"
  },
  "addOnDataStructure": [],
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    }
  },
  "fieldNames": {
    "variantProductLinkId": {
      "type": "string",
      "randomOnCreate": false,
      "requiredOnCreate": false,
      "optionalOnCreate": false,
      "canUpdate": false,
      "validation": {
        "pattern": "^[a-zA-Z0-9_-]+$"
      },
      "storageResourceTags": [
        "graph"
      ],
      "hashOnCreate": [
        "variantId",
        "productId"
      ]
    },
    "variantId": {
      "type": "string",
      "randomOnCreate": false,
      "requiredOnCreate": true,
      "optionalOnCreate": false,
      "canUpdate": false,
      "validation": {
        "pattern": "^[a-zA-Z0-9_-]+$"
      },
      "storageResourceTags": [
        "graph"
      ]
    },
    "productId": {
      "type": "string",
      "randomOnCreate": false,
      "requiredOnCreate": true,
      "optionalOnCreate": false,
      "canUpdate": false,
      "validation": {
        "pattern": "^[a-zA-Z0-9_-]+$"
      },
      "storageResourceTags": [
        "graph"
      ]
    }
  },
  "compositeKeyDeliminator": "_",
  "identifiers": [
    {
      "type": "identifier",
      "fieldName": "variantProductLinkId"
    }
  ],
  "generatedBy": "userGenerated"
}
}
</syntaxhighlight>
</syntaxhighlight>


=== variantAttributeValueStandard ===
<syntaxhighlight lang="JavaScript">
<syntaxhighlight lang="JavaScript">
{
{
configTag: "VariantManagerServiceName"
  "objectType": "variantAttributeValueStandard",
configKey: "VariantManagerServiceName"
  "addOnDataStructure": [],
configValue: xxx // eg: "ProductManager"
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    }
  },
  "fieldNames": {
 
  },
  "extendObjType": {
    "objectType": "variantAttributeValue",
    "serviceTag": "VariantManager"
  },
  "generatedBy": "userGenerated"
}
}
</syntaxhighlight>
</syntaxhighlight>


== RelationshipSchemas ==


= Graph database =  
=== hasVariantProductLink ===
<syntaxhighlight lang="JavaScript">
{
  "relationshipServiceTag": "VariantStandard",
  "fieldNames": {
    "originTimeStamp": {
      "type": "number",
      "requiredOnCreate": false,
      "canUpdate": true,
      "validation": {


== [[Service - Products Graph]]==
      },
      "optionalOnCreate": false
    },
  },
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    }
  },
  "links": [
    {
      "storageResourceTags": [
        "graph"
      ],
      "from": {
        "objType": {
          "serviceTag": "VariantStandard",
          "objectType": "variantProductLink"
        },
        "linkType": "one",
        "requiredOnCreate": true,
        "handler": true
      },
      "to": {
        "objType": {
          "serviceTag": "VariantStandard",
          "objectType": "variantStandard"
        },
        "linkType": "one",
        "handler": true,
        "requiredOnCreate": false
      },
      "canDelete": false
    }
  ],
  "canMove": false
}
</syntaxhighlight>


=== Nodes ===
=== disabledVariantProductLink ===
<syntaxhighlight lang="JavaScript">
{
  "relationshipServiceTag": "VariantStandard",
  "fieldNames": {
    "originTimeStamp": {
      "type": "number",
      "requiredOnCreate": false,
      "canUpdate": true,
      "validation": {


==== variant ====
      },
 
      "optionalOnCreate": false
Is an origin/home/top-level node, one per variant.
    },
 
  },
* NodeIdentifierLabels: variant
  "storageResources": {
* NodeIdentifierProperties: variantId (random uuid)
    "graph": {
 
      "storageType": "graph",
Properties:
      "graphServerTag": "GraphHandler"
 
    }
# ..
  },
  "links": [
    {
      "storageResourceTags": [
        "graph"
      ],
      "from": {
        "objType": {
          "serviceTag": "VariantStandard",
          "objectType": "variantProductLink"
        },
        "linkType": "one",
        "handler": true,
        "requiredOnCreate": false
      },
      "to": {
        "objType": {
          "serviceTag": "VariantStandard",
          "objectType": "variantStandard"
        },
        "linkType": "one",
        "handler": true,
        "requiredOnCreate": false
      },
      "canDelete": false
    }
  ],
  "canMove": false
}
</syntaxhighlight>


= Working documents =
= Working documents =

Latest revision as of 08:40, 13 January 2026

Overview

Handler service for the standard variant type.

Repository

https://bitbucket.org/izara-market-products/izara-market-products-variant-standard/src/master/

Schemas

ObjectSchemas

variantStandard

{
  "objectType": "variantStandard",
  "extendObjType": {
    "serviceTag": "VariantManager",
    "objectType": "variant"
  },
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    },
    "dynamoDB": {
      "storageType": "dynamoDB",
      "tableName": "VariantRecord",
      "serviceTag": "VariantManager"
    }
  },
  "fieldNames": {
    "variantId": {
      "storageResourceTags": [
        "graph",
        "dynamoDB"
      ]
    }
  },
  "generatedBy": "userGenerated"
}

variantProductLink

{
  "objectType": "variantProductLink",
  "canDelete": true,
  "belongTo": {
    "serviceTag": "UserAccount",
    "objectType": "user"
  },
  "addOnDataStructure": [],
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    }
  },
  "fieldNames": {
    "variantProductLinkId": {
      "type": "string",
      "randomOnCreate": false,
      "requiredOnCreate": false,
      "optionalOnCreate": false,
      "canUpdate": false,
      "validation": {
        "pattern": "^[a-zA-Z0-9_-]+$"
      },
      "storageResourceTags": [
        "graph"
      ],
      "hashOnCreate": [
        "variantId",
        "productId"
      ]
    },
    "variantId": {
      "type": "string",
      "randomOnCreate": false,
      "requiredOnCreate": true,
      "optionalOnCreate": false,
      "canUpdate": false,
      "validation": {
        "pattern": "^[a-zA-Z0-9_-]+$"
      },
      "storageResourceTags": [
        "graph"
      ]
    },
    "productId": {
      "type": "string",
      "randomOnCreate": false,
      "requiredOnCreate": true,
      "optionalOnCreate": false,
      "canUpdate": false,
      "validation": {
        "pattern": "^[a-zA-Z0-9_-]+$"
      },
      "storageResourceTags": [
        "graph"
      ]
    }
  },
  "compositeKeyDeliminator": "_",
  "identifiers": [
    {
      "type": "identifier",
      "fieldName": "variantProductLinkId"
    }
  ],
  "generatedBy": "userGenerated"
}

variantAttributeValueStandard

{
  "objectType": "variantAttributeValueStandard",
  "addOnDataStructure": [],
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    }
  },
  "fieldNames": {

  },
  "extendObjType": {
    "objectType": "variantAttributeValue",
    "serviceTag": "VariantManager"
  },
  "generatedBy": "userGenerated"
}

RelationshipSchemas

hasVariantProductLink

{
  "relationshipServiceTag": "VariantStandard",
  "fieldNames": {
    "originTimeStamp": {
      "type": "number",
      "requiredOnCreate": false,
      "canUpdate": true,
      "validation": {

      },
      "optionalOnCreate": false
    },
  },
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    }
  },
  "links": [
    {
      "storageResourceTags": [
        "graph"
      ],
      "from": {
        "objType": {
          "serviceTag": "VariantStandard",
          "objectType": "variantProductLink"
        },
        "linkType": "one",
        "requiredOnCreate": true,
        "handler": true
      },
      "to": {
        "objType": {
          "serviceTag": "VariantStandard",
          "objectType": "variantStandard"
        },
        "linkType": "one",
        "handler": true,
        "requiredOnCreate": false
      },
      "canDelete": false
    }
  ],
  "canMove": false
}

disabledVariantProductLink

{
  "relationshipServiceTag": "VariantStandard",
  "fieldNames": {
    "originTimeStamp": {
      "type": "number",
      "requiredOnCreate": false,
      "canUpdate": true,
      "validation": {

      },
      "optionalOnCreate": false
    },
  },
  "storageResources": {
    "graph": {
      "storageType": "graph",
      "graphServerTag": "GraphHandler"
    }
  },
  "links": [
    {
      "storageResourceTags": [
        "graph"
      ],
      "from": {
        "objType": {
          "serviceTag": "VariantStandard",
          "objectType": "variantProductLink"
        },
        "linkType": "one",
        "handler": true,
        "requiredOnCreate": false
      },
      "to": {
        "objType": {
          "serviceTag": "VariantStandard",
          "objectType": "variantStandard"
        },
        "linkType": "one",
        "handler": true,
        "requiredOnCreate": false
      },
      "canDelete": false
    }
  ],
  "canMove": false
}

Working documents

Variant Standard