4.15.07.00 - Apigee Developer Services Portal Release Notes

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X.
Информация

8 сентября 2015 г. мы выпустили квартальную версию портала Apigee Edge Developer Services для частного облака.

Продукт, ранее называвшийся "Локальный портал разработчиков Apigee Edge" или "OPDK", теперь называется "Портал разработчиков Apigee Edge для частного облака".

Если у вас возникли вопросы, обратитесь в службу поддержки Apigee Edge.

Список всех примечаний к выпуску Apigee Edge приведен на странице Примечания к выпуску Apigee.

Требования Apigee Edge для портала

Если вы подключаете эту версию портала к установке Edge для частного облака, то для поддержки всех функций SmartDocs необходимо подключить ее к версии 4.15.07.00 или более поздней. Подробнее о версии 4.15.07.00 Apigee Edge для частного облака…

Новые функции

Общая доступность SmartDocs

Функция SmartDocs переходит из бета-версии в общую доступность. Обновления и новые функции:

  • Поддержка Swagger 2.0, в том числе импорт по файлу или URL, а также поддержка объектов безопасности с пользовательскими названиями.
  • Улучшения визуального дизайна в шаблонах, на основе которых создаются умные документы.
  • Улучшения удобства использования и рабочего процесса на портале для разработчиков, доступные через меню "Контент > SmartDocs" в Drupal.
  • Аутентификация с помощью специального токена теперь называется аутентификацией с помощью ключа API.
  • Объекты аутентификации "security", определенные на уровне версии.
  • Настройка аутентификации клиента на уровне шаблона. Новые версии больше не сбрасывают предварительно настроенные учетные данные клиента SmartDocs.

Подробнее о функциях рассказывается в записи в блоге.

Документацию по SmartDocs можно найти в статье Как использовать SmartDocs для документирования API.

Процесс обновления SmartDocs

Если вы уже использовали SmartDocs в бета-версии, то для доступа к новым функциям и возможностям версии с общей доступностью вам нужно обновить SmartDocs на портале разработчика.

Все страницы SmartDocs, которые уже опубликованы на вашем портале для разработчиков, будут работать и дальше, но перед тем как редактировать или публиковать изменения на существующих или новых страницах, необходимо выполнить описанные ниже действия.

Обратите внимание, что, хотя вы можете отрисовывать и публиковать SmartDocs на своем портале для разработчиков, они генерируются на основе модели API, которая находится в сервисах управления API Apigee Edge. Все изменения, внесенные в модель API в Edge, будут одинаковыми во всех средах Pantheon (по аналогии с тем, как разработчики существуют в средах Pantheon).

Как перейти с бета-версии SmartDocs на общую доступность

  1. Обновите и протестируйте версию 15.05.27 в разработочной или тестовой среде на платформе Pantheon.
  2. Создайте новую модель, чтобы заменить существующую модель API.
    • Если вы импортировали документы Swagger или WADL, импортируйте их снова в новую версию.
    • Если вы поддерживали модель API с помощью модуля SmartDocs, экспортируйте ее как JSON SmartDocs и импортируйте в новую модель, используя прикрепленный файл.
  3. Задайте свойства безопасности для версии модели. На странице Контент > SmartDocs > модель выберите Настройки безопасности.
  4. Проверьте предварительно настроенную аутентификацию на странице настроек модели (Контент > SmartDocs), нажав Настройки в столбце "Операции".
  5. Обновите все собственные шаблоны, чтобы в них использовались объекты CSS и JS версии 6, а также внесите изменения, связанные с новыми названиями объектов, например authSchemes и apiSchema. Информацию о том, как обновить шаблоны SmartDocs, можно найти в статье Как использовать SmartDocs для документирования API.
  6. Заново отрисуйте и опубликуйте измененную модель.
  7. После проверки новой документации обновите рабочий портал до версии 15.05.27.

Если вы корпоративный клиент Edge и у вас есть вопросы или проблемы, связанные с процессом обновления, отправьте электронное письмо на адрес marsh@apigee.com и cnovak@apigee.com. В остальных случаях рекомендуем обратиться к сообществу Apigee.

Исправлены ошибки

В этой версии исправлены следующие ошибки:

