Skip to content

Commit 8936151

Browse files
ivan-gomesivan-gomes
committed
refactor: JSON-LD spec ST5AS-219
refactor: extensions spec
1 parent 267ae1e commit 8936151

5 files changed

Lines changed: 121452 additions & 1181 deletions

File tree

‎public/docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<rapi-doc
99
spec-url="openapi.json"
1010
show-components="true"
11-
show-header="false"
11+
allow-spec-file-load="false"
1212
allow-authentication="false"
1313
allow-spec-file-download="true"
1414
allow-server-selection="false"

‎public/docs/openapi-extensions.json‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
{
2+
"tags": [
3+
{
4+
"name": "Extension"
5+
}
6+
],
7+
"paths": {
8+
"/x/named/projects/{projectId}/commits": {
9+
"post": {
10+
"tags": [
11+
"Extension"
12+
],
13+
"summary": "Create commit by project, resolving references by qualified name",
14+
"operationId": "postCommitByProjectNameResolved",
15+
"parameters": [
16+
{
17+
"name": "projectId",
18+
"in": "path",
19+
"description": "ID of the project",
20+
"required": true,
21+
"schema": {
22+
"type": "string",
23+
"format": "uuid"
24+
}
25+
},
26+
{
27+
"name": "branchId",
28+
"in": "query",
29+
"description": "ID of the branch - project's default branch if unspecified",
30+
"schema": {
31+
"type": "string",
32+
"format": "uuid"
33+
}
34+
}
35+
],
36+
"requestBody": {
37+
"content": {
38+
"application/json": {
39+
"schema": {
40+
"$ref": "#/components/schemas/Identified"
41+
}
42+
}
43+
},
44+
"required": true
45+
},
46+
"responses": {
47+
"201": {
48+
"description": "Created",
49+
"content": {
50+
"application/json": {
51+
"schema": {
52+
"$ref": "#/components/schemas/Commit"
53+
}
54+
}
55+
}
56+
},
57+
"415": {
58+
"description": "The requested content type is not acceptable.",
59+
"content": {
60+
"application/json": {
61+
"schema": {
62+
"$ref": "#/components/schemas/Error"
63+
}
64+
}
65+
}
66+
},
67+
"500": {
68+
"description": "Internal server error.",
69+
"content": {
70+
"application/json": {
71+
"schema": {
72+
"$ref": "#/components/schemas/Error"
73+
}
74+
}
75+
}
76+
},
77+
"default": {
78+
"description": "Unexpected response.",
79+
"content": {}
80+
}
81+
},
82+
"x-codegen-request-body-name": "body"
83+
}
84+
},
85+
"/x/named/projects/{projectId}/commits/{commitId}/elements/{qualifiedName}": {
86+
"get": {
87+
"tags": [
88+
"Extension"
89+
],
90+
"summary": "Get element by project, commit and qualified name",
91+
"operationId": "getElementByProjectCommitQualifiedName",
92+
"parameters": [
93+
{
94+
"name": "projectId",
95+
"in": "path",
96+
"description": "ID of the project",
97+
"required": true,
98+
"schema": {
99+
"type": "string",
100+
"format": "uuid"
101+
}
102+
},
103+
{
104+
"name": "commitId",
105+
"in": "path",
106+
"description": "ID of the commit",
107+
"required": true,
108+
"schema": {
109+
"type": "string",
110+
"format": "uuid"
111+
}
112+
},
113+
{
114+
"name": "qualifiedName",
115+
"in": "path",
116+
"description": "Qualified name of the element",
117+
"required": true,
118+
"schema": {
119+
"type": "string"
120+
}
121+
}
122+
],
123+
"responses": {
124+
"200": {
125+
"description": "Ok",
126+
"content": {
127+
"application/json": {
128+
"schema": {
129+
"$ref": "#/components/schemas/Element"
130+
}
131+
}
132+
}
133+
},
134+
"404": {
135+
"description": "Not found.",
136+
"content": {}
137+
},
138+
"415": {
139+
"description": "The requested content type is not acceptable.",
140+
"content": {
141+
"application/json": {
142+
"schema": {
143+
"$ref": "#/components/schemas/Error"
144+
}
145+
}
146+
}
147+
},
148+
"500": {
149+
"description": "Internal server error.",
150+
"content": {
151+
"application/json": {
152+
"schema": {
153+
"$ref": "#/components/schemas/Error"
154+
}
155+
}
156+
}
157+
},
158+
"default": {
159+
"description": "Unexpected response.",
160+
"content": {}
161+
}
162+
}
163+
}
164+
}
165+
}
166+
}

0 commit comments

Comments
 (0)