Skip to content

Commit

Permalink
Update VTEX - Policies System API.json
Browse files Browse the repository at this point in the history
  • Loading branch information
karenkrieger committed Dec 1, 2023
1 parent 8e24d10 commit f6ceebd
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions VTEX - Policies System API.json
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,8 @@
"name": {
"type": "string",
"description": "Policy name.",
"title": "name"
"title": "name",
"example": "id"
},
"description": {

Check failure on line 603 in VTEX - Policies System API.json

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

request-body-properties-example

Each request body property must contain an example.
"type": "string",
Expand Down Expand Up @@ -627,7 +628,8 @@
"name": {
"type": "string",
"description": "Policy name.",
"title": "name"
"title": "name",
"example": "id"

Check failure on line 632 in VTEX - Policies System API.json

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

response-body-objects-arrays-example

Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
},
"description": {
"type": "string",
Expand Down Expand Up @@ -689,7 +691,8 @@
"resource": {
"type": "string",
"description": "Scope on which this policy must be evaluated.",
"title": "resource"
"title": "resource",
"example": "vrn:vtex.promotions-alert:aws-us-east-1:kamila:master:/_v/promotions_alert"

Check failure on line 695 in VTEX - Policies System API.json

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

response-body-objects-arrays-example

Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
},
"condition": {
"type": "object",
Expand All @@ -698,7 +701,7 @@
"type": "array",
"description": "List of conditions that will activate the policy.",
"items": {

Check failure on line 703 in VTEX - Policies System API.json

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

items-type

Each request or response body array "items" property must contain a type.
"description": "Array of conditions.",
"description": "List of conditions that will activate the policy.",
"properties": {
"conditions": {
"title": "conditions",
Expand Down Expand Up @@ -753,7 +756,8 @@
"title": "values",
"items": {
"type": "string",
"description": "Key value."
"description": "Key value.",
"example": "40.00"

Check failure on line 760 in VTEX - Policies System API.json

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

response-body-objects-arrays-example

Response body fields should not contain the "example" field. The response example corresponds to the whole schema.
},
"description": "Array with values of the key."
}
Expand Down

0 comments on commit f6ceebd

Please sign in to comment.