Идентификатор проблемы Описание
DEVSOL-487 Формат даты в разделе "Монетизация" должен настраиваться администраторами
Теперь формат даты можно настроить в разделе "Монетизация" в настройках монетизации для европейского и американского форматов.
DEVSOL-584 Параметр пути не запоминался при первом использовании
Параметр пути при совершении звонков запоминался не всегда.
DEVSOL-603 Некорректное форматирование страницы "План конфликта"
Теперь при покупке плана, который пересекается с существующим, страница отображается корректно.
DEVSOL-709 SmartDocs: параметр шаблона URL нельзя изменить после отправки запроса с пустым значением
Исправлена проблема, из-за которой параметры шаблона нельзя было изменить после отправки запроса из SmartDocs после удаления параметра шаблона в документации метода.
DEVSOL-723 Показывать понятные сообщения об ошибках при импорте SmartDocs
DEVSOL-1013 Разрешить редактировать адреса электронной почты пользователей на портале разработчика
Поле адреса электронной почты на странице редактирования профиля больше не будет отключено, и разработчики смогут изменять свои адреса электронной почты.
DEVSOL-1244 Не включайте модуль индикатора среды для версий OPDK
DEVSOL-1273 В списке модулей дважды указан "DevConnect Mint"
В разделе "Модули" дважды указан "DevConnect Mint". Теперь эта неполадка устранена.
DEVSOL-1313 Поддержка импорта файлов JSON/YAML или URL для Swagger и WADL
Теперь файлы WADL можно импортировать через URL, а файлы Swagger – загружать.
DEVSOL-1339 Изменение местоположения меню администратора SmartDocs
Теперь SmartDocs находится в меню контента, а настройки SmartDocs – в меню администратора настроек.
DEVSOL-1340 Удаление бета-версии при переходе на общедоступную версию
DEVSOL-1390

Библиотека PHP SDK Edge обновлена, чтобы устранить проблему с вызовом __toString()
Библиотека PHP SDK Edge обновлена, чтобы устранить проблему с вызовом __toString() для объекта DeveloperRatePlan, из-за чего возникала следующая ошибка:

Fatal error: Call to a member function format() on a non-object in /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php on line 221

Это ошибка, которая затрагивает только клиентов, использующих монетизацию и вызывающих метод toString() с помощью специального кода.

