Skip to content

docs(webhook_schemas): Update webhook schemas #1305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Phrase (phrase-bot) wants to merge 1 commit into from
Closed

docs(webhook_schemas): Update webhook schemas #1305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
214 changes: 214 additions & 0 deletions webhook_schemas/check_issues_create.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,214 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"event": {
"type": "string"
},
"message": {
"type": "string"
},
"sent_at": {
"type": "string",
"format": "date-time"
},
"project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"main_format": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"name",
"main_format",
"created_at",
"updated_at"
]
},
"branch": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
},
"check_issue": {
"type": "object",
"title": "check_issue",
"properties": {
"id": {
"type": "string"
},
"check_name": {
"type": "string"
},
"state": {
"type": "string"
},
"description": {
"type": "string"
},
"dismissed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"solved_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"translation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"content": {
"type": [
"string",
"null"
]
},
"unverified": {
"type": "boolean"
},
"excluded": {
"type": "boolean"
},
"plural_suffix": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"key": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"plural": {
"type": "boolean"
},
"use_ordinal_rules": {
"type": "boolean"
},
"data_type": {
"type": [
"string",
"null"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"name",
"plural",
"use_ordinal_rules",
"data_type",
"tags"
]
},
"locale": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"code": {
"type": "string"
}
},
"required": [
"id",
"name",
"code"
]
}
},
"required": [
"id",
"content",
"created_at",
"updated_at",
"key",
"locale"
]
}
},
"required": [
"id",
"check_name",
"state",
"description",
"dismissed_at",
"solved_at",
"created_at",
"updated_at",
"translation"
]
}
},
"required": [
"event",
"message",
"project",
"check_issue"
]
}
50 changes: 50 additions & 0 deletions webhook_schemas/check_issues_create_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
{
"event": "check_issues:create",
"message": "Phrase detected a new check issue \"Translation exceeds the maximum number of allowed characters\" on key \"homepage.title\" in locale German (de) in project Translation Project",
"sent_at": "2025-02-07 16:44:04 UTC",
"project": {
"id": "b2abd3bd2c23ff0ac546e0a2d9aa0be1",
"name": "Translation Project",
"slug": "translation-project",
"main_format": "yml",
"project_image_url": null,
"created_at": "2025-02-07 16:18:13 UTC",
"updated_at": "2025-02-07 16:18:13 UTC",
"point_of_contact": null
},
"branch": {
"name": "new-feature-1"
},
"check_issue": {
"id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"check_name": "translation_content_length",
"state": "active",
"description": "Translation exceeds the maximum number of allowed characters by 12 characters (content is 42 characters, limit is 30)",
"dismissed_at": null,
"solved_at": null,
"created_at": "2025-02-07 16:44:04 UTC",
"updated_at": "2025-02-07 16:44:04 UTC",
"translation": {
"id": "68740d06f87390fd357f12e0d7ddb9a2",
"content": "Willkommen auf unserer brandneuen Startseite mit allen Neuigkeiten",
"unverified": true,
"excluded": false,
"plural_suffix": null,
"created_at": "2025-02-07 16:18:13 UTC",
"updated_at": "2025-02-07 16:44:04 UTC",
"key": {
"id": "24b9a53ad72e198ca332fba91bb95f57",
"name": "homepage.title",
"plural": false,
"use_ordinal_rules": false,
"data_type": null,
"tags": []
},
"locale": {
"id": "9c1a2b3c4d5e6f708192a3b4c5d6e7f8",
"name": "German (de)",
"code": "de"
}
}
}
}
Loading
Loading