В моем случае у меня есть библиотека RAML 1.0, созданная нашим отделом исследований и разработок, которая содержит определение нескольких типов данных. Эти типы данных определены в обобщенном c параметризованном виде, поэтому, когда я ссылаюсь на них в моем RAML, я делаю это, используя следующий синтаксис:
type: { resourceTypes.collectionWithCriteria: {itemName: reward, itemCriteria: types.RewardCriteria, itemType : types.RewardList} }
Это генерирует правильный запрос GET со строкой запроса, определенной types.RewardCriteria
и ответ определяется types.RewardList
. Он также генерирует описание для ресурса GET, определенного как: Retrieves the list of <<itemName | !pluralize>>
, что в итоге равно Retrieves the list of rewards
.
В моем RAML я хотел бы добавить дополнительное описание к моему ресурсу GET, однако я бы предпочел избегать перезаписи сгенерированной библиотекой Это возможно? Я уже пробовал встроенное описание и использовал оверлейный файл, оба из которых просто заменяют описание из библиотеки.