--- updatedAt: 2025-06-12T13:58:20.000Z agentTools: projectIndex: https://developer.data.world/llms.txt --- # Get comments for a topic This API allows users to retrieve comments for a specific topic they have access to, identified by the owner's ID and the topic's UUID. Users can control the number of comments returned, with options to sort and paginate results. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "contact": { "name": "Contact Us", "url": "https://data.world/company/contact-us" }, "termsOfService": "https://data.world/terms-policies", "title": "data.world Public API", "version": "0" }, "servers": [ { "url": "https://api.data.world/v0" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "topics and comments - resource" } ], "paths": { "/topics/{owner}/{topicUuid}/comments": { "get": { "description": "This API allows users to retrieve comments for a specific topic they have access to, identified by the owner's ID and the topic's UUID. Users can control the number of comments returned, with options to sort and paginate results.", "operationId": "getCommentsByTopic", "parameters": [ { "in": "path", "name": "owner", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topicUuid", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "description": "Size of page to fetch", "in": "query", "name": "size", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 1000 } }, { "description": "Result number to start fetch from (not the page number to start from)", "in": "query", "name": "from", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "description": "Sort results by fields", "in": "query", "name": "sort", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedGenericResultsPublicCommentDto" } } }, "description": "default response" } }, "summary": "Get comments for a topic", "tags": [ "topics and comments - resource" ] } } }, "components": { "schemas": { "AgentHydrationDto": { "type": "object", "properties": { "avatarUrl": { "type": "string" }, "deactivated": { "type": "boolean" }, "displayName": { "type": "string" }, "id": { "type": "string" } } }, "AssetStatus": { "type": "object", "properties": { "assetStatusLabel": { "type": "string" }, "dispositionLabel": { "type": "string" } } }, "CatalogConceptHydrationDto": { "type": "object", "properties": { "altLabel": { "type": "string" }, "iri": { "type": "string" }, "owner": { "type": "string" }, "prefLabel": { "type": "string" } } }, "CollectionHydrationDto": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string", "description": "dct:identifier of the collection" }, "iri": { "type": "string" }, "owner": { "type": "string" }, "title": { "type": "string" } } }, "EmojiIcon": { "allOf": [ { "$ref": "#/components/schemas/Icon" }, { "type": "object", "properties": { "type": { "type": "string", "const": "emoji" }, "value": { "type": "string" } } } ] }, "EntryType": { "type": "object", "properties": { "icon": { "$ref": "#/components/schemas/Icon", "oneOf": [ { "$ref": "#/components/schemas/EmojiIcon" }, { "$ref": "#/components/schemas/ImageIcon" }, { "$ref": "#/components/schemas/SvgIcon" } ] }, "instantiable": { "type": "boolean" }, "label": { "type": "string" }, "mdpModule": { "type": "array", "description": "Indicates the metadata profile module(s) that introduced this type. A type can be extended by more than one module (e.g. shared types like Table/Column/Database are referenced by many source modules), so this may contain multiple values. Null if not recorded for this type.", "items": { "type": "string", "enum": [ "Airflow", "Alteryx", "Athena", "AWS DMS", "AWS Glue", "AWS Lake Formation", "AWS S3", "Azure Data Factory", "Azure Data Lake Storage", "Collections", "Column Statistics", "Databricks", "Data Products", "DB2", "dbt", "Denodo", "DynamoDB", "Fivetran", "Generic JDBC", "Generic Resources", "Google BigQuery", "Grafana", "Hive", "Hive Metastore", "Hoot Browser Extension", "InfluxDB", "Infor Ion", "Informatica CDI", "Kafka", "Looker", "MANTA", "Marquez", "Microsoft Fabric", "Microsoft SQL Server", "Microsoft SSIS", "Microsoft SSRS", "MongoDB", "Monte Carlo", "MySql", "Netezza", "OOTB", "OpenAPI", "OpenAPI 3", "Oracle", "PBIRS", "PostgreSQL", "Power BI", "Qlik Replicate", "Qlik Sense", "Qlik Talend DI", "Quicksight", "Redshift", "Reltio", "Salesforce", "SAP HANA", "Sensitive Data Classification", "Sensitive Data Discovery (legacy)", "ServiceNow (testing preview)", "Sigma", "Snowflake", "Snowflake Data Metric Functions", "Snowflake Table Usage", "Snowflake Tags and Policies", "Spreadsheet DB", "Tableau (legacy)", "Tableau", "Teradata", "Thoughtspot", "User Layer" ] } }, "mdpOrigin": { "type": "string", "description": "Indicates whether the metadata configuration was defined out-of-the-box (\"ootb\"), including via a metadata profile module, or as a custom definition (\"custom\"). Null if not recorded for this type.", "enum": [ "ootb", "custom" ] }, "pluralLabel": { "type": "string" }, "requestable": { "type": "boolean" }, "type": { "type": "string", "description": "Entry type IRI" } } }, "HostedImage": { "allOf": [ { "$ref": "#/components/schemas/Image" }, { "type": "object", "properties": { "type": { "type": "string", "const": "hosted" }, "url": { "type": "string" } } } ] }, "Icon": { "type": "object", "discriminator": { "mapping": { "emoji": "#/components/schemas/EmojiIcon", "image": "#/components/schemas/ImageIcon", "svg-image": "#/components/schemas/SvgIcon" }, "propertyName": "type" }, "properties": { "type": { "type": "string", "enum": [ "emoji", "image", "svg-image" ] } } }, "Image": { "type": "object", "discriminator": { "mapping": { "hosted": "#/components/schemas/HostedImage", "provided": "#/components/schemas/ProvidedImage" }, "propertyName": "type" }, "properties": { "type": { "type": "string", "enum": [ "hosted", "provided" ] } } }, "ImageIcon": { "allOf": [ { "$ref": "#/components/schemas/Icon" }, { "type": "object", "properties": { "image": { "$ref": "#/components/schemas/Image", "oneOf": [ { "$ref": "#/components/schemas/HostedImage" }, { "$ref": "#/components/schemas/ProvidedImage" } ] }, "largeImage": { "$ref": "#/components/schemas/Image", "oneOf": [ { "$ref": "#/components/schemas/HostedImage" }, { "$ref": "#/components/schemas/ProvidedImage" } ] }, "selectedImage": { "$ref": "#/components/schemas/Image", "oneOf": [ { "$ref": "#/components/schemas/HostedImage" }, { "$ref": "#/components/schemas/ProvidedImage" } ] }, "type": { "type": "string", "const": "image" } } } ] }, "PaginatedGenericResultsPublicCommentDto": { "type": "object", "properties": { "consistent": { "type": "boolean" }, "count": { "type": "integer", "format": "int32", "minimum": 0 }, "hydrations": { "$ref": "#/components/schemas/PubSearchHydrations" }, "next": { "type": "string" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/PublicCommentDto" } } } }, "PropertyHydrationDto": { "type": "object", "properties": { "label": { "type": "array", "description": "Label of the metadata presentation associated with the property", "items": { "type": "string" } } } }, "ProvidedImage": { "allOf": [ { "$ref": "#/components/schemas/Image" }, { "type": "object", "properties": { "slug": { "type": "string" }, "type": { "type": "string", "const": "provided" } } } ] }, "PubSearchHydrations": { "type": "object", "properties": { "agents": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AgentHydrationDto" } }, "catalogConcepts": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CatalogConceptHydrationDto" } }, "collections": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionHydrationDto" } }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyHydrationDto" } }, "relationships": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/RelationshipHydrationDto" } }, "resourceHierarchy": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceHierarchyDto" } } } } } }, "PublicCommentDto": { "type": "object", "properties": { "body": { "type": "string", "description": "Body content of the comment." }, "commentid": { "type": "string", "description": "Comment id generated while creating a comment. Returned for reference but must be provided through URL only." }, "owner": { "type": "string", "description": "An organization owning a comment. Returned for reference but must be provided through URL only." }, "topicUuid": { "type": "string", "format": "uuid", "description": "Topic unique id stored along comments. Returned for reference but must be provided through URL only." } } }, "RelationshipHydrationDto": { "type": "object", "properties": { "labels": { "type": "array", "description": "Label of the relationship presentation associated with the relationship", "items": { "type": "string" } } } }, "ResourceHierarchyDto": { "type": "object", "properties": { "assetStatus": { "$ref": "#/components/schemas/AssetStatus", "description": "Resource status: Pending, Approved etc." }, "hierarchy": { "type": "array", "description": "Parent types of this resource's type. Returns the most specific type followed by its parent. The first item is the same as type. The last item is the root type.", "items": { "$ref": "#/components/schemas/EntryType" } }, "icon": { "$ref": "#/components/schemas/Icon", "description": "Resource icon details.", "oneOf": [ { "$ref": "#/components/schemas/EmojiIcon" }, { "$ref": "#/components/schemas/ImageIcon" }, { "$ref": "#/components/schemas/SvgIcon" } ] }, "iri": { "type": "string", "description": "Resource IRI." }, "owner": { "type": "string", "description": "The ID of the organization that this resource belongs to" }, "title": { "type": "string", "description": "Resource title" }, "type": { "type": "string", "description": "Resource simple type name, e.g. catalogDatabase, catalogEntry etc." }, "typeLabel": { "type": "string", "description": "Resource type label." } } }, "SvgIcon": { "allOf": [ { "$ref": "#/components/schemas/Icon" }, { "type": "object", "properties": { "image": { "$ref": "#/components/schemas/Image", "oneOf": [ { "$ref": "#/components/schemas/HostedImage" }, { "$ref": "#/components/schemas/ProvidedImage" } ] }, "largeImage": { "$ref": "#/components/schemas/Image", "oneOf": [ { "$ref": "#/components/schemas/HostedImage" }, { "$ref": "#/components/schemas/ProvidedImage" } ] }, "selectedImage": { "$ref": "#/components/schemas/Image", "oneOf": [ { "$ref": "#/components/schemas/HostedImage" }, { "$ref": "#/components/schemas/ProvidedImage" } ] }, "type": { "type": "string", "const": "svg-image" } } } ] } }, "securitySchemes": { "bearerAuth": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http" } } }, "jsonSchemaDialect": "https://spec.openapis.org/oas/3.1/dialect/base" } ```