VTEX · Schema

PolicySaveRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
name string Policy name.
description string Policy description, only for internal use.
statements array Requirements for the the policy to be applied.
View JSON Schema on GitHub

JSON Schema

vtex-policysaverequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PolicySaveRequest",
  "title": "PolicySaveRequest",
  "required": [
    "name",
    "description",
    "statements"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Policy name.",
      "title": "name",
      "example": "id"
    },
    "description": {
      "type": "string",
      "description": "Policy description, only for internal use.",
      "title": "description",
      "example": "TesteMarcosPromotionsAlert"
    },
    "statements": {
      "type": "array",
      "title": "statements",
      "items": {
        "$ref": "#/components/schemas/StatementGetResponse"
      },
      "description": "Requirements for the the policy to be applied."
    }
  }
}