Skip to content

Commit e1ebda8

Browse files
dgaetanickpape-msft
dgaeta
authored and
nickpape-msft
committed
Update to json schema to reflect API definition reference feature (microsoft#63)
* Adding member options to json schema for a 'code' linkDocItem * Adding change file * Spacing cleanup
1 parent f7442b3 commit e1ebda8

2 files changed

Lines changed: 27 additions & 1 deletion

File tree

‎api-extractor/src/schemas/api-json-schema.json‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,26 @@
5050
"value": {
5151
"description": "An optional display name to show for a link",
5252
"type": "string"
53+
},
54+
"memberName": {
55+
"description": "An optional name that specifies the export item",
56+
"type": "string"
57+
},
58+
"exportName": {
59+
"description": "A name that is required if the referenceType is code",
60+
"type": "string"
61+
},
62+
"packageName": {
63+
"description": "An optional name of the package where an export is located",
64+
"type": "string"
65+
},
66+
"scopeName": {
67+
"description": "An optional name that scopes the package name",
68+
"type": "string"
5369
}
5470
},
5571
"additionalProperties": false,
56-
"required": [ "kind", "referenceType", "targetUrl" ]
72+
"required": [ "kind", "referenceType" ]
5773
},
5874

5975
//---------------------------------------------------------------------------------------------

‎common/changes/dagaeta-update-to-json-schema_2017-01-23-23-18.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@microsoft/api-extractor",
5+
"comment": "Json schema was updated to reflect feature additions to linkDocElement. The linkDocElement can now be of type 'code' which refers to an API definition reference.",
6+
"type": "patch"
7+
}
8+
],
9+
"email": "dgaeta@users.noreply.github.com"
10+
}

0 commit comments

Comments
 (0)