4.15.07.00 – Notas da versão do Portal de serviços para desenvolvedores da Apigee

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
info

Na terça-feira, 8 de setembro de 2015, lançamos uma versão trimestral do portal de serviços para desenvolvedores do Apigee Edge para nuvem privada.

O nome anterior do produto "Portal de serviços para desenvolvedores do Apigee Edge On-premises" ou "OPDK" agora é "Portal de serviços para desenvolvedores do Apigee Edge para nuvem privada".

Se você tiver dúvidas, entre em contato com o suporte do Apigee Edge.

Para uma lista de todas as notas da versão do Apigee Edge, consulte Notas da versão da Apigee.

Requisitos do Apigee Edge para o portal

Se você estiver conectando esta versão do portal a uma instalação do Edge para nuvem privada, conecte-a à versão 4.15.07.00 ou mais recente para garantir que todos os recursos do SmartDocs sejam compatíveis. Consulte 4.15.07.00 - Notas da versão do Apigee Edge para nuvem privada para mais informações.

Novos recursos

Disponibilidade geral do SmartDocs

Os SmartDocs estão saindo da versão Beta para a disponibilidade geral. As atualizações e os novos recursos incluem:

  • Suporte para Swagger 2.0, incluindo importação por arquivo ou URL, além de suporte para objetos de segurança com nomes personalizados.
  • Melhorias no design visual dos modelos que geram o SmartDocs.
  • Melhorias na usabilidade e no fluxo de trabalho no portal do desenvolvedor, disponíveis no menu Conteúdo > SmartDocs no Drupal.
  • O que era conhecido como autenticação "Custom Token" agora é chamado de "API Key".
  • Objetos de "segurança" de autenticação definidos no nível da revisão.
  • Configuração da autenticação do cliente no nível do modelo. As novas revisões não redefinem mais as credenciais de cliente do SmartDocs pré-configuradas.

Para mais descrições de recursos, consulte esta postagem do blog.

Para conferir a documentação do SmartDocs, consulte Usar o SmartDocs para documentar APIs.

Processo de upgrade do SmartDocs

Se você já usava o SmartDocs durante o período Beta, os novos recursos e funcionalidades da versão de disponibilidade geral exigem que você faça upgrade do SmartDocs no portal do desenvolvedor.

As páginas do SmartDocs já publicadas no portal do desenvolvedor vão continuar funcionando, mas você precisa seguir o processo de atualização antes de editar ou publicar mudanças em páginas novas ou atuais.

Embora seja possível renderizar e publicar o SmartDocs no portal de desenvolvedores, ele é gerado com base no modelo de API que fica nos serviços de gerenciamento de API do Edge da Apigee. Todas as mudanças feitas em um modelo de API no Edge serão as mesmas em todos os ambientes do Pantheon, assim como os desenvolvedores.

Para fazer upgrade da versão Beta do SmartDocs para a disponibilidade geral

  1. Atualize e teste a versão 15.05.27 nos ambientes dev ou test no Pantheon.
  2. Crie um modelo para substituir qualquer modelo de API que você esteja usando.
    • Se você estava importando documentos Swagger ou WADL, importe-os novamente para uma nova revisão.
    • Se você estiver mantendo seu modelo de API pelo módulo SmartDocs, exporte como JSON do SmartDocs e importe para o novo modelo usando o anexo de arquivo.
  3. Defina as propriedades de segurança da revisão do seu modelo. Na página Conteúdo > SmartDocs > modelo, selecione Configurações de segurança.
  4. Verifique qualquer autenticação pré-configurada na página de configurações do modelo (Conteúdo > SmartDocs) clicando em Configurações na coluna "Operações".
  5. Atualize todos os modelos personalizados para usar a v6 dos recursos de CSS e JS e faça mudanças para refletir todos os novos nomes de objetos, como authSchemes e apiSchema. Para informações sobre como atualizar modelos do SmartDocs, consulte Usar o SmartDocs para documentar APIs.
  6. Renderize e publique novamente a revisão do modelo.
  7. Depois de validar a nova documentação, atualize seu portal de produção para a versão 15.05.27.

Se você for um cliente corporativo do Edge e tiver dúvidas ou preocupações sobre o processo de upgrade, envie um e-mail para marsh@apigee.com e cnovak@apigee.com. Caso contrário, use a Comunidade da Apigee para receber a melhor resposta.

Bugs corrigidos

Os bugs abaixo foram corrigidos nesta versão.

