{"key":"net.oharagroup.confluence.plugins.confluence-open-api","name":"Open API (Swagger) Documentation for Confluence","description":"Generate beautiful documentation for your Open API (Swagger) compliant JSON definitions.","baseUrl":"https://confluence-open-api.oharagroup.net","enableLicensing":true,"vendor":{"name":"O'Hara Group","url":"https://oharagroup.bitbucket.io/confluence-open-api/"},"lifecycle":{"installed":"/installed"},"authentication":{"type":"jwt"},"apiMigrations":{"gdpr":true,"context-qsh":true,"signed-install":true},"scopes":["READ"],"modules":{"dynamicContentMacros":[{"key":"open-api","name":{"value":"Open API (Swagger) Documentation"},"cacheable":true,"url":"/open-api","aliases":["swagger"],"bodyType":"plain-text","categories":["development","external-content","reporting","visuals"],"description":{"value":"Generate documentation from an Open API-compliant definition"},"documentation":{"url":"https://oharagroup.bitbucket.io/confluence-open-api/","title":"Macro Documentation","altText":"Open API Macro Documentation"},"editor":{"url":"/open-api-editor","cacheable":true,"editTitle":{"value":"Edit Open API Documentation for Confluence Macro"},"insertTitle":{"value":"Insert Open API Documentation for Confluence Macro"}},"featured":true,"icon":{"url":"/images/open-api-icon.png","width":80,"height":80},"outputType":"block","parameters":[{"identifier":"url","name":{"value":"URL"},"description":{"value":"Use the JSON API definition at this location"},"type":"string","required":false},{"identifier":"showUrl","name":{"value":"Link to URL"},"description":{"value":"Include a link to the above URL in the documentation"},"type":"boolean","defaultValue":"true"},{"identifier":"userName","name":{"value":"Username"},"type":"string","required":false},{"identifier":"password","name":{"value":"Password"},"description":{"value":"Optional credentials for accessing the above URL.<br/><br/><span style=''color:red;font-weight:bold;''><span class=''aui-icon aui-icon-small aui-icon-warning''>Warning</span> WARNING</span>: Please refer to the <a href=''https://oharagroup.bitbucket.io/confluence-open-api/#secureurl''>documentation</a> before entering credentials above.<br/><br/>Credentials entered here will be <b>accessible to the browser</b>.<br/><br/>Anyone with view access to the Confluence page can see these credentials in the source HTML."},"type":"string","required":false},{"identifier":"gitHubToken","name":{"value":"GitHub Access Token"},"description":{"value":"Optional access token for accessing a private GitHub URL"},"type":"string","required":false},{"identifier":"gitLabToken","name":{"value":"GitLab Access Token"},"description":{"value":"Optional access token for accessing a private GitLab URL.<br/><br/><span style=''color:red;font-weight:bold;''><span class=''aui-icon aui-icon-small aui-icon-warning''>Warning</span> WARNING</span>: Please refer to the <a href=''https://oharagroup.bitbucket.io/confluence-open-api/#git''>documentation</a> before entering a GitHub or GitLab Access Token above.<br/><br/>Access tokens entered here will be <b>accessible to the browser</b>.<br/><br/>Anyone with view access to the Confluence page can see the token in the source HTML."},"type":"string","required":false},{"identifier":"docExpansion","name":{"value":"Expand"},"description":{"value":"Start collapsed (none), expand operations (list), expand operations and details (full)"},"type":"enum","defaultValue":"list","values":["none","list","full"]},{"identifier":"tagsSorter","name":{"value":"Sort tags by"},"description":{"value":"Definition order (default), name (alpha)"},"type":"enum","defaultValue":"default","values":["default","alpha"]},{"identifier":"operationsSorter","name":{"value":"Sort operations by"},"description":{"value":"Definition order (default), path (alpha), HTTP method (method)"},"type":"enum","defaultValue":"default","values":["default","alpha","method"]},{"identifier":"defaultModelRendering","name":{"value":"Show models as"},"description":{"value":"Example JSON (example), JSON schema (model)"},"type":"enum","defaultValue":"example","values":["example","model"]},{"identifier":"filter","name":{"value":"Filter by tag"},"description":{"value":"Show only this tag. To disable filtering, enter 'none'."},"type":"string","required":false},{"identifier":"maxDisplayedTags","name":{"value":"Limit number of tags displayed"},"description":{"value":"Show at most this many tags"},"type":"string","defaultValue":"50"},{"identifier":"tryItOutEnabled","name":{"value":"Start in Try it out mode"},"description":{"value":"Automatically toggles Try it out mode for every operation"},"type":"boolean","defaultValue":"false"},{"identifier":"supportedSubmitMethods","name":{"value":"Supported Try it out! methods"},"description":{"value":"List the operations allowed in Try it out!, separated by commas. To disable Try it out! completely, enter 'none'."},"type":"string","defaultValue":"get, post, put, delete, head, options, patch, trace"},{"identifier":"displayOperationId","name":{"value":"Show operation ID"},"description":{"value":"Show the ID of operations in the list"},"type":"boolean","defaultValue":"false"},{"identifier":"displayRequestDuration","name":{"value":"Show request duration"},"description":{"value":"Show the duration of Try it out requests"},"type":"boolean","defaultValue":"false"},{"identifier":"showExtensions","name":{"value":"Show vendor extensions"},"description":{"value":"Show 'x-' fields and values for Operations/Parameters/Schema"},"type":"boolean","defaultValue":"false"},{"identifier":"showCommonExtensions","name":{"value":"Show parameter restrictions"},"description":{"value":"Show restrictions (pattern, maxLength, minLength, maximum, minimum) for path/query/header parameter values"},"type":"boolean","defaultValue":"false"},{"identifier":"showDownloadButton","name":{"value":"Show download button"},"description":{"value":"Show a &quot;Download API Definition&quot; button for saving JSON/YAML from the macro body"},"type":"boolean","defaultValue":"false"},{"identifier":"syntaxHighlightTheme","name":{"value":"Syntax highlight theme"},"description":{"value":"Theme for request and response examples"},"type":"enum","defaultValue":"agate","values":["agate","arta","idea","monokai","nord","obsidian","tomorrow-night"]}],"renderModes":{"default":{"url":"/open-api-static"}}}],"configurePage":{"key":"open-api-admin","url":"/open-api-admin","name":{"value":"Open API (Swagger) Documentation for Confluence Configuration"},"conditions":[{"condition":"user_is_logged_in"},{"condition":"user_is_admin"}]}}}