Mintlify (Editora Independente) (Pré-visualização)
Odeia escrever documentação de código? Economize tempo e melhore sua base de código permitindo que o Mintlify gere documentação para você.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troia Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Editora | Troia Taylor |
| Sítio Web | https://www.mintlify.com/ |
| Política de privacidade | https://www.mintlify.com/ |
| Categorias | Operações de TI; IA |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | securestring | A chave de API para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Gerar documentação |
Retorna uma cadeia de caracteres de documentação com base no código enviado. |
| Listar formatos de documentação |
Recupere uma lista de formatos de documentação suportados. |
| Listar idiomas |
Recupere uma lista de idiomas suportados. |
Gerar documentação
Retorna uma cadeia de caracteres de documentação com base no código enviado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Comentado
|
commented | boolean |
Comentar ou não a saída da documentação. |
|
|
Linguagem
|
language | True | string |
A linguagem de programação do código. |
|
Código
|
code | True | string |
O código para o qual gerar documentação. |
|
Formato
|
format | string |
O formato da documentação. Só funciona se comentado for verdade. |
|
|
Context
|
context | string |
Use apenas se o código precisar de mais contexto (por exemplo, método em uma classe) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentation
|
documentation | string |
A documentação. |
Listar formatos de documentação
Recupere uma lista de formatos de documentação suportados.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Formats
|
formats | array of object | |
|
ID
|
formats.id | string |
O identificador único. |
|
Idiomas padrão
|
formats.defaultLanguages | array of string |
A lista de idiomas padrão. |
Listar idiomas
Recupere uma lista de idiomas suportados.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Languages
|
languages | array of string |
A lista de línguas. |