Created
March 25, 2024 15:21
-
-
Save wjkennedy/c8619e99553906dfc1754286acca0ff3 to your computer and use it in GitHub Desktop.
atlassian community khoros api
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: 3.0.3 | |
info: | |
title: Simple Atlassian Community Search API | |
version: 1.0.1 | |
description: This API allows performing a simple search in the Atlassian Community messages. | |
servers: | |
- url: https://community.atlassian.com/api/2.0 | |
description: Atlassian Community API Server | |
paths: | |
/search: | |
get: | |
summary: Search in Atlassian Community messages | |
operationId: searchMessages | |
tags: | |
- Search | |
parameters: | |
- name: q | |
in: query | |
description: | | |
SQL-like query to search messages. Supports filtering by tags, conversation style, replies count, and depth. | |
Allows ordering and limiting the number of results. | |
required: true | |
schema: | |
type: string | |
example: "SELECT * FROM messages WHERE tags.text IN ('jira') AND conversation.style='qanda' AND replies.count(*) = 0 AND depth = 0 ORDER BY post_time DESC LIMIT 10" | |
responses: | |
'200': | |
description: A list of messages matching the query. | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
status: | |
type: string | |
example: "success" | |
message: | |
type: string | |
example: "Query executed successfully." | |
data: | |
type: array | |
items: | |
$ref: '#/components/schemas/Message' | |
components: | |
schemas: | |
Message: | |
type: object | |
properties: | |
id: | |
type: string | |
description: Unique identifier for the message. | |
text: | |
type: string | |
description: The text content of the message. | |
author: | |
type: string | |
description: The author of the message. | |
post_time: | |
type: string | |
format: date-time | |
description: The time when the message was posted. | |
tags: | |
type: array | |
items: | |
type: string | |
description: Tags associated with the message. | |
replies_count: | |
type: integer | |
description: Number of replies to the message. | |
depth: | |
type: integer | |
description: The depth of the message in the conversation thread. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment