Appvibe Swagger Integration
Overview of Features
Key Features
Feature 1: Add Links: Embed Swagger links directly into Jira issues for quick access to spreadsheets. This feature ensures that all relevant Swagger data is directly accessible within the context of a Jira issue, streamlining workflow and improving efficiency.
Feature 2: Edit Links: Update or modify embedded Swagger links as the spreadsheet changes. This allows users to keep the information current without the need to create new links, maintaining consistency across the documentation and issues.
Feature 3: Remove Links: Easily remove links when they are no longer relevant, keeping your Jira issues clutter-free and current. This helps in managing the workflow and ensuring that only necessary and valid links are available.
Feature 4: View Links in Preview and Full Screen: Preview Swagger content directly within Jira or choose to expand it to full screen for a more detailed view. This flexibility allows users to interact with the data in a way that suits their needs.
Feature 5: Sort Links: Organize Swagger links by custom criteria, name, or date, providing a more structured view of the linked content. This supports easy navigation and quick access based on user-defined parameters.
Feature 6: Realign Links: Adjust the positioning of Swagger links within the Jira issue for better visibility and organization. This feature provides enhanced control over how links are presented alongside issue content.
Feature 7: View Links in List or Tile View: Toggle between list or tile layout for viewing links, allowing users to choose their preferred format for ease of use and management.
Feature 8: Manage Permissions: Control who can view and interact with Swagger links embedded in Jira, securing sensitive information and ensuring that only authorized personnel can access the links.
Feature 9: View Link History: Access the history of changes made to each Swagger link, offering a comprehensive audit trail and enabling users to track modifications over time for accountability and review purposes.
Getting Started
Installation
Step 1:
Log in to Jira
Ensure you are logged in with Admin privileges.
Step 2:
Open the Atlassian Marketplace
In Jira, click on Apps → Explore more apps to open the Marketplace.
Search for Appvibe Swagger Integration
Use the search bar to find the app.
Install the App
Click Get app or Try it free.
Confirm the installation and grant the required permissions.
Step 3:
Configure the App
Once installed, go to Manage Apps in the Admin section to ensure it's enabled.
The panel will now appear in your Jira issue view.
Step 4:
Start Using the App to add and view links for Swagger
Open any Jira issue to view, add, or manage Swagger links directly.
Working with Links
Add a Link
Step 1:
Inside a Jira issue, click the "Add" button. A form will appear inline, allowing you to enter:
- Embedded URL – The link to your Swagger design.
- Title – A meaningful name for the design. (optional)
Step 2:
View a Link
Step 1:
Inside a Jira issue, find the link you want to view and click the view icon for that link.
Step 2:
An inline popup will appear showing your Swagger. You can also click this for full screen viewing.
Edit a Link
Step 1:
Inside a Jira issue, find the link you want to edit and click the "Edit" from the link dropdown.
Step 2:
A form will appear inline, allowing you to edit the following:
- Embedded URL – The link to your Swagger design.
- Title – A meaningful name for the design. (optional)
Step 3:
Click the save button again to add your Swagger link to the Jira issue.
Delete a Link
Step 1:
Inside a Jira issue, locate the link you want to remove.
Step 2:
Step 3:
Select "Delete" from the menu.
Step 4:
You will be prompted to confirm if you want to delete this Swagger link.
Advanced
View Link History
Step 1:
Install the Appvibe Swagger Integration app in your Jira environment. This app is specifically designed to track and manage changes to Swagger links associated with Jira issues.
Step 2:
Once installed, every modification to a Swagger link within a Jira issue is automatically tracked. These changes are stored in the history, which can be accessed either at the individual link level or at the Jira issue level, allowing for easy viewing of past modifications at any time.
Link Permissions
Step 1:
Go to the Appvibe Swagger Integration configuration page or click 'Permissions' from within the link settings in a Jira issue.
Step 2:
Assign permissions to users who will manage or interact with links in the Jira issue:
- Viewer: Users will be able to view the link.
- Editer: Users will be able to add, edit, or remove links.
- Admin: Users will have the ability to manage link permissions for other users.
Help
FAQ
What if the Swagger link doesn’t load?
Ensure the link is public and accessible. If Swagger blocks embedding, try opening it in a new tab.
Can I add multiple links to one issue?
Yes, you can add multiple Swagger links to each Jira issue.
How secure are my Swagger links?
All links and related metadata are stored within Atlassian's Forge platform. Our app data is stored using Forge's hosted storage solutions, which are integrated into Atlassian's cloud infrastructure. This setup ensures that app data benefits from the same data residency features as Atlassian's core products, allowing administrators to control where the data is hosted.
Support
Support and Contact
Overview:
Appvibe Swagger Integration is designed to simplify your workflow by integrating Swagger designs directly into your Jira environment. This allows for a smooth workflow where your team can maintain focus on their tasks without the need to toggle between different tools. The integration ensures that your Swagger designs are easily accessible and manageable from within Jira.
Support Contact:
For additional support, please reach out to your Jira administrator. Alternatively, you can visit our Support Page at https://www.appvibe.com/support for further assistance.