{ "opencollection": "1.0.0", "info": { "name": "Honeycomb Auth Query Annotations API", "version": "1.0.0" }, "items": [ { "info": { "name": "Query Annotations", "type": "folder" }, "items": [ { "info": { "name": "List Query Annotations", "type": "http" }, "http": { "method": "GET", "url": "https://api.honeycomb.io/1/query_annotations/:datasetSlug", "params": [ { "name": "datasetSlug", "value": "", "type": "path", "description": "The dataset slug or use `__all__` for endpoints that support environment-wide operations.\n" }, { "name": "include_board_annotations", "value": "", "type": "query", "description": "Whether to include Query Annotations that were created from boards. By default, only Query Annotations created directly from queries are returned.\n" } ] }, "docs": "List all Query Annotations in the specified dataset.\n" }, { "info": { "name": "Create a Query Annotation", "type": "http" }, "http": { "method": "POST", "url": "https://api.honeycomb.io/1/query_annotations/:datasetSlug", "params": [ { "name": "datasetSlug", "value": "", "type": "path", "description": "The dataset slug or use `__all__` for endpoints that support environment-wide operations.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Query Annotation for the specified query ID.\n" }, { "info": { "name": "Get a Query Annotation", "type": "http" }, "http": { "method": "GET", "url": "https://api.honeycomb.io/1/query_annotations/:datasetSlug/:queryAnnotationId", "params": [ { "name": "datasetSlug", "value": "", "type": "path", "description": "The dataset slug or use `__all__` for endpoints that support environment-wide operations.\n" }, { "name": "queryAnnotationId", "value": "", "type": "path", "description": "The unique identifier (ID) of the annotation." } ] }, "docs": "Get a Query Annotation by its ID.\n" }, { "info": { "name": "Update a Query Annotation", "type": "http" }, "http": { "method": "PUT", "url": "https://api.honeycomb.io/1/query_annotations/:datasetSlug/:queryAnnotationId", "params": [ { "name": "datasetSlug", "value": "", "type": "path", "description": "The dataset slug or use `__all__` for endpoints that support environment-wide operations.\n" }, { "name": "queryAnnotationId", "value": "", "type": "path", "description": "The unique identifier (ID) of the annotation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Query Annotation by specifying its ID. The Query ID associated with the Query Annotation cannot be updated. Partial updates are not supported.\n" }, { "info": { "name": "Delete a Query Annotation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.honeycomb.io/1/query_annotations/:datasetSlug/:queryAnnotationId", "params": [ { "name": "datasetSlug", "value": "", "type": "path", "description": "The dataset slug or use `__all__` for endpoints that support environment-wide operations.\n" }, { "name": "queryAnnotationId", "value": "", "type": "path", "description": "The unique identifier (ID) of the annotation." } ] }, "docs": "Delete a Query Annotation by specifying its ID.\n" } ] } ], "bundled": true }