Commit d7457006 authored by Hammad Zafar's avatar Hammad Zafar Committed by Giacomo Bernini
Browse files

added json body template and schema for PolicyModifications data type

parent 269ee115
Loading
Loading
Loading
Loading
+7 −0
Original line number Original line Diff line number Diff line
{
  "activationStatus": "ACTIVATED",
  "selectedVersion": "",
  "addAssociations": [],
  "removeAssociations": [],
  "removeAllAssociations": "FALSE"
}
 No newline at end of file
+45 −0
Original line number Original line Diff line number Diff line
{
	"description": "The parameter for the policy modifications, as defined in clause 5.6.2.4.\n",
	"content": {
		"application/json": {
			"schema": {
				"description": "This type represents the parameters for modifying a policy. It shall comply with the provisions defined in table 5.6.2.4-1\n",
				"type": "object",
				"properties": {
					"activationStatus": {
						"description": "The enumeration ActivationStatus shall comply with the provisions defined in table 5.6.4.3-1. It indicates the activation status of a policy.\n",
						"type": "string",
						"enum": [
							"ACTIVATED",
							"DEACTIVATED"
						]
					},
					"selectedVersion": {
						"description": "A version.\n",
						"type": "string"
					},
					"addAssociations": {
						"description": "Identifiers of entities to be added to the “associations” attribute in the “Policy” data structure which represents the policy. The API producer shall ignore the identifiers that already exist in the \"associations\" attribute in the “Policy” data structure. Shall be absent when the association feature is not applicable for the PF.\n",
						"type": "array",
						"items": {
							"description": "An identifier with the intention of being globally unique.\n",
							"type": "string"
						}
					},
					"removeAssociations": {
						"description": "Identifiers of entities to be removed from the “associations” attribute in the “Policy” data structure which represents the policy. The API producer shall ignore the identifiers that do not exist in the \"associations\" attribute in the “Policy” data structure. Shall be absent when the association feature is not applicable for the PF.\n",
						"type": "array",
						"items": {
							"description": "An identifier with the intention of being globally unique.\n",
							"type": "string"
						}
					},
					"removeAllAssociations": {
						"description": "Shall be set to TRUE if the policy is no longer associated to any specific entities managed by the PF. Shall be absent when the association feature is not applicable for the PF. If \"removeAllAssociations\" is set to TRUE, neither \"addAssociations\" nor “removeAssociations” attributes shall be present. Once all associations have been removed, how the PF determines the scope of applicability of the policy is outside the scope of the present document.\n",
						"type": "boolean"
					}
				}
			}
		}
	}
}
 No newline at end of file