В моем случае использования у меня есть библиотека RAML 1.0, созданная нашим отделом исследований и разработок, которая содержит определение нескольких типов данных. Эти типы данных определены общим параметризованным образом, поэтому, когда я ссылаюсь на них в 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, однако я бы предпочел избежать перезаписи сгенерированного библиотекой ресурса. Это возможно? Я уже пробовал встроенное описание и использование файла оверлея, оба из которых просто заменяют описание из библиотеки.