DEVSOL-1398 Модель SmartDocs Petstore импортируется при установке без запроса к пользователю
Теперь SmartDocs импортирует пример swagger petstore во время установки сайта (http://petstore.swagger.io/v2/swagger.json) вместо модели погоды, чтобы предоставить более полный пример использования SmartDocs.
DEVSOL-1407 Сбой Cron при большом количестве разработчиков
При запуске Drupal cron большое количество разработчиков может привести к превышению времени ожидания. Если в организации более 200 пользователей, теперь используется пакетная обработка.
DEVSOL-1410 Ошибки подключения не отображаются при установке портала разработчика
Добавлены более понятные сообщения об ошибках в установщик, когда подключение к управлению Edge не работает, чтобы минимизировать проблемы с устранением неполадок.
DEVSOL-1422 Удаление формы конфигурации SMTP из профиля Apigee
В процессе установки больше не будет задаваться вопрос о том, хотите ли вы настроить SMTP. Вместо этого вы можете сделать это после завершения установки, следуя стандартной процедуре Drupal: включить модуль SMTP и правильно его настроить.
DEVSOL-1427

Добавлены хуки в модуль приложений для разработчиков Devconnect, позволяющие изменять данные аналитики
Модуль devconnect_developer_apps теперь предоставляет три новых хука:

# hook_devconnect_developer_apps_analytics_chart_data_alter()

# hook_devconnect_developer_app_analytics_datapoints_params_alter()

# hook_devconnect_developer_app_analytics_datapoints_alter()

Они позволяют изменять диаграмму аналитики приложений для разработчиков с помощью специальных модулей.

DEVSOL-1464 Критическая ошибка при сохранении настроек аутентификации для модели
Теперь при удалении схемы безопасности можно установить флажок, чтобы также удалить связанную с ней схему аутентификации шаблона.
DEVSOL-1470 Создание ссылки на меню "API" и соответствующего представления
Теперь в Dev Portal SmartDocs по умолчанию есть ссылка на документацию SmartDocs в главном меню под названием "API". Она ведет на любые модели с опубликованными методами.
DEVSOL-1486 Для вызовов SmartDocs можно выполнять аутентификацию с помощью заданного ключа
Включает аутентификацию с помощью как предварительно предоставленных, так и пользовательских ключей API.
DEVSOL-1499 HTML-код не обрабатывается в описаниях параметров SmartDocs
Теперь HTML-код обрабатывается в описаниях параметров SmartDocs.
DEVSOL-1507 Невозможно добавить несколько параметров в API с помощью метода Add Method
Теперь при редактировании метода в SmartDocs API можно добавить несколько параметров.
DEVSOL-1509 Не удается изменить поле "Пример" для API SmartDocs
Теперь при редактировании страницы SmartDocs можно задать значения для полей "MIME-тип тела", "Документация тела" и "Пример тела".
DEVSOL-1534 Тип контента не заполняется в выходных данных SmartDocs
Теперь тип контента заполняется на странице метода SmartDocs.
DEVSOL-1554 Некорректное сравнение дат в монетизации
На вкладке "Приобретенный план" на порталах разработчиков с включенной монетизацией кнопка "Отменить" никогда не показывалась для плана с будущей датой начала.
DEVSOL-1556 Отправляется старая версия модулей Drupal
Модули media_youtube и features обновлены до последней версии.
DEVSOL-1558 Страницы методов SmartDocs не отображаются для примера PetStore
При новых установках примеры методов SmartDocs PetStore теперь отображаются корректно.
DEVSOL-1562 Создание представления для каждой модели SmartDocs
При создании новой модели для нее по умолчанию создается новое представление.
DEVSOL-1565 При редактировании метода SmartDocs возникает критическая ошибка
Исправлена проблема, из-за которой при редактировании метода SmartDocs иногда возникала ошибка.
DEVSOL-1567 В верхнем меню администратора показывается пункт"Добавить модель"
Исправлена проблема, из-за которой в верхнем меню администратора показывался пункт "Добавить модель".
DEVSOL-1576 В документации API показывается название модели, а не отображаемое название
На странице документации API, которая открывается при нажатии "API" в меню, показывалось внутреннее название модели, а не отображаемое название. Если вы обновили версию и изменили представление, вам нужно будет вернуться к нему, чтобы увидеть изменения. Для этого выполните следующие действия: # Войдите в систему как администратор. # Перейдите в раздел Structure > Views (Структура > Представления). # Нажмите на раскрывающееся меню рядом с пунктом Edit (Изменить) в разделе SmartDocs Models (Модели SmartDocs), чтобы увидеть все операции. # Если вы видите "revert", значит вы перезаписали код своими изменениями. Нажмите "Вернуть", чтобы восстановить представление по умолчанию. Обратите внимание, что при этом будут удалены все изменения, внесенные в представление.
DEVSOL-1578 Отображение моделей "Погода" и "Зоомагазин" на установленных сайтах
Модели SmartDocs "Зоомагазин" и "Погода" импортируются на новые сайты.
DEVSOL-1584 Нельзя приобрести планы
Исправлена проблема, из-за которой форма покупки планов монетизации не отправлялась для облачной версии 15.05.27.00 и 15.06.08.00, если вы использовали адаптивную тему Apigee или ее дочернюю тему.
DEVSOL-1597 Невозможно изменить настройки времени ожидания разработчика
Исправлена ошибка, из-за которой настройки времени ожидания подключения Edge применялись неправильно.
DEVSOL-1620

Обновления модуля "Я", индикатора среды и модуля функций
Обновление модуля "Я" с умеренно критическими исправлениями безопасности и обновления модулей индикатора среды и функций. Подробнее:

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

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

DEVSOL-1648 Убедитесь, что для параметра arg_separator.output задано значение "&", чтобы избежать проблем с reCAPTCHA
Исправлена проблема с платформой, из-за которой не работала Google reCAPTCHA.
DEVSOL-1651 Базовая тема Apigee не работает, если модуль SmartDocs отключен
Теперь базовая тема Apigee не зависит от того, включен ли модуль SmartDocs.
DEVSOL-1654

Увеличена версия admin_views, чтобы применить важное исправление системы безопасности
Обновлены следующие модули contrib:

  • Административные представления
  • Перенести
  • Переадресация
  • Redis
  • Массовые операции с представлениями