ID do problema Descrição
DEVSOL-487 O formato de dia na Monetização precisa ser configurável pelos administradores
Agora, o formato de data pode ser configurado na Monetização em "Configurações de monetização" para formatos de data europeus e dos EUA.
DEVSOL-584 Parâmetro de caminho não lembrado no primeiro uso
O parâmetro de caminho ao fazer chamadas nem sempre era lembrado.
DEVSOL-603 A página "Plano em conflito" está mal formatada
Ao comprar um plano que se sobrepõe a um plano existente, a página mostrada agora está formatada de maneira adequada para o usuário.
DEVSOL-709 SmartDocs: o parâmetro de modelo de URL não pode ser editado depois de enviar uma solicitação com valor vazio
Corrige o problema que impede a edição dos parâmetros de modelo depois de enviar a solicitação do SmartDocs após excluir o parâmetro de modelo na documentação do método.
DEVSOL-723 Mostrar mensagens fáceis de entender em caso de falha na importação do SmartDocs
DEVSOL-1013 Tornar os endereços de e-mail dos usuários do Dev Portal editáveis
O campo de endereço de e-mail na página de edição de perfil não será mais desativado e os desenvolvedores poderão mudar os endereços de e-mail.
DEVSOL-1244 Não ative o módulo Indicador de ambiente para versões do OPDK
DEVSOL-1273 "DevConnect Mint" aparece duas vezes na lista de módulos
Em "Módulos", "Dev Connect Mint" aparecia duas vezes. Isso já foi corrigido
DEVSOL-1313 Importação de arquivos JSON/YAML ou URLs para Swagger e WADL
Agora é possível importar arquivos WADL por URL e fazer upload de arquivos Swagger.
DEVSOL-1339 Mudar os locais do menu de administrador do SmartDocs
Agora o SmartDocs está no menu de conteúdo, e as configurações dele estão no menu de administrador de configurações.
DEVSOL-1340 Remover a versão Beta ao lançar a versão GA
DEVSOL-1390

A biblioteca do SDK do PHP Edge foi atualizada para corrigir o problema de chamar __toString()
A biblioteca do SDK do PHP Edge foi atualizada para corrigir o problema de chamar __toString() no objeto DeveloperRatePlan, que cria este erro:

Erro fatal: chamada para uma função membro format() em um não objeto em /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php na linha 221

Esse é um bug que afeta apenas clientes da Monetização com código personalizado que chama o método toString().

