inner content

{"id":"9201f0c2-1e52-42c0-9f3d-d397b957a64a","createdDate":"2024-09-02T13:08:02.990Z","updatedDate":"2024-09-02T13:08:02.990Z","resourceId":"4ec2f60d-5bbe-4350-9076-3bb3c01322a5","api":{"schema":{"object":{"displayName":"Category Object","description":"Blog Submodule Docs","slug":"category-object","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","legacyExamples":[{"title":"Category","content":"{\n \"category\": {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"postCount\": 1,\n \"url\": {\n \"base\": \"https://some-user.wixsite.com/my-site\",\n \"path\": \"/blog/categories/summer-slug\"\n },\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"coverMedia\": {\n \"displayed\": true\n },\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\"\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"methods":[{"summary":"List Categories","description":"Retrieves a list of up to 100 categories per request.\n\nList Categories runs with these defaults, which you can override:\n- `paging.limit` is `50`.\n- `paging.offset` is `0`.\n\nList Categories is sorted by `displayPosition` in descending order. This cannot be overridden.","operationId":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService.ListCategories","parameters":[{"name":"paging","in":"query","description":"Pagination options.","required":false,"schema":{"description":"Pagination options.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.BlogPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"fieldsets","in":"query","description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","required":false,"schema":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"language","in":"query","description":"Language filter.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nPass a language to only receive categories that are in that language.\nIf omitted, categories in all languages are returned.","required":false,"schema":{"description":"Language filter.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nPass a language to only receive categories that are in that language.\nIf omitted, categories in all languages are returned.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.ListCategoriesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ-CATEGORY"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.ListCategoriesRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.ListCategoriesResponse"},"legacyExamples":[{"name":"ListCategories","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/categories?fieldsets=URL' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"categories\": [\n {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"url\": {\n \"base\": \"https://some.wixsite.com/something-to-prod/blog\",\n \"path\": \"/blog/categories/summer\"\n },\n \"postCount\": 17,\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"displayPosition\": 1,\n \"slug\": \"summer-slug\",\n \"language\": \"en\",\n \"translationId\": \"111a58a2-dc75-422d-9ca6-00a489750dfd\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"hasNext\": false,\n \"offset\": 0,\n \"total\": 1\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"get","path":"/v3/categories","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ-CATEGORY"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.ListCategoriesRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.ListCategoriesResponse"},"legacyExamples":[{"name":"ListCategories","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/categories?fieldsets=URL' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"categories\": [\n {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"url\": {\n \"base\": \"https://some.wixsite.com/something-to-prod/blog\",\n \"path\": \"/blog/categories/summer\"\n },\n \"postCount\": 17,\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"displayPosition\": 1,\n \"slug\": \"summer-slug\",\n \"language\": \"en\",\n \"translationId\": \"111a58a2-dc75-422d-9ca6-00a489750dfd\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"hasNext\": false,\n \"offset\": 0,\n \"total\": 1\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"List Categories","slugifiedName":"list-categories"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"isAdminMethod":false},{"summary":"Create Category","description":"Creates a category.","operationId":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService.CreateCategory","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CreateCategoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateCategoryRequest","description":"","properties":{"category":{"description":"Category info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["category","category.label"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Category Created","description":"Triggered when a category is created.","permissions":["BLOG.READ-CATEGORY"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.blog.category","serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.blog.v3.category_created","sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"}],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.CREATE-CATEGORY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.CreateCategoryRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.CreateCategoryResponse"},"legacyExamples":[{"name":"CreateCategory","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl --location --request POST 'https://www.wixapis.com/blog/v3/categories' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-raw '{\n \"category\": {\n \"label\": \"Summer\",\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\"\n },\n \"fieldsets\": [\"URL\"]\n}'\n~~~","response":"~~~json\n{\n \"category\": {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"postCount\": 0,\n \"url\": {\n \"base\": \"https://some-user.wixsite.com/my-site\",\n \"path\": \"/blog/categories/summer-slug\"\n },\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"coverMedia\": {\n \"enabled\": true,\n \"displayed\": true,\n \"custom\": true\n },\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"post","path":"/v3/categories","rpcOnly":false,"triggeredEvents":[{"title":"Category Created","description":"Triggered when a category is created.","permissions":["BLOG.READ-CATEGORY"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.blog.category","serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.blog.v3.category_created","sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"}],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.CREATE-CATEGORY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.CreateCategoryRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.CreateCategoryResponse"},"legacyExamples":[{"name":"CreateCategory","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl --location --request POST 'https://www.wixapis.com/blog/v3/categories' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-raw '{\n \"category\": {\n \"label\": \"Summer\",\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\"\n },\n \"fieldsets\": [\"URL\"]\n}'\n~~~","response":"~~~json\n{\n \"category\": {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"postCount\": 0,\n \"url\": {\n \"base\": \"https://some-user.wixsite.com/my-site\",\n \"path\": \"/blog/categories/summer-slug\"\n },\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"coverMedia\": {\n \"enabled\": true,\n \"displayed\": true,\n \"custom\": true\n },\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Create Category","slugifiedName":"create-category"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"isAdminMethod":true},{"summary":"Update Category","description":"Updates a category.","operationId":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService.UpdateCategory","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"category.id","description":"Category ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.UpdateCategoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateCategoryRequest","description":"","properties":{"category":{"description":"Category info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["category","category.id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Category Updated","description":"Triggered when a category is updated.","permissions":["BLOG.READ-CATEGORY"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.blog.category","serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.blog.v3.category_updated","sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"}],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.EDIT-CATEGORY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.UpdateCategoryRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.UpdateCategoryResponse"},"legacyExamples":[{"name":"UpdateCategory","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl --location --request PATCH 'https://www.wixapis.com/blog/v3/categories/5f2bcaa0879ad500173577f3' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-raw '{\n \"category\": {\n \"description\": \"Posts about my summer and adventures\",\n },\n \"fieldMask\": \"category.description\"\n}'\n~~~","response":"~~~json\n{\n \"category\": {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"postCount\": 0,\n \"description\": \"Posts about my summer and adventures\",\n \"title\": \"Summer\",\n \"coverMedia\": {\n \"enabled\": true,\n \"displayed\": true,\n \"custom\": true\n },\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"patch","path":"/v3/categories/{category.id}","rpcOnly":false,"triggeredEvents":[{"title":"Category Updated","description":"Triggered when a category is updated.","permissions":["BLOG.READ-CATEGORY"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.blog.category","serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.blog.v3.category_updated","sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"}],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.EDIT-CATEGORY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.UpdateCategoryRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.UpdateCategoryResponse"},"legacyExamples":[{"name":"UpdateCategory","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl --location --request PATCH 'https://www.wixapis.com/blog/v3/categories/5f2bcaa0879ad500173577f3' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-raw '{\n \"category\": {\n \"description\": \"Posts about my summer and adventures\",\n },\n \"fieldMask\": \"category.description\"\n}'\n~~~","response":"~~~json\n{\n \"category\": {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"postCount\": 0,\n \"description\": \"Posts about my summer and adventures\",\n \"title\": \"Summer\",\n \"coverMedia\": {\n \"enabled\": true,\n \"displayed\": true,\n \"custom\": true\n },\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Update Category","slugifiedName":"update-category"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"isAdminMethod":true},{"summary":"Get Category","description":"Gets a category with the provided ID.","operationId":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService.GetCategory","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"categoryId","description":"Category ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"fieldsets","in":"query","description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","required":false,"schema":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.GetCategoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ-CATEGORY"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.GetCategoryRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.GetCategoryResponse"},"legacyExamples":[{"name":"GetCategory","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/categories/5f2bcaa0879ad500173577f3?fieldsets=URL' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"category\": {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"url\": {\n \"base\": \"https://some-user.wixsite.com/my-site\",\n \"path\": \"/blog/categories/summer\"\n },\n \"postCount\": 17,\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\",\n \"translationId\": \"111a58a2-dc75-422d-9ca6-00a489750dfd\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"get","path":"/v3/categories/{categoryId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ-CATEGORY"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.GetCategoryRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.GetCategoryResponse"},"legacyExamples":[{"name":"GetCategory","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/categories/5f2bcaa0879ad500173577f3?fieldsets=URL' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"category\": {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"url\": {\n \"base\": \"https://some-user.wixsite.com/my-site\",\n \"path\": \"/blog/categories/summer\"\n },\n \"postCount\": 17,\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\",\n \"translationId\": \"111a58a2-dc75-422d-9ca6-00a489750dfd\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Get Category","slugifiedName":"get-category"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"isAdminMethod":false},{"summary":"Delete Category","description":"Deletes a category.","operationId":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService.DeleteCategory","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"categoryId","description":"Category ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.DeleteCategoryResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Category Deleted","description":"Triggered when a category is deleted.","permissions":["BLOG.READ-CATEGORY"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.blog.category","serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.blog.v3.category_deleted","sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"}],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.DELETE-CATEGORY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.DeleteCategoryRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.DeleteCategoryResponse"},"legacyExamples":[{"name":"DeleteCategory","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl --location --request DELETE 'https://www.wixapis.com/blog/v3/categories/5f2bcaa0879ad500173577f3' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n}'\n~~~","response":"~~~json\nundefined\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"delete","path":"/v3/categories/{categoryId}","rpcOnly":false,"triggeredEvents":[{"title":"Category Deleted","description":"Triggered when a category is deleted.","permissions":["BLOG.READ-CATEGORY"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.blog.category","serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.blog.v3.category_deleted","sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"}],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.DELETE-CATEGORY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.DeleteCategoryRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.DeleteCategoryResponse"},"legacyExamples":[{"name":"DeleteCategory","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl --location --request DELETE 'https://www.wixapis.com/blog/v3/categories/5f2bcaa0879ad500173577f3' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n}'\n~~~","response":"~~~json\nundefined\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Delete Category","slugifiedName":"delete-category"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"isAdminMethod":true},{"summary":"Get Category By Slug","description":"Gets a category with the provided slug.","operationId":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService.GetCategoryBySlug","parameters":[{"name":"slug","in":"query","description":"Slug of the category to retrieve.","required":true,"schema":{"description":"Slug of the category to retrieve.","minLength":1,"maxLength":100,"title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"fieldsets","in":"query","description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","required":false,"schema":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"language","in":"query","description":"2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nLanguage of the category to retrieve.","required":false,"schema":{"description":"2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nLanguage of the category to retrieve.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.GetCategoryBySlugResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ-CATEGORY"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.GetCategoryBySlugRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.GetCategoryBySlugResponse"},"legacyExamples":[{"name":"GetCategoryBySlug","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/categories/slugs/summer-slug' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"category\": {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"url\": {\n \"base\": \"https://some-user.wixsite.com/my-site\",\n \"path\": \"/blog/categories/summer\"\n },\n \"postCount\": 17,\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\",\n \"translationId\": \"111a58a2-dc75-422d-9ca6-00a489750dfd\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"get","path":"/v3/categories/slugs/{slug=**}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ-CATEGORY"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.GetCategoryBySlugRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.GetCategoryBySlugResponse"},"legacyExamples":[{"name":"GetCategoryBySlug","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/categories/slugs/summer-slug' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"category\": {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"url\": {\n \"base\": \"https://some-user.wixsite.com/my-site\",\n \"path\": \"/blog/categories/summer\"\n },\n \"postCount\": 17,\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\",\n \"translationId\": \"111a58a2-dc75-422d-9ca6-00a489750dfd\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Get Category By Slug","slugifiedName":"get-category-by-slug"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"isAdminMethod":false},{"summary":"Query Categories","description":"Retrieves a list of up to 100 categories, given the provided paging, filtering, and sorting.\nQuery Categories runs with these defaults, which you can override.\n- `displayPosition` is sorted in `DESC` order.\n- `paging.limit` is `50`.\n- `paging.offset` is `0`.\n\nFor field support for filters and sorting, see\n[Field Support for Filtering and Sorting](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/business-solutions/blog/category/filter-and-sort).\n\nTo learn about working with _Query_ endpoints, see\n[API Query Language](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/api-query-language),\n[Sorting and Paging](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/sorting-and-paging), and\n[Field Projection](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/field-projection).","operationId":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService.QueryCategories","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.QueryCategoriesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/categories","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/categories","destinationPath":"/v3/categories","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryCategoriesRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.wix.common.PlatformQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ-CATEGORY"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.QueryCategoriesRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.QueryCategoriesResponse"},"legacyExamples":[{"name":"QueryCategories","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/categories/query' \\\n --data-binary '{\n \"fieldsets\": [\"URL\"],\n \"filter\": {\n \"title\": {\n \"$startsWith\": \"Summer\"\n }\n }\n }' \\\n }\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"categories\": [\n {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"postCount\": 17,\n \"url\": {\n \"base\": \"https://some.wixsite.com/something-to-prod/blog\",\n \"path\": \"/blog/categories/summer\"\n },\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\",\n \"translationId\": \"111a58a2-dc75-422d-9ca6-00a489750dfd\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"hasNext\": false,\n \"offset\": 0,\n \"total\": 1\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"post","path":"/v3/categories/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ-CATEGORY"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.blog.category-service-api-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.v3.QueryCategoriesRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.v3.QueryCategoriesResponse"},"legacyExamples":[{"name":"QueryCategories","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/categories/query' \\\n --data-binary '{\n \"fieldsets\": [\"URL\"],\n \"filter\": {\n \"title\": {\n \"$startsWith\": \"Summer\"\n }\n }\n }' \\\n }\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"categories\": [\n {\n \"id\": \"5f2bcaa0879ad500173577f3\",\n \"label\": \"Summer\",\n \"postCount\": 17,\n \"url\": {\n \"base\": \"https://some.wixsite.com/something-to-prod/blog\",\n \"path\": \"/blog/categories/summer\"\n },\n \"description\": \"Posts about my summer\",\n \"title\": \"Summer\",\n \"displayPosition\": 1,\n \"language\": \"en\",\n \"slug\": \"summer-slug\",\n \"translationId\": \"111a58a2-dc75-422d-9ca6-00a489750dfd\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"hasNext\": false,\n \"offset\": 0,\n \"total\": 1\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Query Categories","slugifiedName":"query-categories"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"isAdminMethod":false}],"webhooks":[{"summary":"Category Created","title":"Category Created","description":"Triggered when a category is created.","permissions":["BLOG.READ-CATEGORY"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.blog.category","serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"eventType":"wix.blog.v3.category_created","legacyExamples":[{"name":"CategoryCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"71d1ead7-a341-4853-8f32-d5534e274473\",\n \"slug\": \"created\",\n \"id\": \"0002d822-bcf6-473f-8879-d913b788fd3c\",\n \"createdEvent\": {\n \"entity\": {\n \"id\": \"71d1ead7-a341-4853-8f32-d5534e274473\",\n \"label\": \"Membership Posts\",\n \"url\": {\n \"base\": \"https://www.darlingmagnolia.com\",\n \"path\": \"/blog/categories/membership-posts\"\n },\n \"description\": \"Exclusive Membership blog posts\",\n \"coverMedia\": {\n \"enabled\": true,\n \"displayed\": true\n },\n \"displayPosition\": 4,\n \"slug\": \"membership\",\n \"language\": \"en\"\n }\n },\n \"entityFqdn\": \"wix.blog.category\",\n \"eventTime\": \"2021-03-02T10:24:16.556Z\"\n}"}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","contentLink":{"displayName":"Category Created","slugifiedName":"category-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}]},{"summary":"Category Updated","title":"Category Updated","description":"Triggered when a category is updated.","permissions":["BLOG.READ-CATEGORY"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.blog.category","serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"eventType":"wix.blog.v3.category_updated","legacyExamples":[{"name":"CategoryUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"8c9bddc8-fd73-44de-8e49-441534b86e55\",\n \"slug\": \"updated\",\n \"id\": \"2a2aab57-dfb0-434b-94e0-5785d2c3ab7f\",\n \"entityFqdn\": \"wix.blog.category\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"id\": \"8c9bddc8-fd73-44de-8e49-441534b86e55\",\n \"label\": \"INTERNSHIP\",\n \"url\": {\n \"base\": \"https://patwebsite651.wixsite.com/my-site\",\n \"path\": \"/news/categories/internship\"\n },\n \"coverMedia\": {\n \"enabled\": true,\n \"image\": {\n \"id\": \"11062b_a98c4b8d0dc843aca9b8d55c3bb5c4a6~mv2.jpg\",\n \"url\": \"https://static.wixstatic.com/media/11062b_a98c4b8d0dc843aca9b8d55c3bb5c4a6~mv2.jpg\",\n \"height\": 3337,\n \"width\": 5000\n },\n \"displayed\": true\n },\n \"displayPosition\": 0,\n \"slug\": \"membership\",\n \"language\": \"en\"\n }\n },\n \"eventTime\": \"2021-03-02T10:24:22.659Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","contentLink":{"displayName":"Category Updated","slugifiedName":"category-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}]},{"summary":"Category Deleted","title":"Category Deleted","description":"Triggered when a category is deleted.","permissions":["BLOG.READ-CATEGORY"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.blog.category","serviceName":"com.wixpress.npm.communities.platformized.blog.v3.CategoryService","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"eventType":"wix.blog.v3.category_deleted","legacyExamples":[{"name":"CategoryDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"60322380d7e7c0002d5fdebf\",\n \"slug\": \"deleted\",\n \"id\": \"b2f19ac7-d318-4662-9529-b9eb49608eb4\",\n \"entityFqdn\": \"wix.blog.category\",\n \"eventTime\": \"2021-03-02T10:25:33.939Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","contentLink":{"displayName":"Category Deleted","slugifiedName":"category-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Categories API\n\nThe Categories API allows users to get and query blog categories. Categories allow readers to sort blog posts into different topics covered on a site. This improves navigation which makes it easier for users to find relevant content.\n\nThere can be up to 100 categories per language on a blog, and up to 10 categories per post. Categories appear in the Category Menu in the order they were created.\n\nWith the Wix Categories API, you can:\n\n- List, create, update, and delete categories.\n- Retrieve categories by their slug.\n- Query categories based on specific criteria.\n- Enable users to organize and categorize content efficiently.\n\n## Terminology\n\n- **Post**: A published article on a blog site. It is also referred to as a publication. A blog can have up to 100K posts.\n- **Draft Post**: An article written by a site owner, blog editor, blog writer, or a guest writer that is not yet published.\n- **Category**: A group of similar and related posts. A post can be assigned to a maximum of 10 categories.\n- **Tag**: A way to further sort and organize blog posts. Tags provide the ability to filter blog posts."},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Categories: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting\nfor the Category object:\n\n| Field | Supported Filters | Sortable |\n| ----------------- | ---------------------------------------------------------------------------------------- | -------- |\n| `id` | `$eq`, `$ne`, `$hasSome` | |\n| `title` | `$eq`, `$ne`, `$contains`, `$startsWith`, `$endsWith`, `$hasSome`,`$lt`, `$lte`, `$gt`, `$gte`, `$exists`, `$in` | Sortable |\n| `label` | `$eq`, `$ne`, `$contains`, `$startsWith`, `$endsWith`, `$hasSome`,`$lt`, `$lte`, `$gt`, `$gte`, `$exists`, `$in` | Sortable |\n| `postCount` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `displayPosition` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `translationId` | `$eq`, `$ne`, `$exists`, `$in` | |\n| `language` | `$eq`, `$ne`, `$exists`, `$in` | Sortable |\n| `slug` | `$hasSome`, `$hasAll` | Sortable |\n\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/api-query-language),\n[Query endpoint](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/business-solutions/blog/category/query-categories)\n"}],"components":{"schemas":{"com.wixpress.npm.communities.platformized.blog.v3.Category":{"type":"object","properties":{"id":{"description":"Category ID.","immutable":true,"maxLength":38,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"label":{"description":"Category label. Displayed in the Category Menu.","maxLength":35,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"postCount":{"description":"Number of posts in the category.","readOnly":true,"title":"postCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Category URL.","readOnly":true,"$ref":"#/components/schemas/wix.common.PageUrl","summary":"url","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Category description.","maxLength":500,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Category title.","maxLength":200,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rank":{"description":"Category position in sequence.","title":"rank","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"Category position in sequence.","replacedBy":"display_position","targetRemovalDate":"2024-06-30"}}},"displayPosition":{"description":"Category position in sequence. Categories with a lower display position are displayed first. Categories with a position of `-1` appear at the end of the sequence.\n\nDefault: `-1`","minimum":0,"title":"displayPosition","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translationId":{"description":"ID of the category's translations. All translations of a single category share the same `translationId`.","format":"GUID","title":"translationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Category language.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.","immutable":true,"title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"Category slug. For example, `'category-slug'`.","maxLength":100,"title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"internalId":{"description":"Reserved for internal use.","readOnly":true,"maxLength":24,"title":"internalId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"seoData":{"description":"SEO data.","$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema","summary":"seoData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"coverImage":{"description":"Category cover image.","$ref":"#/components/schemas/wix.common.Image","summary":"coverImage","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the Category was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Category","description":""},"wix.common.PageUrl":{"type":"object","properties":{"base":{"description":"The base URL. For premium sites, this is the domain. For free sites, this is the site URL. For example, `mysite.wixsite.com/mysite`.","title":"base","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"path":{"description":"The relative path for the page within the site. For example, `/product-page/a-product`.","title":"path","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PageUrl","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.advanced.seo.SeoSchema":{"type":"object","properties":{"tags":{"description":"SEO tag information.","title":"tags","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Tag"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"settings":{"description":"SEO general settings.","$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Settings","summary":"settings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SeoSchema","description":"The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\nThe search engines use this information for ranking purposes, or to display snippets in the search results.\nThis data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself."},"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":["NULL_VALUE"]},"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":""},"com.wixpress.advanced.seo.SeoSchema.Keyword":{"type":"object","properties":{"term":{"description":"Keyword value.","title":"term","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isMain":{"description":"Whether the keyword is the main focus keyword.","title":"isMain","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"origin":{"description":"Who added the keyword to the settings","maxLength":1000,"title":"origin","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Keyword","description":""},"com.wixpress.advanced.seo.SeoSchema.Tag":{"type":"object","properties":{"type":{"description":"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.","title":"type","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"props":{"description":"A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\nFor example: `{'name': 'description', 'content': 'the description itself'}`.","title":"props","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"meta":{"description":"SEO tag meta data. For example, `{height: 300, width: 240}`.","title":"meta","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"children":{"description":"SEO tag inner content. For example, ` inner content `.","title":"children","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"Whether the tag is a custom tag.","title":"custom","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disabled":{"description":"Whether the tag is disabled.","title":"disabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Tag","description":""},"com.wixpress.advanced.seo.SeoSchema.Settings":{"type":"object","properties":{"preventAutoRedirect":{"description":"Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n\n\nDefault: `false` (Auto Redirect is enabled.)","title":"preventAutoRedirect","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"keywords":{"description":"User-selected keyword terms for a specific page.","maxItems":5,"title":"keywords","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Keyword"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Settings","description":""},"wix.common.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Image URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Original image height.","readOnly":true,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Original image width.","readOnly":true,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Image filename.","readOnly":true,"title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","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":""},"com.wixpress.npm.communities.platformized.blog.v3.CategoryTranslation":{"type":"object","properties":{"id":{"description":"Category ID","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"label":{"description":"Label which is presented in the categories menu on site","maxLength":100,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language of the category","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Url of this category page","$ref":"#/components/schemas/wix.common.PageUrl","summary":"url","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CategoryTranslation","description":""},"com.wixpress.npm.communities.platformized.blog.v3.InitialCategoriesCopied":{"type":"object","properties":{"count":{"description":"Number of categories copied.","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InitialCategoriesCopied","description":""},"com.wixpress.npm.communities.platformized.blog.v3.CreateCategoryRequest":{"type":"object","properties":{"category":{"description":"Category info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCategoryRequest","description":""},"com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field":{"type":"string","description":"","title":"Field","enum":["UNKNOWN","URL","INTERNAL_ID","SEO","TRANSLATIONS"]},"com.wixpress.npm.communities.platformized.blog.v3.CreateCategoryResponse":{"type":"object","properties":{"category":{"description":"Category info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCategoryResponse","description":""},"com.wixpress.npm.communities.platformized.blog.v3.BulkCreateCategoriesRequest":{"type":"object","properties":{"categories":{"description":"Categories to create.","minItems":1,"maxItems":50,"title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnFullEntity":{"description":"Whether to return the full created category entities in the response.","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateCategoriesRequest","description":""},"com.wixpress.npm.communities.platformized.blog.v3.BulkCreateCategoriesResponse":{"type":"object","properties":{"results":{"description":"Categories created by bulk action.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.BulkCategoryResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateCategoriesResponse","description":""},"com.wixpress.npm.communities.platformized.blog.v3.BulkCategoryResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk actions metadata for category.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Optional created category.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCategoryResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"com.wixpress.npm.communities.platformized.blog.v3.BulkUpdateCategoriesRequest":{"type":"object","properties":{"categories":{"description":"Categories to update.","minItems":1,"maxItems":100,"title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.MaskedCategory"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnFullEntity":{"description":"Whether to return the full created category entities in the response.","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of category fields to be included in the response if the entities are present.\nBase default fieldset returns all core category properties (all properties that are not a supported fieldset value).\nFor example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateCategoriesRequest","description":""},"com.wixpress.npm.communities.platformized.blog.v3.MaskedCategory":{"type":"object","properties":{"category":{"description":"Category","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MaskedCategory","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":""},"com.wixpress.npm.communities.platformized.blog.v3.BulkUpdateCategoriesResponse":{"type":"object","properties":{"results":{"description":"Categories updated by bulk action.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.BulkCategoryResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateCategoriesResponse","description":""},"com.wixpress.npm.communities.platformized.blog.v3.UpdateCategoryRequest":{"type":"object","properties":{"category":{"description":"Category info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCategoryRequest","description":""},"com.wixpress.npm.communities.platformized.blog.v3.UpdateCategoryResponse":{"type":"object","properties":{"category":{"description":"Category info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCategoryResponse","description":""},"com.wixpress.npm.communities.platformized.blog.v3.GetCategoriesCountByLanguageRequest":{"type":"object","properties":{},"title":"GetCategoriesCountByLanguageRequest","description":""},"com.wixpress.npm.communities.platformized.blog.v3.GetCategoriesCountByLanguageResponse":{"type":"object","properties":{"categoriesLanguageCount":{"description":"The language and it's count.","title":"categoriesLanguageCount","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryLanguageCount"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCategoriesCountByLanguageResponse","description":""},"com.wixpress.npm.communities.platformized.blog.v3.CategoryLanguageCount":{"type":"object","properties":{"languageCode":{"description":"2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.","format":"LANGUAGE_TAG","title":"languageCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"categoryCount":{"description":"The count of Categories for the language.","title":"categoryCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CategoryLanguageCount","description":""},"com.wixpress.npm.communities.platformized.blog.v3.GetCategoryRequest":{"type":"object","properties":{"categoryId":{"description":"Category ID.","minLength":1,"maxLength":38,"title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCategoryRequest","description":""},"com.wixpress.npm.communities.platformized.blog.v3.GetCategoryResponse":{"type":"object","properties":{"category":{"description":"Category info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCategoryResponse","description":""},"com.wixpress.npm.communities.platformized.blog.v3.GetCategoryBySlugRequest":{"type":"object","properties":{"slug":{"description":"Slug of the category to retrieve.","minLength":1,"maxLength":100,"title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nLanguage of the category to retrieve.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCategoryBySlugRequest","description":""},"com.wixpress.npm.communities.platformized.blog.v3.GetCategoryBySlugResponse":{"type":"object","properties":{"category":{"description":"Category info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category","summary":"category","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCategoryBySlugResponse","description":""},"com.wixpress.npm.communities.platformized.blog.v3.ListCategoriesRequest":{"type":"object","properties":{"paging":{"description":"Pagination options.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.BlogPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language filter.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nPass a language to only receive categories that are in that language.\nIf omitted, categories in all languages are returned.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListCategoriesRequest","description":""},"com.wixpress.npm.communities.platformized.blog.BlogPaging":{"type":"object","properties":{"offset":{"description":"Number of items to skip in the current sort order.\n\n\nDefault: `0`","minimum":0,"title":"offset","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"Number of items to return.\n\n\nDefault:`50`","minimum":1,"maximum":100,"title":"limit","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.","maxLength":2000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BlogPaging","description":""},"com.wixpress.npm.communities.platformized.blog.v3.ListCategoriesResponse":{"type":"object","properties":{"categories":{"description":"List of categories.","title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metaData":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.MetaData","summary":"metaData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListCategoriesResponse","description":""},"com.wixpress.npm.communities.platformized.blog.MetaData":{"type":"object","properties":{"count":{"description":"Number of items returned in this response.","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Requested offset.","title":"offset","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query.","title":"total","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.","maxLength":2000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MetaData","description":""},"com.wixpress.npm.communities.platformized.blog.v3.QueryCategoriesRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.wix.common.PlatformQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the category’s base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.CategoryField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryCategoriesRequest","description":""},"com.wixpress.npm.communities.platformized.upstream.wix.common.PlatformQuery":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","maxItems":3,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlatformQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.wix.common.PlatformQuery.pagingMethod"}]},"com.wixpress.npm.communities.platformized.upstream.wix.common.PlatformQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"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/com.wixpress.npm.communities.platformized.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"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":["ASC","DESC"]},"com.wixpress.npm.communities.platformized.upstream.wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"com.wixpress.npm.communities.platformized.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","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\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":2000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"com.wixpress.npm.communities.platformized.blog.v3.QueryCategoriesResponse":{"type":"object","properties":{"categories":{"description":"List of categories.","title":"categories","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.v3.Category"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryCategoriesResponse","description":""},"com.wixpress.npm.communities.platformized.upstream.wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"com.wixpress.npm.communities.platformized.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor pointing to next page in the list of results.","maxLength":2000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to previous page in the list of results.","maxLength":2000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wixpress.npm.communities.platformized.blog.v3.BulkDeleteCategoryRequest":{"type":"object","properties":{"categoryIds":{"description":"Category IDs.","minItems":1,"maxItems":100,"maxLength":38,"title":"categoryIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"permanent":{"description":"Should delete bypassing the trash-bin.","title":"permanent","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteCategoryRequest","description":""},"com.wixpress.npm.communities.platformized.blog.v3.BulkDeleteCategoryResponse":{"type":"object","properties":{},"title":"BulkDeleteCategoryResponse","description":""},"com.wixpress.npm.communities.platformized.blog.v3.DeleteCategoryRequest":{"type":"object","properties":{"categoryId":{"description":"Category ID.","minLength":1,"maxLength":38,"title":"categoryId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteCategoryRequest","description":""},"com.wixpress.npm.communities.platformized.blog.v3.DeleteCategoryResponse":{"type":"object","properties":{},"title":"DeleteCategoryResponse","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":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","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":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Category","description":"Blog Submodule Docs","fqdn":"wix.blog.v3.category"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Categories API\n\nThe Categories API allows users to get and query blog categories. Categories allow readers to sort blog posts into different topics covered on a site. This improves navigation which makes it easier for users to find relevant content.\n\nThere can be up to 100 categories per language on a blog, and up to 10 categories per post. Categories appear in the Category Menu in the order they were created.\n\nWith the Wix Categories API, you can:\n\n- List, create, update, and delete categories.\n- Retrieve categories by their slug.\n- Query categories based on specific criteria.\n- Enable users to organize and categorize content efficiently.\n\n## Terminology\n\n- **Post**: A published article on a blog site. It is also referred to as a publication. A blog can have up to 100K posts.\n- **Draft Post**: An article written by a site owner, blog editor, blog writer, or a guest writer that is not yet published.\n- **Category**: A group of similar and related posts. A post can be assigned to a maximum of 10 categories.\n- **Tag**: A way to further sort and organize blog posts. Tags provide the ability to filter blog posts."},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Categories: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting\nfor the Category object:\n\n| Field | Supported Filters | Sortable |\n| ----------------- | ---------------------------------------------------------------------------------------- | -------- |\n| `id` | `$eq`, `$ne`, `$hasSome` | |\n| `title` | `$eq`, `$ne`, `$contains`, `$startsWith`, `$endsWith`, `$hasSome`,`$lt`, `$lte`, `$gt`, `$gte`, `$exists`, `$in` | Sortable |\n| `label` | `$eq`, `$ne`, `$contains`, `$startsWith`, `$endsWith`, `$hasSome`,`$lt`, `$lte`, `$gt`, `$gte`, `$exists`, `$in` | Sortable |\n| `postCount` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `displayPosition` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `translationId` | `$eq`, `$ne`, `$exists`, `$in` | |\n| `language` | `$eq`, `$ne`, `$exists`, `$in` | Sortable |\n| `slug` | `$hasSome`, `$hasAll` | Sortable |\n\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/api-query-language),\n[Query endpoint](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/business-solutions/blog/category/query-categories)\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

カテゴリー削除