{ "opencollection": "1.0.0", "info": { "name": "Honeycomb Auth Query Annotations API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "X-Honeycomb-Team", "value": "{{X-Honeycomb-Team}}", "placement": "header" } }, "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 slug identifier for the dataset. Dataset names are case insensitive." } ] }, "docs": "Returns a list of all query annotations for the specified dataset." }, { "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 slug identifier for the dataset. Dataset names are case insensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new query annotation to associate a name and description to a query for collaboration." }, { "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 slug identifier for the dataset. Dataset names are case insensitive." }, { "name": "queryAnnotationId", "value": "", "type": "path", "description": "The unique identifier for the query annotation." } ] }, "docs": "Returns a single query annotation by its ID." }, { "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 slug identifier for the dataset. Dataset names are case insensitive." }, { "name": "queryAnnotationId", "value": "", "type": "path", "description": "The unique identifier for the query annotation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a query annotation's name or description." }, { "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 slug identifier for the dataset. Dataset names are case insensitive." }, { "name": "queryAnnotationId", "value": "", "type": "path", "description": "The unique identifier for the query annotation." } ] }, "docs": "Deletes a query annotation." } ] } ], "bundled": true }