Api-blueprint: توسيع هياكل البيانات

مرحبًا ، لدي سؤال / اقتراح حول هياكل البيانات. ربما يكون هذا أكثر ارتباطًا بـ MSON ولكن سأبدأ هنا. للحفاظ على هياكل البيانات جيدة ومرتبة ، أرغب في أقل قدر ممكن من البيانات المكررة ، لذلك سيكون من الجيد أن تتوسع هياكل البيانات في بعضها البعض.

افترض بنية البيانات التالية:

# Data Structures

## Project_Link (object) 
+ self: `https://test.api.com/projects/5` (string, required)

## Project1_Get (object)
+ type: `projects` (string, required)
+ id: `5` (string, required)
+ attributes (object, required)
    + number: `PRO-5` (string) - A readable identifier for employees to refer to projects.
+ links (Project_Link, required)

في السمة links لـ Project1_Get أعيد استخدام الكائن Project_Link الذي يعمل بشكل رائع. لكن لنفترض أنني بحاجة إلى بنية البيانات التالية أيضًا:

## Project1_Identifier (object)
+ type: `projects` (string, required)
+ id: `5` (string, required)

يوجد الآن بيانات مكررة في هياكل البيانات الخاصة بي لأن Project1_Identifier يحتوي على السمة type و id ، ولكن أيضًا السمة Project1_Get تحتوي عليها. سيكون من الرائع أن أفعل ما يلي:

# Data Structures

## Project1_Link (object) 
+ self: `https://test.api.com/projects/5` (string, required)

## Project1_Identifier (object)
+ type: `projects` (string, required)
+ id: `5` (string, required)

## Project1_Get (Project_Identifier) <--- Extend!
+ attributes (object, required)
    + number: `PRO-5` (string) - A readable identifier for employees to refer to projects.
+ links (Project1_Link, required)

في المثال التالي ، يقوم الصياغة بإرجاع الأخطاء:

FORMAT: 1A
HOST: https://test.api.com/

# Test API
Hi, welcome to the API!

# Group Projects
Wow, we are using projects!

### Retrieve single project [GET /projects/{id}]
+ Parameters
    + id: `5` (string, required)

+ Response 200 (application/json)
    + Attributes (object)
        + data (Project1_Get, required)

# Data Structures

## Project_Link (object) 
+ self: `https://test.api.com/projects/5` (string, required)

## Project_Identifier (object)
+ type: `projects` (string, required)
+ id: `5` (string, required)

## Project1_Get (Project_Identifier)
+ type: `projects` (string, required)
+ id: `5` (string, required)
+ attributes (object, required)
    + number: `PRO-5` (string) - A readable identifier for employees to refer to projects.
+ links (Project_Link, required)

user<strong i="25">@development</strong>:/srv/www/docs$ drafter -v
v2.0.0-pre.1
user<strong i="26">@development</strong>:/srv/www/docs$ drafter --validate docs.md --use-line-num

error: (4)  base type 'Project1_Get' is not defined in the document; line 16, column 11 - line 16, column 40
warning: (8)  unable to find the symbol `Project1_Get` in the list of named types; line 16, column 11 - line 16, column 40