DEVSOL-1398 Modelo da Petstore do SmartDocs importado na instalação sem solicitar ao usuário
Agora, o SmartDocs importa o exemplo do Swagger da petstore durante a instalação do site (http://petstore.swagger.io/v2/swagger.json) em vez do modelo de clima para ter um exemplo mais completo de uso do SmartDocs.
DEVSOL-1407 Falha do Cron quando há muitos desenvolvedores
Ao executar o cron do Drupal, um grande número de desenvolvedores causava um problema de tempo limite. Quando uma organização tem mais de 200 usuários, agora é usado um processo em lote.
DEVSOL-1410 Erros de conexão não aparentes ao instalar o Portal do desenvolvedor
Adicionamos mensagens de erro melhores ao instalador quando a conexão de gerenciamento do Edge não está funcionando para minimizar problemas de solução de problemas.
DEVSOL-1422 Remover o formulário de configuração do SMTP do perfil do Apigee
O processo de instalação não pergunta mais se você quer configurar o SMTP. Em vez disso, isso pode ser feito após a conclusão da instalação, seguindo a prática padrão do Drupal de ativar o módulo SMTP e configurá-lo corretamente.
DEVSOL-1427

Adicionar hooks ao módulo de apps para desenvolvedores do Devconnect para permitir a alteração dos dados de análise
O módulo devconnect_developer_apps agora oferece três novos hooks:

# hook_devconnect_developer_apps_analytics_chart_data_alter()

# hook_devconnect_developer_app_analytics_datapoints_params_alter()

# hook_devconnect_developer_app_analytics_datapoints_alter()

Eles permitem que módulos personalizados alterem o gráfico de análise do app de desenvolvedor.

DEVSOL-1464 Erro fatal ao salvar as configurações de autenticação de um modelo
Quando um esquema de segurança é excluído, agora há uma caixa de seleção para escolher se o esquema de autenticação de modelo associado também precisa ser excluído.
DEVSOL-1470 Criar o link do menu "APIs" e a visualização correspondente
O SmartDocs do portal do desenvolvedor agora vem por padrão com um link para a documentação renderizada do SmartDocs no menu principal chamado "APIs", que se vincula a todos os modelos com métodos publicados.
DEVSOL-1486 As chamadas do SmartDocs podem ser autenticadas com uma chave predefinida
Permite a autenticação com chaves de API pré-fornecidas e fornecidas pelo usuário.
DEVSOL-1499 O código HTML não é analisado nas descrições de parâmetros do SmartDocs
Agora, o código HTML é analisado nas descrições de parâmetros do SmartDocs.
DEVSOL-1507 Não é possível adicionar vários parâmetros a uma API com o método "Adicionar"
Agora é possível adicionar vários parâmetros a uma API SmartDocs ao editar o método.
DEVSOL-1509 Não consegue editar o campo "exemplo" de uma API SmartDocs
Agora é possível definir "Tipo MIME do corpo", "Documentação do corpo" e "Exemplo do corpo" ao editar uma página do SmartDocs.
DEVSOL-1534 O tipo de conteúdo não está sendo preenchido na saída do SmartDocs
Agora, o tipo de conteúdo está sendo preenchido na página do método do SmartDocs.
DEVSOL-1554 Comparação de datas inválida na monetização
Na guia "Plano comprado" dos portais de desenvolvedores ativados para monetização, o botão "Cancelar" nunca foi exibido para um plano com uma data de início futura.
DEVSOL-1556 Versão antiga dos módulos do Drupal sendo enviada
Os módulos media_youtube e features foram atualizados para a versão mais recente.
DEVSOL-1558 As páginas de métodos do SmartDocs não estão sendo renderizadas para o exemplo da PetStore
Em novas instalações, os métodos de exemplo da PetStore do SmartDocs agora são renderizados corretamente.
DEVSOL-1562 Gerar uma visualização para cada modelo do SmartDocs
Ao criar um modelo, uma visualização é criada por padrão para ele.
DEVSOL-1565 A edição do método SmartDocs gera um erro fatal
Correção de um problema em que a edição de um método do SmartDocs às vezes gerava um erro.
DEVSOL-1567 "Adicionar modelo" sendo exibido no menu de administrador superior
Corrigimos o problema em que o item de menu "Adicionar modelo" era exibido no menu de administrador superior.
DEVSOL-1576 A visualização da documentação da API mostra o nome do modelo, não o nome de exibição
A página de documentação da API que aparece ao clicar em "APIs" no menu mostrava o nome interno do modelo em vez do nome de exibição. Se você estiver atualizando para a versão e tiver mudado essa visualização, será necessário reverter a visualização para conferir essas mudanças. Siga estas etapas: # Faça login como administrador # Acesse Estrutura > Visualizações # Clique no menu suspenso ao lado de "Editar" em "Modelos do SmartDocs" para conferir todas as operações. # Se você vir "revert", significa que você substituiu o código com sua própria mudança. Clique em "Reverter" para colocar a visualização de volta no estado padrão. Isso vai remover todas as mudanças feitas nessa visualização.
DEVSOL-1578 Renderize os modelos de clima e Petstore em instalações no site
Os modelos do SmartDocs Petstore e clima são importados em novos sites.
DEVSOL-1584 Não é possível comprar planos
Foi corrigido um problema em que o formulário de compra de planos de monetização não era enviado para o lançamento na nuvem 15.05.27.00 e 15.06.08.00 se você estivesse usando o tema responsivo da Apigee ou um subtema dele.
DEVSOL-1597 Não é possível mudar as configurações de tempo limite do desenvolvedor
Corrigimos um bug em que as configurações de tempo limite de conexão do Edge não eram aplicadas corretamente.
DEVSOL-1620

Eu, indicador de ambiente e upgrades do módulo de recursos
Atualização de segurança moderadamente crítica para o módulo "Eu" e atualizações de módulo para o indicador de ambiente e recursos. Mais informações:

https://www.drupal.org/project/me https://www.drupal.org/project/environment_indicator

https://www.drupal.org/project/features

DEVSOL-1648 Verifique se arg_separator.output é "&" para evitar falhas no reCAPTCHA
Um problema relacionado à plataforma em que o uso do Google reCAPTCHA foi interrompido foi corrigido.
DEVSOL-1651 O tema base do Apigee falha se o módulo SmartDocs não estiver ativado
O tema apigee_base não depende mais da ativação do módulo SmartDocs.
DEVSOL-1654

Aumentar a versão do admin_views para receber uma correção de segurança crítica
Os seguintes módulos contrib foram atualizados:

  • Visualizações administrativas
  • Migrar
  • Redirecionamento
  • Redis
  • Operações em massa de visualizações