Добавление данных типа встроенных - PullRequest
0 голосов
/ 09 марта 2020

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

1 Ответ

1 голос
/ 09 марта 2020

Нельзя добавить простое свойство для одного значения.

Правила объединения для признаков / типов ресурсов указывают, что описание будет заменено:

Каждый явный узел выигрывает у тех, которые объявлены в типе ресурса или признаке. Остальные просто объединяются.

Кроме того, правила объединения наложений и расширений гласят, что:.

Если свойство является Простым свойством
Если свойство является Простым свойством с одним значением, значением свойства в одноименном свойстве объекта Текущее целевое дерево является , заменяемое его значением из свойства Текущее расширение дерева объекта.

...