Skip to content

Commit 4b56c24

Browse files
chdeskurchdeskur
authored
(chore): preserve api sections (#2667)
1 parent a8b2125 commit 4b56c24

20 files changed

+1451
-490
lines changed

‎packages/fdr-sdk/src/__test__/fixtures/demo.json

+404
Large diffs are not rendered by default.

‎packages/fdr-sdk/src/__test__/output/demo/apiDefinitionKeys-1504329f-2ebc-4695-be7a-95793adc10b8.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[
2+
"1504329f-2ebc-4695-be7a-95793adc10b8/webhoook/__package__.createPet/payload/shape",
3+
"1504329f-2ebc-4695-be7a-95793adc10b8/webhoook/__package__.createPet/payload",
4+
"1504329f-2ebc-4695-be7a-95793adc10b8/webhoook/__package__.createPet",
5+
"1504329f-2ebc-4695-be7a-95793adc10b8/type-definition/Pet/shape/object/property/id",
6+
"1504329f-2ebc-4695-be7a-95793adc10b8/type-definition/Pet/shape/object/property/name",
7+
"1504329f-2ebc-4695-be7a-95793adc10b8/type-definition/Pet/shape/object/property/tag",
8+
"1504329f-2ebc-4695-be7a-95793adc10b8/type-definition/Pet/shape/object",
9+
"1504329f-2ebc-4695-be7a-95793adc10b8/type-definition/Pet/shape",
10+
"1504329f-2ebc-4695-be7a-95793adc10b8/type-definition/Pet"
11+
]

‎packages/fdr-sdk/src/__test__/output/demo/apiDefinitionKeys-4f13fac3-9f97-4a72-9b2c-38b25024486d.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[
2+
"4f13fac3-9f97-4a72-9b2c-38b25024486d/webhoook/__package__.createPet/payload/shape",
3+
"4f13fac3-9f97-4a72-9b2c-38b25024486d/webhoook/__package__.createPet/payload",
4+
"4f13fac3-9f97-4a72-9b2c-38b25024486d/webhoook/__package__.createPet",
5+
"4f13fac3-9f97-4a72-9b2c-38b25024486d/type-definition/Pet/shape/object/property/id",
6+
"4f13fac3-9f97-4a72-9b2c-38b25024486d/type-definition/Pet/shape/object/property/name",
7+
"4f13fac3-9f97-4a72-9b2c-38b25024486d/type-definition/Pet/shape/object/property/tag",
8+
"4f13fac3-9f97-4a72-9b2c-38b25024486d/type-definition/Pet/shape/object",
9+
"4f13fac3-9f97-4a72-9b2c-38b25024486d/type-definition/Pet/shape",
10+
"4f13fac3-9f97-4a72-9b2c-38b25024486d/type-definition/Pet"
11+
]

‎packages/fdr-sdk/src/__test__/output/demo/apiDefinitionKeys-d18f1aa9-487e-443f-8604-ac65bc48f280.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[
2+
"d18f1aa9-487e-443f-8604-ac65bc48f280/webhoook/__package__.createPet/payload/shape",
3+
"d18f1aa9-487e-443f-8604-ac65bc48f280/webhoook/__package__.createPet/payload",
4+
"d18f1aa9-487e-443f-8604-ac65bc48f280/webhoook/__package__.createPet",
5+
"d18f1aa9-487e-443f-8604-ac65bc48f280/type-definition/Pet/shape/object/property/id",
6+
"d18f1aa9-487e-443f-8604-ac65bc48f280/type-definition/Pet/shape/object/property/name",
7+
"d18f1aa9-487e-443f-8604-ac65bc48f280/type-definition/Pet/shape/object/property/tag",
8+
"d18f1aa9-487e-443f-8604-ac65bc48f280/type-definition/Pet/shape/object",
9+
"d18f1aa9-487e-443f-8604-ac65bc48f280/type-definition/Pet/shape",
10+
"d18f1aa9-487e-443f-8604-ac65bc48f280/type-definition/Pet"
11+
]

‎packages/fdr-sdk/src/__test__/output/demo/apiDefinitionKeys-f14e5576-569f-4692-bdfd-5c9842956d5e.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[
2+
"f14e5576-569f-4692-bdfd-5c9842956d5e/webhoook/__package__.createPet/payload/shape",
3+
"f14e5576-569f-4692-bdfd-5c9842956d5e/webhoook/__package__.createPet/payload",
4+
"f14e5576-569f-4692-bdfd-5c9842956d5e/webhoook/__package__.createPet",
5+
"f14e5576-569f-4692-bdfd-5c9842956d5e/type-definition/Pet/shape/object/property/id",
6+
"f14e5576-569f-4692-bdfd-5c9842956d5e/type-definition/Pet/shape/object/property/name",
7+
"f14e5576-569f-4692-bdfd-5c9842956d5e/type-definition/Pet/shape/object/property/tag",
8+
"f14e5576-569f-4692-bdfd-5c9842956d5e/type-definition/Pet/shape/object",
9+
"f14e5576-569f-4692-bdfd-5c9842956d5e/type-definition/Pet/shape",
10+
"f14e5576-569f-4692-bdfd-5c9842956d5e/type-definition/Pet"
11+
]

‎packages/fdr-sdk/src/__test__/output/demo/apiDefinitions.json

+184
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
[
2+
{
3+
"id": "1504329f-2ebc-4695-be7a-95793adc10b8",
4+
"endpoints": {},
5+
"websockets": {},
6+
"webhooks": {
7+
"__package__.createPet": {
8+
"id": "__package__.createPet",
9+
"namespace": [],
10+
"displayName": "Create Pet",
11+
"operationId": "create-pet",
12+
"method": "POST",
13+
"path": [],
14+
"payloads": [
15+
{
16+
"description": "Information about a new pet in the system",
17+
"shape": {
18+
"type": "alias",
19+
"value": {
20+
"type": "id",
21+
"id": "Pet"
22+
}
23+
}
24+
}
25+
],
26+
"examples": [
27+
{
28+
"payload": {
29+
"id": 99999,
30+
"name": "string",
31+
"tag": "string"
32+
}
33+
}
34+
]
35+
}
36+
},
37+
"types": {
38+
"Pet": {
39+
"name": "Pet",
40+
"shape": {
41+
"type": "object",
42+
"extends": [],
43+
"properties": [
44+
{
45+
"key": "id",
46+
"valueShape": {
47+
"type": "alias",
48+
"value": {
49+
"type": "primitive",
50+
"value": {
51+
"type": "long"
52+
}
53+
}
54+
}
55+
},
56+
{
57+
"key": "name",
58+
"valueShape": {
59+
"type": "alias",
60+
"value": {
61+
"type": "primitive",
62+
"value": {
63+
"type": "string"
64+
}
65+
}
66+
}
67+
},
68+
{
69+
"key": "tag",
70+
"valueShape": {
71+
"type": "alias",
72+
"value": {
73+
"type": "optional",
74+
"shape": {
75+
"type": "alias",
76+
"value": {
77+
"type": "primitive",
78+
"value": {
79+
"type": "string"
80+
}
81+
}
82+
}
83+
}
84+
}
85+
}
86+
]
87+
}
88+
}
89+
},
90+
"subpackages": {},
91+
"auths": {}
92+
},
93+
{
94+
"id": "d18f1aa9-487e-443f-8604-ac65bc48f280",
95+
"endpoints": {},
96+
"websockets": {},
97+
"webhooks": {
98+
"__package__.createPet": {
99+
"id": "__package__.createPet",
100+
"namespace": [],
101+
"displayName": "Create Pet",
102+
"operationId": "create-pet",
103+
"method": "POST",
104+
"path": [],
105+
"payloads": [
106+
{
107+
"description": "Information about a new pet in the system",
108+
"shape": {
109+
"type": "alias",
110+
"value": {
111+
"type": "id",
112+
"id": "Pet"
113+
}
114+
}
115+
}
116+
],
117+
"examples": [
118+
{
119+
"payload": {
120+
"id": 99999,
121+
"name": "string",
122+
"tag": "string"
123+
}
124+
}
125+
]
126+
}
127+
},
128+
"types": {
129+
"Pet": {
130+
"name": "Pet",
131+
"shape": {
132+
"type": "object",
133+
"extends": [],
134+
"properties": [
135+
{
136+
"key": "id",
137+
"valueShape": {
138+
"type": "alias",
139+
"value": {
140+
"type": "primitive",
141+
"value": {
142+
"type": "long"
143+
}
144+
}
145+
}
146+
},
147+
{
148+
"key": "name",
149+
"valueShape": {
150+
"type": "alias",
151+
"value": {
152+
"type": "primitive",
153+
"value": {
154+
"type": "string"
155+
}
156+
}
157+
}
158+
},
159+
{
160+
"key": "tag",
161+
"valueShape": {
162+
"type": "alias",
163+
"value": {
164+
"type": "optional",
165+
"shape": {
166+
"type": "alias",
167+
"value": {
168+
"type": "primitive",
169+
"value": {
170+
"type": "string"
171+
}
172+
}
173+
}
174+
}
175+
}
176+
}
177+
]
178+
}
179+
}
180+
},
181+
"subpackages": {},
182+
"auths": {}
183+
}
184+
]

‎packages/fdr-sdk/src/__test__/output/demo/node.json

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
{
2+
"child": {
3+
"children": [
4+
{
5+
"child": {
6+
"children": [
7+
{
8+
"child": {
9+
"children": [
10+
{
11+
"children": [
12+
{
13+
"id": "98be4aef6362fdfe8d85deb74d853d72a80d02ea12b07fdb33b800ed9967fcce",
14+
"pageId": "pages/overview.mdx",
15+
"slug": "subpath/v2/api/overview",
16+
"title": "Overview",
17+
"type": "page"
18+
}
19+
],
20+
"id": "27084caa872920c04f114aa0b978f99a4894f5ef38e691eac583a0f6e85bdee2",
21+
"type": "sidebarGroup"
22+
},
23+
{
24+
"children": [
25+
{
26+
"id": "47810535e98923e0b5ad47c87f961a7a425d1d3f0078aab983c5f2f9b3a4cbbc",
27+
"pageId": "pages/apple.mdx",
28+
"slug": "subpath/v2/api/apple/overview",
29+
"title": "Overview",
30+
"type": "page"
31+
},
32+
{
33+
"apiDefinitionId": "d18f1aa9-487e-443f-8604-ac65bc48f280",
34+
"children": [
35+
{
36+
"apiDefinitionId": "d18f1aa9-487e-443f-8604-ac65bc48f280",
37+
"id": "d18f1aa9-487e-443f-8604-ac65bc48f280:__package__.createPet",
38+
"method": "POST",
39+
"slug": "subpath/v2/api/apple/webhooks-1/create-pet",
40+
"title": "Create Pet",
41+
"type": "webhook",
42+
"webhookId": "__package__.createPet"
43+
}
44+
],
45+
"hideTitle": false,
46+
"id": "8d8e4fbe630f35ef57b1000c9aea8677c6b75ccec775a16074b34ed4144cb70a",
47+
"paginated": false,
48+
"pointsTo": "subpath/v2/api/apple/webhooks-1/create-pet",
49+
"showErrors": true,
50+
"slug": "subpath/v2/api/apple/webhooks-1",
51+
"title": "Webhooks 1",
52+
"type": "apiReference"
53+
}
54+
],
55+
"id": "05a67abeb838721fb477e6a333220563912b7b6ad9ea6f75e0c2ca100eede6d7",
56+
"slug": "subpath/v2/api/apple",
57+
"title": "Apple",
58+
"type": "section"
59+
},
60+
{
61+
"children": [
62+
{
63+
"id": "ac8a13964f38160e4541c86647d4ba81bb386dfe2360df0d28056386498ed090",
64+
"pageId": "pages/banana.mdx",
65+
"slug": "subpath/v2/api/banana/overview",
66+
"title": "Overview",
67+
"type": "page"
68+
},
69+
{
70+
"apiDefinitionId": "1504329f-2ebc-4695-be7a-95793adc10b8",
71+
"children": [
72+
{
73+
"apiDefinitionId": "1504329f-2ebc-4695-be7a-95793adc10b8",
74+
"id": "1504329f-2ebc-4695-be7a-95793adc10b8:__package__.createPet",
75+
"method": "POST",
76+
"slug": "subpath/v2/api/banana/webhooks-2/create-pet",
77+
"title": "Create Pet",
78+
"type": "webhook",
79+
"webhookId": "__package__.createPet"
80+
}
81+
],
82+
"hideTitle": false,
83+
"id": "ca21b218657c27037e46be4bcf2ff6ef67db1f19a96c10387ffe12f3ea054762",
84+
"paginated": false,
85+
"pointsTo": "subpath/v2/api/banana/webhooks-2/create-pet",
86+
"showErrors": true,
87+
"slug": "subpath/v2/api/banana/webhooks-2",
88+
"title": "Webhooks 2",
89+
"type": "apiReference"
90+
}
91+
],
92+
"id": "a43e80dc278254786f40dd57b25eda5aadfcda931b1185188f51e9a6a9e95be4",
93+
"slug": "subpath/v2/api/banana",
94+
"title": "Banana",
95+
"type": "section"
96+
}
97+
],
98+
"id": "d1f2bbf1d431f8e8bceb4d72b2c28e7431fe9b2489c8b458af18893b3de8df9d",
99+
"type": "sidebarRoot"
100+
},
101+
"id": "e10bd79b1d1b174ed5d0ed58614a1131f41cff4647076071825ef24868b0b931",
102+
"slug": "subpath/v2/api",
103+
"title": "API",
104+
"type": "tab"
105+
}
106+
],
107+
"id": "5ea7b7a443a1be643c7a45f9ae4b7e3ebd298d442b610ac20380bbd7eddd3da2",
108+
"type": "tabbed"
109+
},
110+
"default": true,
111+
"id": "c00eece51ebef3362376bde4956e51bdb829a94e2cce394fe37bc2b2ec937f7e",
112+
"slug": "subpath/v2",
113+
"title": "v2",
114+
"type": "version",
115+
"versionId": "v2"
116+
}
117+
],
118+
"id": "298b9fd8c9bc0e05e8704d61a7aff24bc96bfbd2794d48f2bc6428e01b90efb0",
119+
"type": "versioned"
120+
},
121+
"hidden": false,
122+
"id": "d0b6b951d313294318002dfa2c33f529a0d58113d36dc35e0a83bb1e0f8638ec",
123+
"slug": "subpath",
124+
"title": "Minimum Repro Demo",
125+
"type": "root",
126+
"version": "v2"
127+
}

‎packages/fdr-sdk/src/__test__/output/demo/orphanedNodes.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[
2+
{
3+
"id": "c00eece51ebef3362376bde4956e51bdb829a94e2cce394fe37bc2b2ec937f7e",
4+
"slug": "subpath",
5+
"title": "v2",
6+
"type": "version"
7+
}
8+
]

‎packages/fdr-sdk/src/__test__/output/demo/orphanedNodesWithContent.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[]

‎packages/fdr-sdk/src/__test__/output/demo/pageIds.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[
2+
"pages/overview.mdx",
3+
"pages/apple.mdx",
4+
"pages/banana.mdx"
5+
]

0 commit comments

Comments
 (0)