Atlassian Compass

Atlassian Compass is a powerful tool for managing microservices and software components. By integrating Theneo with Compass, you can bring your API documentation directly into your Compass environment, enhancing collaboration and visibility. Here’s a step-by-step guide on how to set up the Theneo integration in Compass.

Installation

1. Access Compass: Log into your Compass account.
2. Install the Theneo App:
   • Navigate to 'Apps' from the top menu bar in Compass.
   • Find the Theneo tile and select 'Install'.
3. Configuration:
   • After installation, if you are an admin, select 'Configure' to proceed with setting up the integration.

Setting Up the Integration

1. Install Theneo App on Compass:
   • Within Compass, go to the Theneo app configuration.
   • Paste your copied Theneo API key to link your Theneo account with Compass.
2. Create or Link a Theneo Project:
   • You can choose to start a new API documentation project in Theneo or link an existing one.

Adding a Project to a Compass Component

Upload a File

• Find the Compass Component:
  • Go to the component where you want to add the spec file and select 'Theneo'.
  • Under the 'Upload File' tab, drag and drop your spec file onto the drop zone or browse to select the file from your computer.
  • The file size limit is 10MB.

Using Webhook

• cURL Command Example:

 
curl -F file=@<FILE_NAME_TO_IMPORT> -F project_name=<PROJECT_NAME_TO_CREATE> -F ai_option=<none|full|enhance> -H "x-theneo-api-key:<YOUR_API_KEY>" https://api.theneo.io/project/import/specfile

• Replace placeholders with your file name, project name, AI option, and Theneo API key.
• AI options include 'none', 'full', and 'enhance'.

Linking to an Existing Project

• Select from Published Projects:
  • Use the dropdown menu to choose from your published projects in Theneo.

AI Assistance for API Documentation

• Full AI Assistance: Generates new content for your documentation.
• Enhance Existing Content: AI enhances your existing documentation by filling in missing descriptions.

Removing the Project from a Compass Component

• In your project view, find the dropdown menu on the top right and select 'Generate new project'.

Removing the API Key from a Compass Component

• Navigate to Theneo under 'Apps', click on 'Configure', and then find the option to 'Replace API Key'.
• Note: This action is restricted to administrators.