Mintlify (Independent Publisher) (#1400)
* certify-connector HubSpot CRM, CMS, and Marketing connectors * certify-connector Xero Accounting and Payroll connectors * Revert "certify-connector" This reverts commit5fb06db7f3. * Revert "certify-connector" This reverts commit160b208ed6. * certify-connector * certify-connector * certify-connector * Update apiDefinition.swagger.json Fixed description * Update apiDefinition.swagger.json Cut to below 500 * Update apiDefinition.swagger.json Cut to below 500. * Delete icon.png * Delete settings.json * Update apiDefinition.swagger.json * Delete independent-publisher-connectors/HubSpot CMS directory * Delete independent-publisher-connectors/HubSpot CRM directory * Delete independent-publisher-connectors/HubSpot Marketing directory * Delete independent-publisher-connectors/Xero Accounting directory * Delete independent-publisher-connectors/Xero Payroll - UK directory * Delete independent-publisher-connectors/Xero Projects directory * Include iconBrandColor #da3b01 for IP * Include iconBrandColor #da3b01 in best practices * Rename README.template.md to readme.md * Add templates for IP * Fix typo * Add files via upload * Delete Google Cloud Translation directory * Add files via upload
This commit is contained in:
Troy Taylor
GitHub
Родитель
ecbc49ac9a
Коммит
36811be988
|
|
@ -0,0 +1,198 @@
|
|||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "Mintlify",
|
||||
"description": "Hate writing code documentation? Save time and improve your codebase by letting Mintlify generate documentation for you.",
|
||||
"version": "1.0",
|
||||
"contact": {
|
||||
"name": "Troy Taylor",
|
||||
"url": "https://www.hitachisolutions.com",
|
||||
"email": "ttaylor@hitachisolutions.com"
|
||||
}
|
||||
},
|
||||
"host": "api.mintlify.com",
|
||||
"basePath": "/",
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"consumes": ["application/json"],
|
||||
"produces": ["application/json"],
|
||||
"paths": {
|
||||
"/v1/document": {
|
||||
"post": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"documentation": {
|
||||
"type": "string",
|
||||
"description": "The documentation.",
|
||||
"title": "Documentation"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Generate documentation",
|
||||
"description": "Returns a documentation string based on the code submitted.",
|
||||
"operationId": "DocGen",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"commented": {
|
||||
"type": "boolean",
|
||||
"description": "Whether or not to comment the documentation output.",
|
||||
"title": "Commented",
|
||||
"default": true,
|
||||
"enum": [
|
||||
true,
|
||||
false
|
||||
]
|
||||
},
|
||||
"language": {
|
||||
"type": "string",
|
||||
"description": "The programming language of the code.",
|
||||
"title": "Language",
|
||||
"default": "javascript",
|
||||
"enum": [
|
||||
"javascript",
|
||||
"typescript",
|
||||
"javascriptreact",
|
||||
"typescriptreact",
|
||||
"python",
|
||||
"php"
|
||||
]
|
||||
},
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "The code to generate documentation for.",
|
||||
"title": "Code"
|
||||
},
|
||||
"format": {
|
||||
"type": "string",
|
||||
"description": "The format of the documentation. Only works if commented is true.",
|
||||
"title": "Format",
|
||||
"enum": [
|
||||
"",
|
||||
"JSDoc",
|
||||
"reST",
|
||||
"DocBlock",
|
||||
"Google"
|
||||
]
|
||||
},
|
||||
"context": {
|
||||
"type": "string",
|
||||
"description": "Only use if code needs more context (e.g. method in a class)",
|
||||
"title": "Context"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"code",
|
||||
"language"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/list/languages": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"languages": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "The list of languages.",
|
||||
"title": "Languages"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "List languages",
|
||||
"description": "Retrieve a list of languages supported.",
|
||||
"operationId": "LanguageList",
|
||||
"parameters": []
|
||||
}
|
||||
},
|
||||
"/v1/list/formats": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"formats": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The unique identifier.",
|
||||
"title": "ID"
|
||||
},
|
||||
"defaultLanguages": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "The list of default languages.",
|
||||
"title": "Default Languages"
|
||||
}
|
||||
}
|
||||
},
|
||||
"title": "Formats"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "List documentation formats",
|
||||
"parameters": [],
|
||||
"description": "Retrieve a list of documentation formats supported.",
|
||||
"operationId": "DocList"
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {},
|
||||
"parameters": {},
|
||||
"responses": {},
|
||||
"securityDefinitions": {
|
||||
"api_key": {
|
||||
"type": "apiKey",
|
||||
"in": "header",
|
||||
"name": "API-KEY"
|
||||
}
|
||||
},
|
||||
"security": [],
|
||||
"tags": [],
|
||||
"x-ms-connector-metadata": [
|
||||
{
|
||||
"propertyName": "Website",
|
||||
"propertyValue": "https://www.mintlify.com/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Privacy policy",
|
||||
"propertyValue": "https://www.mintlify.com/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Categories",
|
||||
"propertyValue": "IT Operations;AI"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
{
|
||||
"properties": {
|
||||
"connectionParameters": {
|
||||
"api_key": {
|
||||
"type": "securestring",
|
||||
"uiDefinition": {
|
||||
"displayName": "API Key",
|
||||
"description": "The API Key for this api",
|
||||
"tooltip": "Provide your API Key",
|
||||
"constraints": {
|
||||
"tabIndex": 2,
|
||||
"clearText": false,
|
||||
"required": "true"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"iconBrandColor": "#da3b01",
|
||||
"capabilities": [],
|
||||
"publisher": "Troy Taylor",
|
||||
"stackOwner": "Mintlify"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
# Mintlify
|
||||
Hate writing code documentation? Save time and improve your codebase by letting Mintlify generate documentation for you.
|
||||
|
||||
## Publisher: Troy Taylor, Hitachi Solutions
|
||||
|
||||
## Prerequisites
|
||||
This API requires an API key to use.
|
||||
|
||||
## Obtaining Credentials
|
||||
To receive an API key, fill out the form on the [Quickstart page](https://docs.mintlify.com/reference/start).
|
||||
|
||||
## Supported Operations
|
||||
### Generate documentation
|
||||
Returns a documentation string based on the code submitted.
|
||||
### List languages
|
||||
Retrieve a list of languages supported.
|
||||
### List documentation formats
|
||||
Retrieve a list of documentation formats supported.
|
||||
|
||||
## Known Issues and Limitations
|
||||
There are no known issues at this time.
|
||||
Загрузка…
Ссылка в новой задаче