{"id":"006a9695-fa9a-4b5f-9951-e11ff421ad6c","createdDate":"2024-10-14T08:06:51.307Z","updatedDate":"2024-10-14T08:06:51.307Z","resourceId":"11b6beda-7363-4077-a98f-0c87e9d6933a","api":{"schema":{"object":{"displayName":"Schema Object","description":"","slug":"schema-object","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema","legacyExamples":[{"title":"Schema","content":"{\n \"schema\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"display_name\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"display_name\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product's Image\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n }\n }\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/linguist.git"},"methods":[{"summary":"Create Schema","description":"Creates a translation schema.","operationId":"wix.multilingual.translation.schema.v1.TranslationSchema.CreateSchema","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.CreateSchemaResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/translation-schema","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/translation-schema","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateSchemaRequest","description":"","properties":{"schema":{"description":"Translation schema to create.","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema","summary":"schema","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["schema","schema.key","schema.key.entityType","schema.fields"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Schema Created","description":"Triggered when a translation schema is created.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.multilingual.translation.v1.schema","serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.multilingual.translation.v1.schema_created","sourceRepo":"git@github.com:wix-private/linguist.git"}],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_CREATE_ORGANIZATION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Translation Schema Write","scopeId":"SCOPE.DC-MULTILINGUAL.WRITE_TRANSLATION_SCHEMA"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.CreateSchemaRequest","responseMessage":"wix.multilingual.translation.schema.v1.CreateSchemaResponse"},"legacyExamples":[{"name":"CreateSchema","serviceName":"TranslationSchema","type":"METHOD","order":2,"content":{"title":"Create a Schema with a Site Scope","request":"curl -X POST \\\n 'https://www.wixapis.com/translation-schema/v1/schemas' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"schema\": {\n \"key\": {\n \"entityType\": \"My-Pet-Collection\",\n \"scope\": \"SITE\"\n },\n \"fields\": {\n \"petMame\": {\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Pet Name\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"petType\": {\n \"type\": \"LONG_TEXT\",\n \"displayName\": \"Pet Type (cat, dog, etc)\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"medicalState\": {\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Pet Medical State\",\n \"hidden\": false,\n \"displayOnly\": false\n }\n }\n }\n }'","response":"{\n \"schema\": {\n \"id\": \"377a6a55-8c2b-47fe-99ba-b51cc63d71a3\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"My-Pet-Collection\",\n \"scope\": \"SITE\"\n },\n \"fields\": {\n \"petMame\": {\n \"id\": \"petMame\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Pet Name\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"petType\": {\n \"id\": \"petType\",\n \"type\": \"LONG_TEXT\",\n \"displayName\": \"Pet Type (cat, dog, etc)\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"medicalState\": {\n \"id\": \"medicalState\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Pet Medical State\",\n \"hidden\": false,\n \"displayOnly\": false\n }\n },\n \"hidden\": false,\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T10:49:48.340Z\",\n \"updatedDate\": \"2024-09-16T10:49:48.340Z\",\n \"duplicateContent\": false\n }\n}"}},{"name":"CreateSchema","serviceName":"TranslationSchema","type":"METHOD","order":1,"content":{"title":"Create Schema with a Global Scope","request":"curl -X POST \\\n 'https://www.wixapis.com/translation-schema/v1/schemas' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"schema\": {\n \"key\": {\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"type\": \"IMAGE\",\n \"displayName\": \"Product Image\",\n \"hidden\": false,\n \"displayOnly\": false\n }\n }\n }\n }'","response":"{\n \"schema\": {\n \"id\": \"9428de50-b559-43f7-bec4-1cb21a23f72f\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product Image\",\n \"hidden\": false,\n \"displayOnly\": false\n }\n },\n \"hidden\": false,\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T10:44:08.532Z\",\n \"updatedDate\": \"2024-09-16T10:44:08.532Z\",\n \"duplicateContent\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git"},"httpMethod":"post","path":"/v1/schemas","rpcOnly":false,"triggeredEvents":[{"title":"Schema Created","description":"Triggered when a translation schema is created.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.multilingual.translation.v1.schema","serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.multilingual.translation.v1.schema_created","sourceRepo":"git@github.com:wix-private/linguist.git"}],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_CREATE_ORGANIZATION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Translation Schema Write","scopeId":"SCOPE.DC-MULTILINGUAL.WRITE_TRANSLATION_SCHEMA"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.CreateSchemaRequest","responseMessage":"wix.multilingual.translation.schema.v1.CreateSchemaResponse"},"legacyExamples":[{"name":"CreateSchema","serviceName":"TranslationSchema","type":"METHOD","order":2,"content":{"title":"Create a Schema with a Site Scope","request":"curl -X POST \\\n 'https://www.wixapis.com/translation-schema/v1/schemas' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"schema\": {\n \"key\": {\n \"entityType\": \"My-Pet-Collection\",\n \"scope\": \"SITE\"\n },\n \"fields\": {\n \"petMame\": {\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Pet Name\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"petType\": {\n \"type\": \"LONG_TEXT\",\n \"displayName\": \"Pet Type (cat, dog, etc)\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"medicalState\": {\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Pet Medical State\",\n \"hidden\": false,\n \"displayOnly\": false\n }\n }\n }\n }'","response":"{\n \"schema\": {\n \"id\": \"377a6a55-8c2b-47fe-99ba-b51cc63d71a3\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"My-Pet-Collection\",\n \"scope\": \"SITE\"\n },\n \"fields\": {\n \"petMame\": {\n \"id\": \"petMame\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Pet Name\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"petType\": {\n \"id\": \"petType\",\n \"type\": \"LONG_TEXT\",\n \"displayName\": \"Pet Type (cat, dog, etc)\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"medicalState\": {\n \"id\": \"medicalState\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Pet Medical State\",\n \"hidden\": false,\n \"displayOnly\": false\n }\n },\n \"hidden\": false,\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T10:49:48.340Z\",\n \"updatedDate\": \"2024-09-16T10:49:48.340Z\",\n \"duplicateContent\": false\n }\n}"}},{"name":"CreateSchema","serviceName":"TranslationSchema","type":"METHOD","order":1,"content":{"title":"Create Schema with a Global Scope","request":"curl -X POST \\\n 'https://www.wixapis.com/translation-schema/v1/schemas' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"schema\": {\n \"key\": {\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"type\": \"IMAGE\",\n \"displayName\": \"Product Image\",\n \"hidden\": false,\n \"displayOnly\": false\n }\n }\n }\n }'","response":"{\n \"schema\": {\n \"id\": \"9428de50-b559-43f7-bec4-1cb21a23f72f\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product Image\",\n \"hidden\": false,\n \"displayOnly\": false\n }\n },\n \"hidden\": false,\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T10:44:08.532Z\",\n \"updatedDate\": \"2024-09-16T10:44:08.532Z\",\n \"duplicateContent\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git","contentLink":{"displayName":"Create Schema","slugifiedName":"create-schema"},"permissionScopes":[{"name":"Wix Multilingual - Translation Schema Write","scopeId":"SCOPE.DC-MULTILINGUAL.WRITE_TRANSLATION_SCHEMA"}],"isAdminMethod":true},{"summary":"Get Schema","description":"Retrieves a translation schema by ID.","operationId":"wix.multilingual.translation.schema.v1.TranslationSchema.GetSchema","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"schemaId","description":"ID of the translation schema to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.GetSchemaResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/translation-schema","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/translation-schema","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_READ_ORGANIZATION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Translation Schema Read","scopeId":"SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_SCHEMA"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.GetSchemaRequest","responseMessage":"wix.multilingual.translation.schema.v1.GetSchemaResponse"},"legacyExamples":[{"name":"GetSchema","serviceName":"TranslationSchema","type":"METHOD","content":{"title":"Get Schema By ID","request":"curl -X GET \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: ' \\","response":"{\n \"schema\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product's Image\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n },\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git"},"httpMethod":"get","path":"/v1/schemas/{schemaId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_READ_ORGANIZATION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Translation Schema Read","scopeId":"SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_SCHEMA"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.GetSchemaRequest","responseMessage":"wix.multilingual.translation.schema.v1.GetSchemaResponse"},"legacyExamples":[{"name":"GetSchema","serviceName":"TranslationSchema","type":"METHOD","content":{"title":"Get Schema By ID","request":"curl -X GET \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: ' \\","response":"{\n \"schema\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product's Image\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n },\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git","contentLink":{"displayName":"Get Schema","slugifiedName":"get-schema"},"permissionScopes":[{"name":"Wix Multilingual - Translation Schema Read","scopeId":"SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_SCHEMA"}],"isAdminMethod":true},{"summary":"Delete Schema","description":"Deletes a translation schema.","operationId":"wix.multilingual.translation.schema.v1.TranslationSchema.DeleteSchema","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"schemaId","description":"ID of the translation schema to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.DeleteSchemaResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/translation-schema","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/translation-schema","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Schema Deleted","description":"Triggered when a translation schema is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.multilingual.translation.v1.schema","serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.multilingual.translation.v1.schema_deleted","sourceRepo":"git@github.com:wix-private/linguist.git"}],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_DELETE_ORGANIZATION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Translation Schema Write","scopeId":"SCOPE.DC-MULTILINGUAL.WRITE_TRANSLATION_SCHEMA"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.DeleteSchemaRequest","responseMessage":"wix.multilingual.translation.schema.v1.DeleteSchemaResponse"},"legacyExamples":[{"name":"DeleteSchema","serviceName":"TranslationSchema","type":"METHOD","content":{"title":"Delete Schema","request":"curl -X DELETE \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git"},"httpMethod":"delete","path":"/v1/schemas/{schemaId}","rpcOnly":false,"triggeredEvents":[{"title":"Schema Deleted","description":"Triggered when a translation schema is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.multilingual.translation.v1.schema","serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.multilingual.translation.v1.schema_deleted","sourceRepo":"git@github.com:wix-private/linguist.git"}],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_DELETE_ORGANIZATION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Translation Schema Write","scopeId":"SCOPE.DC-MULTILINGUAL.WRITE_TRANSLATION_SCHEMA"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.DeleteSchemaRequest","responseMessage":"wix.multilingual.translation.schema.v1.DeleteSchemaResponse"},"legacyExamples":[{"name":"DeleteSchema","serviceName":"TranslationSchema","type":"METHOD","content":{"title":"Delete Schema","request":"curl -X DELETE \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git","contentLink":{"displayName":"Delete Schema","slugifiedName":"delete-schema"},"permissionScopes":[{"name":"Wix Multilingual - Translation Schema Write","scopeId":"SCOPE.DC-MULTILINGUAL.WRITE_TRANSLATION_SCHEMA"}],"isAdminMethod":true},{"summary":"Get Schema By Key","description":"Retrieves a translation schema by key.","operationId":"wix.multilingual.translation.schema.v1.TranslationSchema.GetSchemaByKey","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"key.appId","description":"ID of the app that created the schema.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"in":"path","schema":{"type":"string"},"required":true,"name":"key.entityType","description":"A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"in":"path","schema":{"type":"string"},"required":true,"name":"key.scope","description":"Scope of the translation schema.\nSupported values:\n+ `GLOBAL`: A global schema for all sites.\n+ `SITE`: A custom schema for a specific site.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"key","in":"query","description":"ID of the translation schema to retrieve.","required":true,"schema":{"description":"ID of the translation schema to retrieve.","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.SchemaKey","summary":"key","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.GetSchemaByKeyResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/translation-schema","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/translation-schema","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_READ_ORGANIZATION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Translation Schema Read","scopeId":"SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_SCHEMA"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.GetSchemaByKeyRequest","responseMessage":"wix.multilingual.translation.schema.v1.GetSchemaByKeyResponse"},"legacyExamples":[{"name":"GetSchemaByKey","serviceName":"TranslationSchema","type":"METHOD","content":{"title":"Get Schema By Key","request":"curl -X GET \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/app-id/4ad2dfe1-a943-45a8-94ac-f1dd8b78821b/entity-type/Product/scope/GLOBAL' \\\n -H 'Authorization: ' \\","response":"{\n \"schema\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product's Image\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n }\n }\n \"hidden\": false,\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T10:52:45.680Z\",\n \"updatedDate\": \"2024-09-16T10:52:45.680Z\",\n \"duplicateContent\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git"},"httpMethod":"get","path":"/v1/schemas/app-id/{key.appId}/entity-type/{key.entityType}/scope/{key.scope}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_READ_ORGANIZATION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Translation Schema Read","scopeId":"SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_SCHEMA"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.GetSchemaByKeyRequest","responseMessage":"wix.multilingual.translation.schema.v1.GetSchemaByKeyResponse"},"legacyExamples":[{"name":"GetSchemaByKey","serviceName":"TranslationSchema","type":"METHOD","content":{"title":"Get Schema By Key","request":"curl -X GET \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/app-id/4ad2dfe1-a943-45a8-94ac-f1dd8b78821b/entity-type/Product/scope/GLOBAL' \\\n -H 'Authorization: ' \\","response":"{\n \"schema\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product's Image\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n }\n }\n \"hidden\": false,\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T10:52:45.680Z\",\n \"updatedDate\": \"2024-09-16T10:52:45.680Z\",\n \"duplicateContent\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git","contentLink":{"displayName":"Get Schema By Key","slugifiedName":"get-schema-by-key"},"permissionScopes":[{"name":"Wix Multilingual - Translation Schema Read","scopeId":"SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_SCHEMA"}],"isAdminMethod":true},{"summary":"Update Schema","description":"Updates a translation schema.\n\nTo remove a field, pass the field key with an empty object as the value. For example:\n\n```json\n{\n\"fields\": {\n\"title\": {}\n}\n}\n```\n\n

\nCaution:\n\nRemoving a schema field makes the corresponding content field unavailable.\n

","operationId":"wix.multilingual.translation.schema.v1.TranslationSchema.UpdateSchema","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"schema.id","description":"Translation schema ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.UpdateSchemaResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/translation-schema","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/translation-schema","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateSchemaRequest","description":"","properties":{"schema":{"description":"Translation schema to update.","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema","summary":"schema","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["schema","schema.id","schema.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Schema Updated","description":"Triggered when a translation schema is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.multilingual.translation.v1.schema","serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.multilingual.translation.v1.schema_updated","sourceRepo":"git@github.com:wix-private/linguist.git"}],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_UPDATE_ORGANIZATION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Translation Schema Write","scopeId":"SCOPE.DC-MULTILINGUAL.WRITE_TRANSLATION_SCHEMA"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.UpdateSchemaRequest","responseMessage":"wix.multilingual.translation.schema.v1.UpdateSchemaResponse"},"legacyExamples":[{"name":"UpdateSchema","serviceName":"TranslationSchema","type":"METHOD","content":{"title":"Update Schema","request":"curl -X PATCH \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"schema\": {\n \"displayName\": \"A New Display Name\",\n \"revision\": 1,\n },\n }'","response":"{\n \"schema\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"display_name\": \"A new Display Name\",\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product's Image\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n },\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git"},"httpMethod":"patch","path":"/v1/schemas/{schema.id}","rpcOnly":false,"triggeredEvents":[{"title":"Schema Updated","description":"Triggered when a translation schema is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.multilingual.translation.v1.schema","serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.multilingual.translation.v1.schema_updated","sourceRepo":"git@github.com:wix-private/linguist.git"}],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_UPDATE_ORGANIZATION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Translation Schema Write","scopeId":"SCOPE.DC-MULTILINGUAL.WRITE_TRANSLATION_SCHEMA"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.UpdateSchemaRequest","responseMessage":"wix.multilingual.translation.schema.v1.UpdateSchemaResponse"},"legacyExamples":[{"name":"UpdateSchema","serviceName":"TranslationSchema","type":"METHOD","content":{"title":"Update Schema","request":"curl -X PATCH \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"schema\": {\n \"displayName\": \"A New Display Name\",\n \"revision\": 1,\n },\n }'","response":"{\n \"schema\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"display_name\": \"A new Display Name\",\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product's Image\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n },\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git","contentLink":{"displayName":"Update Schema","slugifiedName":"update-schema"},"permissionScopes":[{"name":"Wix Multilingual - Translation Schema Write","scopeId":"SCOPE.DC-MULTILINGUAL.WRITE_TRANSLATION_SCHEMA"}],"isAdminMethod":true},{"summary":"Query Schemas","description":"Retrieves a list of schemas, given the provided paging, filtering, and sorting. Up to 100 schemas can be returned per request.\n\n> **Note:**\n>\n> This method can retrieve all schemas with a `GLOBAL` scope and schemas with a `SITE` scope for the site the API request is authorized to access.\n\nThe default `sort` is `id` in `ASC`.\n\nFor a detailed list of supported operations, see [Translation Schema: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/sort-and-filter).\nTo learn how to query translation schemas, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).","operationId":"wix.multilingual.translation.schema.v1.TranslationSchema.QuerySchemas","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.QuerySchemasResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/translation-schema","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/translation-schema","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QuerySchemasRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_READ_ORGANIZATION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Translation Schema Read","scopeId":"SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_SCHEMA"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.QuerySchemasRequest","responseMessage":"wix.multilingual.translation.schema.v1.QuerySchemasResponse"},"legacyExamples":[{"name":"QuerySchemas","serviceName":"TranslationSchema","type":"METHOD","content":{"title":"Query Schema","request":"curl -X POST \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"key.appId: \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\"\n },\n }\n }'","response":"{\n \"schema\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product's Image\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n },\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git"},"httpMethod":"post","path":"/v1/schemas/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_READ_ORGANIZATION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Translation Schema Read","scopeId":"SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_SCHEMA"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.QuerySchemasRequest","responseMessage":"wix.multilingual.translation.schema.v1.QuerySchemasResponse"},"legacyExamples":[{"name":"QuerySchemas","serviceName":"TranslationSchema","type":"METHOD","content":{"title":"Query Schema","request":"curl -X POST \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"key.appId: \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\"\n },\n }\n }'","response":"{\n \"schema\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product's Image\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n },\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git","contentLink":{"displayName":"Query Schemas","slugifiedName":"query-schemas"},"permissionScopes":[{"name":"Wix Multilingual - Translation Schema Read","scopeId":"SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_SCHEMA"}],"isAdminMethod":true},{"summary":"List Site Schemas","description":"Retrieves a list of all translation schemas associated with a site, regardless of which app created them.","operationId":"wix.multilingual.translation.schema.v1.TranslationSchema.ListSiteSchemas","parameters":[{"name":"paging","in":"query","description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","required":false,"schema":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"appId","in":"query","description":"ID of app that created the schema.","required":false,"schema":{"description":"ID of app that created the schema.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"entityType","in":"query","description":"A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.","required":false,"schema":{"description":"A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.","minLength":1,"maxLength":80,"title":"entityType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"scope","in":"query","description":"Scope of the translation schema.\nSupported values:\n+ `GLOBAL`: A global schema for all sites.\n+ `SITE`: A custom schema for a specific site.","required":false,"schema":{"description":"Scope of the translation schema.\nSupported values:\n+ `GLOBAL`: A global schema for all sites.\n+ `SITE`: A custom schema for a specific site.","title":"scope","type":"string","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.SchemaScope","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.ListSiteSchemasResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/translation-schema","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/translation-schema","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Write Translation Content","scopeId":"SCOPE.DC-MULTILINGUAL.WRITE_TRANSLATION_CONTENT"},{"name":"Wix Multilingual - Translation Content + Published Content Read","scopeId":"SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.ListSiteSchemasRequest","responseMessage":"wix.multilingual.translation.schema.v1.ListSiteSchemasResponse"},"legacyExamples":[{"name":"ListSiteSchemas","serviceName":"TranslationSchema","type":"METHOD","content":{"title":"List Site Schemas","description":"List all schemas installed on a site, including both `SITE` and `GLOBAL` scopes.","request":"curl -X GET \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/site' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\","response":"{\n \"schemas\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product's Image\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n },\n }\n },\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"My-Pet-Collection\",\n \"scope\": \"SITE\"\n },\n \"fields\": {\n \"petMame\": {\n \"id\": \"petMame\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Pet Name\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"petType\": {\n \"id\": \"description\",\n \"type\": \"LONG_TEXT\",\n \"displayName\": \"Pet Type (cat, dog, etc)\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"medicalState\": {\n \"id\": \"medicalState\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"The pet's medical state\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n },\n }\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git"},"httpMethod":"get","path":"/v1/schemas/site","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_MULTILINGUAL.SCHEMA_READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Wix Multilingual - Write Translation Content","scopeId":"SCOPE.DC-MULTILINGUAL.WRITE_TRANSLATION_CONTENT"},{"name":"Wix Multilingual - Translation Content + Published Content Read","scopeId":"SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT"}],"protoArtifactId":"com.wixpress.multilingual:translation-schema","serviceArtifactId":"com.wixpress.multilingual.translation-schema","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.multilingual.translation.schema.v1.ListSiteSchemasRequest","responseMessage":"wix.multilingual.translation.schema.v1.ListSiteSchemasResponse"},"legacyExamples":[{"name":"ListSiteSchemas","serviceName":"TranslationSchema","type":"METHOD","content":{"title":"List Site Schemas","description":"List all schemas installed on a site, including both `SITE` and `GLOBAL` scopes.","request":"curl -X GET \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/site' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\","response":"{\n \"schemas\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"Product\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"title\": {\n \"id\": \"title\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"description\": {\n \"id\": \"description\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"Description\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"image()\": {\n \"id\": \"image()\",\n \"type\": \"IMAGE\",\n \"displayName\": \"Product's Image\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n },\n }\n },\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"My-Pet-Collection\",\n \"scope\": \"SITE\"\n },\n \"fields\": {\n \"petMame\": {\n \"id\": \"petMame\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Pet Name\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"petType\": {\n \"id\": \"description\",\n \"type\": \"LONG_TEXT\",\n \"displayName\": \"Pet Type (cat, dog, etc)\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"medicalState\": {\n \"id\": \"medicalState\",\n \"type\": \"RICH_CONTENT\",\n \"displayName\": \"The pet's medical state\",\n \"minLength\": null,\n \"maxLength\": null,\n \"hidden\": false,\n \"displayOnly\": false\n },\n }\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/linguist.git","contentLink":{"displayName":"List Site Schemas","slugifiedName":"list-site-schemas"},"permissionScopes":[{"name":"Wix Multilingual - Translation Content + Published Content Read","scopeId":"SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT"},{"name":"Wix Multilingual - Write Translation Content","scopeId":"SCOPE.DC-MULTILINGUAL.WRITE_TRANSLATION_CONTENT"}],"isAdminMethod":true}],"webhooks":[{"summary":"Schema Created","title":"Schema Created","description":"Triggered when a translation schema is created.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.multilingual.translation.v1.schema","serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.multilingual.translation.v1.schema_created","legacyExamples":[{"name":"SchemaCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"52269077-05f2-4b59-ba4f-36ef8c4c1e11\",\n \"entityFqdn\": \"wix.multilingual.translation.v1.schema\",\n \"slug\": \"created\",\n \"entityId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"createdEvent\": {\n \"entityAsJson\": \"{\\\"schema\\\":{\\\"id\\\":\\\"8046df3c-7575-4098-a5ab-c91ad8f33c47\\\",\\\"revision\\\":1,\\\"createdDate\\\":\\\"2019-10-30T17:22:10.299Z\\\",\\\"updatedDate\\\":\\\"2019-10-30T17:22:10.299Z\\\",\\\"key\\\": {\\\"app_id\\\": \\\"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\\\", \\\"entity_type\\\": \\\"Product\\\", \\\"scope\\\": \\\"GLOBAL\\\"}, \\\"fields\\\": {\\\"title\\\": {\\\"id\\\": \\\"title\\\", \\\"type\\\": \\\"SHORT_TEXT\\\", \\\"display_name\\\": \\\"Title\\\", \\\"min_length\\\": 1, \\\"max_length\\\": 54, \\\"hidden\\\": false, \\\"display_only\\\": false}, \\\"entity.description\\\": {\\\"id\\\": \\\"description\\\", \\\"type\\\": \\\"RICH_CONTENT\\\", \\\"display_name\\\": \\\"Description\\\", \\\"min_length\\\": 1, \\\"max_length\\\": 256, \\\"hidden\\\": false, \\\"display_only\\\": false}, \\\"image()\\\": {\\\"id\\\": \\\"image()\\\", \\\"type\\\": \\\"IMAGE\\\", \\\"display_name\\\": \\\"Product's Image\\\", \\\"min_length\\\": null, \\\"max_length\\\": null, \\\"hidden\\\": false, \\\"display_only\\\": false}},\\\"preview_fields\\\": {\\\"title_field_id\\\": \\\"title\\\"}, \\\"hidden\\\": \\\"false\\\", \\\"display_name\\\": \\\"My Product\\\", \\\"parent_id\\\": \\\"1601ff9c-0b14-449b-93a5-4d000a5456fa\\\"}}\"\n },\n \"eventTime\": \"2020-10-18T13:40:58.304800Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/linguist.git","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema","contentLink":{"displayName":"Schema Created","slugifiedName":"schema-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Schema Updated","title":"Schema Updated","description":"Triggered when a translation schema is updated.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.multilingual.translation.v1.schema","serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.multilingual.translation.v1.schema_updated","legacyExamples":[{"name":"SchemaUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"52269077-05f2-4b59-ba4f-36ef8c4c1e11\",\n \"entityFqdn\": \"wix.multilingual.translation.v1.schema\",\n \"slug\": \"updated\",\n \"entityId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"updatedEvent\": {\n \"currentEntityAsJson\": \"{\\\"schema\\\":{\\\"id\\\":\\\"8046df3c-7575-4098-a5ab-c91ad8f33c47\\\",\\\"revision\\\":1,\\\"createdDate\\\":\\\"2019-10-30T17:22:10.299Z\\\",\\\"updatedDate\\\":\\\"2019-10-30T17:22:10.299Z\\\",\\\"key\\\": {\\\"app_id\\\": \\\"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\\\", \\\"entity_type\\\": \\\"Product\\\", \\\"scope\\\": \\\"GLOBAL\\\"}, \\\"fields\\\": {\\\"title\\\": {\\\"id\\\": \\\"title\\\", \\\"type\\\": \\\"SHORT_TEXT\\\", \\\"display_name\\\": \\\"Title\\\", \\\"min_length\\\": 1, \\\"max_length\\\": 54, \\\"hidden\\\": false, \\\"display_only\\\": false}, \\\"entity.description\\\": {\\\"id\\\": \\\"description\\\", \\\"type\\\": \\\"RICH_CONTENT\\\", \\\"display_name\\\": \\\"Description\\\", \\\"min_length\\\": 1, \\\"max_length\\\": 256, \\\"hidden\\\": false, \\\"display_only\\\": false}, \\\"image()\\\": {\\\"id\\\": \\\"image()\\\", \\\"type\\\": \\\"IMAGE\\\", \\\"display_name\\\": \\\"Product's Image\\\", \\\"min_length\\\": null, \\\"max_length\\\": null, \\\"hidden\\\": false, \\\"display_only\\\": false}},\\\"preview_fields\\\": {\\\"title_field_id\\\": \\\"title\\\"}, \\\"hidden\\\": \\\"false\\\", \\\"display_name\\\": \\\"My Product\\\", \\\"parent_id\\\": \\\"1601ff9c-0b14-449b-93a5-4d000a5456fa\\\"}}\"\n },\n \"eventTime\": \"2020-10-18T13:40:58.304800Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/linguist.git","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema","contentLink":{"displayName":"Schema Updated","slugifiedName":"schema-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Schema Deleted","title":"Schema Deleted","description":"Triggered when a translation schema is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.multilingual.translation.v1.schema","serviceName":"wix.multilingual.translation.schema.v1.TranslationSchema","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.multilingual.translation.v1.schema_deleted","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/linguist.git","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema","contentLink":{"displayName":"Schema Deleted","slugifiedName":"schema-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Translation Schema API\n\n

\n Developer Preview\n
\n APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.\n

\n\n \n\n\nThe Translation Schema API allows you to manage the schema for translating site content. Define the structure and fields of your app's translatable content to ensure consistency and accuracy across different locales. You only need to do this setup once per entity, providing a foundation for all future translations.\n\nYou can create schemas for each entity of your app. For example, if you are developing a food delivery app, you may want to create two schemas, one for a menu and another for orders.\n\nWith the Translation Schema API, your app can:\n\n+ Create, update, and delete a translation schema. \n+ Get an existing translation schema by ID or key. \n+ Query your app's schemas. \n+ List all schemas associated with a site.\n\n## Validations\n\nYou can also set validations for fields in the schema. For example, in the schema below, the title field has a `minLength` of 1, meaning the smallest valid text value for that field must be at least one character long. If validations are defined in the schema, the corresponding content is constrained to those validations. If you add invalid content you'll get a validation error. \n\n```json\n \"schema\": {\n \"key\": {\n \"entityType\": \"Menu\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"menu-title\": {\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Menu Title\",\n \"minLength\": 1,\n \"maxLength\": 54,\n \"hidden\": false,\n \"displayOnly\": false\n }\n }\n }\n```\n\n## Before you begin\n\nIt’s important to note the following points before starting to code:\n\n+ There are no private schemas. All of a site's schemas can be retrieved by calling [List Site Schemas](fallback::https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/list-site-schemas).\n+ You can only use this API on sites where the Wix user has installed the [Wix Multilingual app](fallback::https://www.wix.com/app-market/wix-multilingual?searchLocation=home).\n\n## Use cases\n\n+ [Update a global schema](fallback::https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/sample-flows#update-a-global-schema).\n+ [Create a site schema based on an existing global schema](fallback::https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/sample-flows#create-a-site-schema-based-on-an-existing-global-schema).\n\n\n## Terminology\n\n+ **Scope:** A schema can have one of two scopes:\n + **Site:** A custom schema for a specific site. \n + **Global:** A global schema for all sites.\n

You can update both site and global schemas, as well as change a site schema to global or vice versa. However, if you need to create a site-specific schema based on an existing global one, create a new schema with a site scope and manually copy the specifications from the existing global one.

\n\n+ **SchemaField:** This defines the structure and validation rules for a field within a translation schema. It specifies the type of data (such as text or image) and constraints (such as minimum or maximum length) for each field in the schema. The SchemaField ensures that any content added conforms to the defined format.\n\n+ **Fields:** A list of fields for the translation schema. This property uses a string to map to a `SchemaField` (`Map`). The string serves as a key, which you'll need to access each field in the schema and when adding translation content.\n"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Use Cases and Flows\n\nThis article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation.\n\n## Update a global schema \n\nSuppose you're developing an app that provides promotional campaigns for stores. Your app integrates with Wix Multilingual to allow Wix users to translate promotions for customers. You've already used the [Create Schema](fallback::https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/create-schema) method to create a `GLOBAL` schema for all sites. Your schema includes a `promotionDetails` field that allows stores to provide the fine details of the promotion to the customer. Initially, this field is limited to 256 characters. Due to a recent update in your app, this field now supports up to 1024 characters. You need to update your app's schema to reflect this change:\n\n1. Call [Update Schema](fallback::https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/update-schema) with the `promotionDetails` field, allowing up to 1024 characters.\n\n ```js\n curl -X PATCH \\\n 'https://www.wixapis.com/translation-schema/v1/schemas/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"schema\": {\n \"revision\": 3,\n \"fields\": {\n \"promotionDetails\": {\n \"maxLength\": 1024,\n }\n }\n },\n }'\n ```\n2. Site owners can now provide content for the `promotionDetails` field with up to 1024 characters in length.\n\n

\n Important:\n \nWhen updating a schema with a `GLOBAL` scope, be aware that this change will apply to all sites using this schema. If you need to update a field for only one specific store, consider creating a schema with a `SITE` scope instead, as explained in the sample flow below.\n

\n\n\n## Create a site schema based on an existing global schema\n\nSuppose you're an app developer providing delivery services for restaurants. Your app integrates with Wix Multilingual to allow Wix users to translate delivery information. You've already used the [Create Schema](fallback::https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/create-schema) method to create a `GLOBAL` schema for all sites. \n\nHere's an example schema object: \n\n```json\n{\n \"schema\": {\n \"id\": \"12345678-90ab-cdef-1234-567890abcdef\",\n \"revision\": 2,\n \"createdDate\": \"2024-08-19T12:34:56.789Z\",\n \"updatedDate\": \"2024-08-19T12:34:56.789Z\",\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"restaurant-delivery-service\",\n \"scope\": \"GLOBAL\"\n },\n \"fields\": {\n \"delivery_instructions\": {\n \"id\": \"delivery_instructions\",\n \"type\": \"LONG_TEXT\",\n \"displayName\": \"Delivery Instructions\",\n \"minLength\": 0,\n \"maxLength\": 512,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"courier_tip\": {\n \"id\": \"courier_tip_currency\",\n \"type\": \"SHORT_TEXT\",\n \"displayName\": \"Tip for Courier\",\n \"minLength\": null,\n \"maxLength\": 3,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"instructions_to_courier\": {\n \"id\": \"instructions_to_courier\",\n \"type\": \"LONG_TEXT\",\n \"displayName\": \"Instructions to Courier\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n }\n }\n }\n}\n```\n\nNow let's say the restaurant owner wants to disable the option for customers to tip couriers, and requests that you remove the `courier_tip` field from the schema. Since the schema has a `GLOBAL` scope, updating it would affect all sites using it. To avoid this, you'll create a site-specific schema based on the existing global one as follows:\n\n1. Call the Create Schema method with a `SITE` scope to create a custom schema for the restaurant's site. Copy all the fields from the existing schema except for the `courier_tip` field. \n\n ```js\n curl -X POST \\\n 'https://www.wixapis.com/translation-schema/v1/schemas' \\\n -H 'Authorization: ' \\\n -H 'wix-site-id: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"schema\": {\n \"key\": {\n \"appId\": \"4ad2dfe1-a943-45a8-94ac-f1dd8b78821b\",\n \"entityType\": \"restaurant-delivery-service\",\n \"scope\": \"SITE\"\n },\n \"fields\": {\n \"delivery_instructions\": {\n \"id\": \"delivery_instructions\",\n \"type\": \"LONG_TEXT\",\n \"displayName\": \"Delivery Instructions\",\n \"minLength\": 0,\n \"maxLength\": 512,\n \"hidden\": false,\n \"displayOnly\": false\n },\n \"instructions_to_courier\": {\n \"id\": \"instructions_to_courier\",\n \"type\": \"LONG_TEXT\",\n \"displayName\": \"Instructions to Courier\",\n \"minLength\": 1,\n \"maxLength\": 256,\n \"hidden\": false,\n \"displayOnly\": false\n }\n }\n }\n }'\n ```\n\n2. After creating the site-specific schema, use the [Translation Content API](fallback::https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-content/introduction) to add your app's default content to the newly created schema. Then, ask the restaurant owner to add their translated content to ensure that the new delivery instructions are available in all supported locales.\n\nTo summarize, updating the schema for a specific site removes the `courier_tip` field only for that site. Other sites using the global schema will still have the option to include tips. This prevents unintended changes for all app users.\n\n\n\n\n"},{"displayName":"Sort and Filter","slugifyName":"sort-and-filter","content":"# Translation Schema: Supported Filters and Sorting\n\nThis article covers field support for filtering and sorting in the Translation Schema API.\n\n\nThe following table shows field support for filters and sorting for the translation schema object when using [Query Schemas](fallback::https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/query-schemas):\n\n\n| Field | Supported Filters | Sortable |\n| ---------------------| ------------------------------------------------------------------------------ | ---------- |\n| `id` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `key.appId` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `key.entityType` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `key.scope` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `hidden` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n| `parentId` | `eq`, `ne`, `exists`, `in`, `hasSome`, `startsWith`, `ascending`, `descending` | Sortable |\n"}],"components":{"schemas":{"wix.multilingual.translation.schema.v1.Schema":{"type":"object","properties":{"id":{"description":"Translation schema ID.","readOnly":true,"format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"key":{"description":"Translation schema unique key identifier.","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.SchemaKey","summary":"key","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"List of fields for the translation schema. This property uses a string to map to a `SchemaField` (`Map`). The string serves as a key, which you'll need to access each field in the schema and when adding translation content.","minItems":1,"maxItems":1000,"title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.SchemaField"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previewFields":{"description":"Fields displayed in content previews. For example, a product name for a product translation schema.","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.PreviewFields","summary":"previewFields","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hidden":{"description":"Whether the translation schema is hidden from the site.\n\nDefault: `false`","title":"hidden","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayName":{"description":"Translation schema name displayed in the https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager.","maxLength":100,"title":"displayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"parentId":{"description":"A reference to the parent schema. For example, if the schema is for a menu item, this property would contain the schema ID of the menu it belongs to.","format":"GUID","title":"parentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the schema is updated. To prevent conflicting changes, the existing `revision` must be used when updating a schema.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the translation schema was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the translation schema was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"duplicateContent":{"description":"Whether to duplicate the translated content when a site containing the translation schema and content is duplicated.\n\nDefault: `false`","title":"duplicateContent","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Schema","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"wix.multilingual.translation.schema.v1.SchemaKey":{"type":"object","properties":{"appId":{"description":"ID of the app that created the schema.","format":"GUID","readOnly":true,"title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityType":{"description":"A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.","minLength":1,"maxLength":80,"immutable":true,"title":"entityType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scope":{"description":"Scope of the translation schema.\nSupported values:\n+ `GLOBAL`: A global schema for all sites.\n+ `SITE`: A custom schema for a specific site.","immutable":true,"title":"scope","type":"string","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.SchemaScope","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SchemaKey","description":""},"wix.multilingual.translation.schema.v1.SchemaScope":{"type":"string","description":"","title":"SchemaScope","enum":[{"order":0,"value":"UNKNOWN_SCOPE","description":"","maturity":"NOT_IMPLEMENTED","exposure":"PUBLIC"},{"order":1,"value":"GLOBAL","description":"Global schema, relevant to all sites","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"SITE","description":"Site schema, relevant to specific site only","maturity":"GA","exposure":"PUBLIC"}]},"wix.multilingual.translation.schema.v1.SchemaField":{"type":"object","properties":{"id":{"description":"Field ID. Validated according to Regex `^[A-Za-z0-9-_)(]+$`. Field IDs may contain parentheses to reference repeated items, such as images. These parentheses can't be nested and each opening parenthesis must be followed by a closing one. For example, `title()()` is valid, while `title)(` and `title(())` aren't valid. The value inside the parenthesis is validated according to Regex `^[^)(\\\\]\\\\[\\\\.]+$`.","minLength":1,"maxLength":100,"readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"**Required.** Field type.\nSupported values:\n+ `SHORT_TEXT`: Short plain text displayed as a single line in the UI.\n+ `LONG_TEXT`: Long plain text displayed as multiple lines in the UI.\n+ `HTML`: Long text including styles, images, and links.\n+ `RICH_CONTENT`: Rich-Content using the [Wix Ricos](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content) format.\n+ `IMAGE`: Wix Media Manager image.\n+ `IMAGE_LINK`: Image URL without metadata.\n+ `VIDEO`: Wix Media Manager video.\n+ `DOCUMENT`: Wix Media Manager document.","title":"type","type":"string","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.SchemaField.FieldType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayName":{"description":"Field name displayed in the https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager.","maxLength":100,"title":"displayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupName":{"description":"Field group name.","maxLength":100,"title":"groupName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"minLength":{"description":"Field minimum text length.","minimum":1,"title":"minLength","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxLength":{"description":"Field maximum text length.","minimum":1,"title":"maxLength","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"format":{"description":"Field format. Content is validated based on the format set here in the field schema. For example, if the format is `EMAIL`, then the content for this field must be a valid email address.","minLength":2,"maxLength":20,"title":"format","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hidden":{"description":"Whether the field is hidden from the site. Hidden fields are still validated.","title":"hidden","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayOnly":{"description":"Whether the field is read-only, and not intended to be translated. For example, an image. Use this field when you want an image to remain in the [Translation Manager](https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager) for context, but without being translated.","title":"displayOnly","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"index":{"description":"Field index. Use for cases where the order of the fields are relevant.","minimum":0,"title":"index","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SchemaField","description":""},"wix.multilingual.translation.schema.v1.SchemaField.FieldType":{"type":"string","description":"","title":"FieldType","enum":[{"order":0,"value":"UNDEFINED_TYPE","description":"Undefined field type","maturity":"NOT_IMPLEMENTED","exposure":"PUBLIC"},{"order":1,"value":"SHORT_TEXT","description":"Short text TEXT","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"LONG_TEXT","description":"Long Plain Text TEXT","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"HTML","description":"Long text including styles, images, links and more... HTML","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"RICH_CONTENT","description":"Wix Rich-Content format RICO","maturity":"GA","exposure":"PUBLIC"},{"order":5,"value":"IMAGE","description":"Wix Image media item","maturity":"GA","exposure":"PUBLIC"},{"order":6,"value":"IMAGE_LINK","description":"Image URL without metadata","maturity":"GA","exposure":"PUBLIC"},{"order":8,"value":"VIDEO","description":"Wix Video media item","maturity":"GA","exposure":"PUBLIC"},{"order":9,"value":"DOCUMENT","description":"Wix Document media item","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoubleValue","description":""},"wix.multilingual.translation.schema.v1.PreviewFields":{"type":"object","properties":{"titleFieldId":{"description":"ID of the field representing the schema's title.","maxLength":100,"title":"titleFieldId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"imageFieldId":{"description":"ID of the field representing the schema's image.","maxLength":100,"title":"imageFieldId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PreviewFields","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"wix.multilingual.translation.schema.v1.CreateSchemaRequest":{"type":"object","properties":{"schema":{"description":"Translation schema to create.","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema","summary":"schema","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateSchemaRequest","description":""},"wix.multilingual.translation.schema.v1.CreateSchemaResponse":{"type":"object","properties":{"schema":{"description":"Newly created translation schema.","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema","summary":"schema","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateSchemaResponse","description":""},"wix.multilingual.translation.schema.v1.GetSchemaRequest":{"type":"object","properties":{"schemaId":{"description":"ID of the translation schema to retrieve.","format":"GUID","title":"schemaId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetSchemaRequest","description":""},"wix.multilingual.translation.schema.v1.GetSchemaResponse":{"type":"object","properties":{"schema":{"description":"The requested translation schema.","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema","summary":"schema","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetSchemaResponse","description":""},"wix.multilingual.translation.schema.v1.GetSchemaByKeyRequest":{"type":"object","properties":{"key":{"description":"ID of the translation schema to retrieve.","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.SchemaKey","summary":"key","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetSchemaByKeyRequest","description":""},"wix.multilingual.translation.schema.v1.GetSchemaByKeyResponse":{"type":"object","properties":{"schema":{"description":"The requested translation schema.","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema","summary":"schema","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetSchemaByKeyResponse","description":""},"wix.multilingual.translation.schema.v1.UpdateSchemaRequest":{"type":"object","properties":{"schema":{"description":"Translation schema to update.","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema","summary":"schema","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateSchemaRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"wix.multilingual.translation.schema.v1.UpdateSchemaResponse":{"type":"object","properties":{"schema":{"description":"Updated Schema.","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema","summary":"schema","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateSchemaResponse","description":""},"wix.multilingual.translation.schema.v1.DeleteSchemaRequest":{"type":"object","properties":{"schemaId":{"description":"ID of the translation schema to delete.","format":"GUID","title":"schemaId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteSchemaRequest","description":""},"wix.multilingual.translation.schema.v1.DeleteSchemaResponse":{"type":"object","properties":{},"title":"DeleteSchemaResponse","description":""},"wix.multilingual.translation.schema.v1.QuerySchemasRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QuerySchemasRequest","description":""},"wix.common.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object.\n\nLearn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object.\n\nLearn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).","maxItems":5,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.common.CursorQuery.pagingMethod"}]},"wix.common.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor paging options.\n\nLearn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":[{"order":0,"value":"NULL_VALUE","description":"","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":[{"order":0,"value":"ASC","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"DESC","description":"","maturity":"GA","exposure":"PUBLIC"}]},"wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"wix.multilingual.translation.schema.v1.QuerySchemasResponse":{"type":"object","properties":{"schemas":{"description":"List of translation schemas.","title":"schemas","type":"array","items":{"$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata for the next page of results.","$ref":"#/components/schemas/wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QuerySchemasResponse","description":""},"wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in current page.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursor strings that point to the next page, previous page, or both.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"wix.multilingual.translation.schema.v1.ListSiteSchemasRequest":{"type":"object","properties":{"paging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of app that created the schema.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityType":{"description":"A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.","minLength":1,"maxLength":80,"title":"entityType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scope":{"description":"Scope of the translation schema.\nSupported values:\n+ `GLOBAL`: A global schema for all sites.\n+ `SITE`: A custom schema for a specific site.","title":"scope","type":"string","$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.SchemaScope","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListSiteSchemasRequest","description":""},"wix.multilingual.translation.schema.v1.ListSiteSchemasResponse":{"type":"object","properties":{"schemas":{"description":"List of translation schemas.","title":"schemas","type":"array","items":{"$ref":"#/components/schemas/wix.multilingual.translation.schema.v1.Schema"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata for the next page of results.","$ref":"#/components/schemas/wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListSiteSchemasResponse","description":""},"com.wixpress.metasite.event.api.MetaSiteSpecialEvent":{"type":"object","properties":{"metaSiteId":{"description":"A meta site id.","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A meta site version. Monotonically increasing.","title":"version","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timestamp":{"description":"A timestamp of the event.","title":"timestamp","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"assets":{"description":"A list of \"assets\" (applications). The same as MetaSiteContext.","maxItems":400,"title":"assets","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.metasite.event.api.Asset"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MetaSiteSpecialEvent","description":"","oneOf":[{"description":"","summary":"payload","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSiteSpecialEvent.payload"}]},"com.wixpress.metasite.event.api.MetaSiteSpecialEvent.payload":{"type":"object","title":"payload","properties":{"siteCreated":{"description":"Emitted on a meta site creation.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteCreated","summary":"siteCreated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteTransferred":{"description":"Emitted on a meta site transfer completion.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteTransferred","summary":"siteTransferred","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteDeleted":{"description":"Emitted on a meta site deletion.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteDeleted","summary":"siteDeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteUndeleted":{"description":"Emitted on a meta site restoration.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteUndeleted","summary":"siteUndeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sitePublished":{"description":"Emitted on the first* publish of the meta site (* switching from unpublished to published state).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SitePublished","summary":"sitePublished","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteUnpublished":{"description":"Emitted on a meta site unpublish.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteUnpublished","summary":"siteUnpublished","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMarkedAsTemplate":{"description":"Emitted when meta site is marked as template.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteMarkedAsTemplate","summary":"siteMarkedAsTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMarkedAsWixSite":{"description":"Emitted when meta site is marked as a WixSite.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteMarkedAsWixSite","summary":"siteMarkedAsWixSite","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceProvisioned":{"description":"Emitted when an application is provisioned (installed).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.ServiceProvisioned","summary":"serviceProvisioned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceRemoved":{"description":"Emitted when an application is removed (uninstalled).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.ServiceRemoved","summary":"serviceRemoved","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteRenamedPayload":{"description":"Emitted when meta site name (URL slug) is changed.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteRenamed","summary":"siteRenamedPayload","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hardDeleted":{"description":"Emitted when meta site was permanently deleted.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteHardDeleted","summary":"hardDeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespaceChanged":{"description":"Emitted on a namespace change.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.NamespaceChanged","summary":"namespaceChanged","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"studioAssigned":{"description":"Emitted when Studio is attached.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.StudioAssigned","summary":"studioAssigned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"studioUnassigned":{"description":"Emitted when Studio is detached.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.StudioUnassigned","summary":"studioUnassigned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.metasite.event.api.Asset":{"type":"object","properties":{"appDefId":{"description":"An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"An instance id. For legacy reasons may be UUID or a string.","maxLength":200,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"state":{"description":"An application state.","title":"state","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.Asset.State","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Asset","description":""},"com.wixpress.metasite.event.api.Asset.State":{"type":"string","description":"","title":"State","enum":[{"order":0,"value":"UNKNOWN","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ENABLED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"DISABLED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"PENDING","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"DEMO","description":"","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.metasite.event.api.SiteCreated":{"type":"object","properties":{"originTemplateId":{"description":"A template identifier (empty if not created from a template).","maxLength":36,"title":"originTemplateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ownerId":{"description":"An account id of the owner.","format":"GUID","title":"ownerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"context":{"description":"A context in which meta site was created.","title":"context","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteCreatedContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originMetaSiteId":{"description":"A meta site id from which this site was created.\n\nIn case of a creation from a template it's a template id.\nIn case of a site duplication (\"Save As\" in dashboard or duplicate in UM) it's an id of a source site.","format":"GUID","title":"originMetaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteName":{"description":"A meta site name (URL slug).","maxLength":20,"title":"siteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespace":{"description":"A namespace.","title":"namespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteCreated","description":""},"com.wixpress.metasite.event.api.SiteCreatedContext":{"type":"string","description":"","title":"SiteCreatedContext","enum":[{"order":0,"value":"OTHER","description":"A valid option, we don't expose all reasons why site might be created.","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"FROM_TEMPLATE","description":"A meta site was created from template.","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"DUPLICATE_BY_SITE_TRANSFER","description":"A meta site was created by copying of the transfferred meta site.","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"DUPLICATE","description":"A copy of existing meta site.","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"OLD_SITE_TRANSFER","description":"A meta site was created as a transfferred site (copy of the original), old flow, should die soon.","maturity":"GA","exposure":"PUBLIC"},{"order":5,"value":"FLASH","description":"deprecated A meta site was created for Flash editor.","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.metasite.event.api.MetaSite.Namespace":{"type":"string","description":"","title":"Namespace","enum":[{"order":0,"value":"UNKNOWN_NAMESPACE","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"WIX","description":"Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"SHOUT_OUT","description":"ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"ALBUMS","description":"MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"WIX_STORES_TEST_DRIVE","description":"Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":5,"value":"HOTELS","description":"Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":6,"value":"CLUBS","description":"Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":7,"value":"ONBOARDING_DRAFT","description":"A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":8,"value":"DEV_SITE","description":"AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":9,"value":"LOGOS","description":"LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":10,"value":"VIDEO_MAKER","description":"VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":11,"value":"PARTNER_DASHBOARD","description":"MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":12,"value":"DEV_CENTER_COMPANY","description":"MetaSites with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":13,"value":"HTML_DRAFT","description":"A draft created by HTML editor on open. Upon \"first save\" it will be moved to be of WIX domain.\n\nMeta site with this namespace will *not* be shown in a user's site list by default.","maturity":"GA","exposure":"PUBLIC"},{"order":14,"value":"SITELESS_BUSINESS","description":"the user-journey for Fitness users who want to start from managing their business instead of designing their website.\nWill be accessible from Site List and will not have a website app.\nOnce the user attaches a site, the site will become a regular wixsite.","maturity":"GA","exposure":"PUBLIC"},{"order":15,"value":"CREATOR_ECONOMY","description":"Belongs to \"strategic products\" company. Supports new product in the creator's economy space.","maturity":"GA","exposure":"PUBLIC"},{"order":16,"value":"DASHBOARD_FIRST","description":"It is to be used in the Business First efforts.","maturity":"GA","exposure":"PUBLIC"},{"order":17,"value":"ANYWHERE","description":"Bookings business flow with no site.","maturity":"GA","exposure":"PUBLIC"},{"order":18,"value":"HEADLESS","description":"Namespace for Headless Backoffice with no editor","maturity":"GA","exposure":"PUBLIC"},{"order":19,"value":"ACCOUNT_MASTER_CMS","description":"Namespace for master site that will exist in parent account that will be referenced by subaccounts\nThe site will be used for account level CSM feature for enterprise","maturity":"GA","exposure":"PUBLIC"},{"order":20,"value":"RISE","description":"Rise.ai Siteless account management for Gift Cards and Store Credit.","maturity":"GA","exposure":"PUBLIC"},{"order":21,"value":"BRANDED_FIRST","description":"As part of the branded app new funnel, users now can create a meta site that will be branded app first.\nThere's a blank site behind the scene but it's blank).\nThe Mobile company will be the owner of this namespace.","maturity":"GA","exposure":"PUBLIC"},{"order":22,"value":"NOWNIA","description":"Nownia.com Siteless account management for Ai Scheduling Assistant.","maturity":"GA","exposure":"PUBLIC"},{"order":23,"value":"UGC_TEMPLATE","description":"UGC Templates are templates that are created by users for personal use and to sale to other users.\nThe Partners company owns this namespace.","maturity":"GA","exposure":"PUBLIC"},{"order":24,"value":"CODUX","description":"Codux Headless Sites","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.metasite.event.api.SiteTransferred":{"type":"object","properties":{"oldOwnerId":{"description":"A previous owner id (user that transfers meta site).","format":"GUID","title":"oldOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newOwnerId":{"description":"A new owner id (user that accepts meta site).","format":"GUID","title":"newOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteTransferred","description":"Site transferred to another user."},"com.wixpress.metasite.event.api.SiteDeleted":{"type":"object","properties":{"deleteContext":{"description":"A deletion context.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext","summary":"deleteContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteDeleted","description":"Soft deletion of the meta site. Could be restored."},"com.wixpress.metasite.event.api.DeleteContext":{"type":"object","properties":{"dateDeleted":{"description":"When the meta site was deleted.","title":"dateDeleted","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteStatus":{"description":"A status.","title":"deleteStatus","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext.DeleteStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteOrigin":{"description":"A reason (flow).","maxLength":255,"title":"deleteOrigin","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initiatorId":{"description":"A service that deleted it.","maxLength":255,"title":"initiatorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteContext","description":""},"com.wixpress.metasite.event.api.DeleteContext.DeleteStatus":{"type":"string","description":"","title":"DeleteStatus","enum":[{"order":0,"value":"UNKNOWN","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"TRASH","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"DELETED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"PENDING_PURGE","description":"","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.metasite.event.api.SiteUndeleted":{"type":"object","properties":{},"title":"SiteUndeleted","description":"Restoration of the meta site."},"com.wixpress.metasite.event.api.SitePublished":{"type":"object","properties":{},"title":"SitePublished","description":"First publish of a meta site. Or subsequent publish after unpublish."},"com.wixpress.metasite.event.api.SiteUnpublished":{"type":"object","properties":{"urls":{"description":"A list of URLs previously associated with the meta site.","maxLength":4000,"maxItems":10000,"title":"urls","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteUnpublished","description":""},"com.wixpress.metasite.event.api.SiteMarkedAsTemplate":{"type":"object","properties":{},"title":"SiteMarkedAsTemplate","description":""},"com.wixpress.metasite.event.api.SiteMarkedAsWixSite":{"type":"object","properties":{},"title":"SiteMarkedAsWixSite","description":""},"com.wixpress.metasite.event.api.ServiceProvisioned":{"type":"object","properties":{"appDefId":{"description":"Either UUID or EmbeddedServiceType.","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"Not only UUID. Something here could be something weird.","maxLength":36,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originInstanceId":{"description":"An instance id from which this instance is originated.","maxLength":36,"title":"originInstanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A version.","maxLength":50,"title":"version","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originMetaSiteId":{"description":"The origin meta site id","format":"GUID","title":"originMetaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceProvisioned","description":""},"com.wixpress.metasite.event.api.ServiceRemoved":{"type":"object","properties":{"appDefId":{"description":"Either UUID or EmbeddedServiceType.","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"Not only UUID. Something here could be something weird.","maxLength":36,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A version.","maxLength":50,"title":"version","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceRemoved","description":""},"com.wixpress.metasite.event.api.SiteRenamed":{"type":"object","properties":{"newSiteName":{"description":"A new meta site name (URL slug).","maxLength":20,"title":"newSiteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oldSiteName":{"description":"A previous meta site name (URL slug).","maxLength":255,"title":"oldSiteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteRenamed","description":"Rename of the site. Meaning, free public url has been changed as well."},"com.wixpress.metasite.event.api.SiteHardDeleted":{"type":"object","properties":{"deleteContext":{"description":"A deletion context.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext","summary":"deleteContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteHardDeleted","description":"Hard deletion of the meta site.\n\nCould not be restored. Therefore it's desirable to cleanup data."},"com.wixpress.metasite.event.api.NamespaceChanged":{"type":"object","properties":{"oldNamespace":{"description":"A previous namespace.","title":"oldNamespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newNamespace":{"description":"A new namespace.","title":"newNamespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NamespaceChanged","description":""},"com.wixpress.metasite.event.api.StudioAssigned":{"type":"object","properties":{},"title":"StudioAssigned","description":"Assigned Studio editor"},"com.wixpress.metasite.event.api.StudioUnassigned":{"type":"object","properties":{},"title":"StudioUnassigned","description":"Unassigned Studio editor"},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":[{"order":0,"value":"UNKNOWN","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ANONYMOUS_VISITOR","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"MEMBER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"WIX_USER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"APP","description":"","maturity":"GA","exposure":"PUBLIC"}]}}},"title":"Schema","description":"","fqdn":"wix.multilingual.translation.v1.schema"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Translation Schema API\n\n

\n Important:\n \nWhen updating a schema with a `GLOBAL` scope, be aware that this change will apply to all sites using this schema. If you need to update a field for only one specific store, consider creating a schema with a `SITE` scope instead, as explained in the sample flow below.\n