Skip to content

Commit 759e268

Browse files
author
Wael Kdouh
committed
Pushed a new sample artifacts folder to reflect the recent changes in V2
1 parent dffe291 commit 759e268

File tree

46 files changed

+1844
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1844
-0
lines changed

‎SampleArtifacts/apis/demo-conference-api/apiInformation.json‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"properties": {
3+
"apiRevision": "1",
4+
"authenticationSettings": {},
5+
"description": "A sample API with information related to a technical conference. The available resources include *Speakers*, *Sessions* and *Topics*. A single write operation is available to provide feedback on a session.",
6+
"displayName": "Demo Conference API",
7+
"isCurrent": true,
8+
"path": "",
9+
"protocols": [
10+
"https"
11+
],
12+
"serviceUrl": "https://conferenceapi.azurewebsites.net",
13+
"subscriptionKeyParameterNames": {
14+
"header": "Ocp-Apim-Subscription-Key",
15+
"query": "subscription-key"
16+
},
17+
"subscriptionRequired": true
18+
}
19+
}

‎SampleArtifacts/apis/demo-conference-api/specification.yaml‎

Lines changed: 262 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,262 @@
1+
openapi: 3.0.1
2+
info:
3+
title: Demo Conference API
4+
description: 'A sample API with information related to a technical conference. The available resources include *Speakers*, *Sessions* and *Topics*. A single write operation is available to provide feedback on a session.'
5+
version: '1.0'
6+
servers:
7+
- url: https://api.waelsconsulting.com
8+
- url: https://portal.waelsconsulting.com
9+
paths:
10+
/sessions:
11+
get:
12+
summary: GetSessions
13+
description: A list of sessions. Optional parameters work as filters to reduce the listed sessions.
14+
operationId: GetSessions
15+
parameters:
16+
- name: speakername
17+
in: query
18+
style: form
19+
schema:
20+
type: string
21+
- name: dayno
22+
in: query
23+
description: Format - int32.
24+
style: form
25+
schema:
26+
type: integer
27+
- name: keyword
28+
in: query
29+
style: form
30+
schema:
31+
type: string
32+
responses:
33+
'200':
34+
description: OK
35+
content:
36+
application/vnd.collection+json: { }
37+
'/session/{id}':
38+
get:
39+
summary: GetSession
40+
description: Retreive a representation of a single session by Id
41+
operationId: GetSession
42+
parameters:
43+
- name: id
44+
in: path
45+
description: Format - int32.
46+
required: true
47+
style: simple
48+
schema:
49+
type: integer
50+
responses:
51+
'200':
52+
description: OK
53+
content:
54+
application/hal+json: { }
55+
text/plain: { }
56+
'/session/{id}/topics':
57+
get:
58+
summary: GetSessionTopics
59+
description: A list of topics covered by a particular session
60+
operationId: GetSessionTopics
61+
parameters:
62+
- name: id
63+
in: path
64+
description: Format - int32.
65+
required: true
66+
style: simple
67+
schema:
68+
type: integer
69+
responses:
70+
'200':
71+
description: OK
72+
content:
73+
application/vnd.collection+json: { }
74+
'/session/{id}/feedback':
75+
post:
76+
summary: SubmitSession
77+
description: Retreive a representation of a single session by Id
78+
operationId: SubmitSession
79+
parameters:
80+
- name: id
81+
in: path
82+
description: Format - int32.
83+
required: true
84+
style: simple
85+
schema:
86+
type: integer
87+
requestBody:
88+
content:
89+
text/plain:
90+
schema:
91+
$ref: '#/components/schemas/Body'
92+
example: ''
93+
responses:
94+
'200':
95+
description: OK
96+
content:
97+
application/hal+json: { }
98+
text/plain: { }
99+
/speakers:
100+
get:
101+
summary: GetSpeakers
102+
description: GetSpeakers
103+
operationId: GetSpeakers
104+
parameters:
105+
- name: dayno
106+
in: query
107+
description: Format - int32.
108+
style: form
109+
schema:
110+
type: integer
111+
- name: speakername
112+
in: query
113+
style: form
114+
schema:
115+
type: string
116+
responses:
117+
'200':
118+
description: OK
119+
content:
120+
application/vnd.collection+json: { }
121+
'/speaker/{id}':
122+
get:
123+
summary: GetSpeaker
124+
description: GetSpeaker
125+
operationId: GetSpeaker
126+
parameters:
127+
- name: id
128+
in: path
129+
description: Format - int32.
130+
required: true
131+
style: simple
132+
schema:
133+
type: integer
134+
responses:
135+
'200':
136+
description: OK
137+
content:
138+
application/vnd.hal+json: { }
139+
text/plain: { }
140+
'/speaker/{id}/sessions':
141+
get:
142+
summary: GetSpeakerSessions
143+
description: GetSpeakerSessions
144+
operationId: GetSpeakerSessions
145+
parameters:
146+
- name: id
147+
in: path
148+
description: Format - int32.
149+
required: true
150+
style: simple
151+
schema:
152+
type: integer
153+
responses:
154+
'200':
155+
description: OK
156+
content:
157+
application/vnd.collection+json: { }
158+
'/speaker/{id}/topics':
159+
get:
160+
summary: GetSpeakerTopics
161+
description: GetSpeakerTopics
162+
operationId: GetSpeakerTopics
163+
parameters:
164+
- name: id
165+
in: path
166+
description: Format - int32.
167+
required: true
168+
style: simple
169+
schema:
170+
type: integer
171+
responses:
172+
'200':
173+
description: OK
174+
content:
175+
application/vnd.collection+json: { }
176+
/topics:
177+
get:
178+
summary: GetTopics
179+
description: GetTopics
180+
operationId: GetTopics
181+
parameters:
182+
- name: dayno
183+
in: query
184+
description: Format - int32.
185+
style: form
186+
schema:
187+
type: integer
188+
responses:
189+
'200':
190+
description: OK
191+
content:
192+
application/vnd.collection+json: { }
193+
'/topic/{id}':
194+
get:
195+
summary: GetTopic
196+
description: GetTopic
197+
operationId: GetTopic
198+
parameters:
199+
- name: id
200+
in: path
201+
description: Format - int32.
202+
required: true
203+
style: simple
204+
schema:
205+
type: integer
206+
responses:
207+
'200':
208+
description: OK
209+
content:
210+
application/hal+json: { }
211+
'/topic/{id}/speakers':
212+
get:
213+
summary: GetTopicSpeakers
214+
description: GetTopicSpeakers
215+
operationId: GetTopicSpeakers
216+
parameters:
217+
- name: id
218+
in: path
219+
description: Format - int32.
220+
required: true
221+
style: simple
222+
schema:
223+
type: integer
224+
responses:
225+
'200':
226+
description: OK
227+
content:
228+
application/vnd.collection+json: { }
229+
'/topic/{id}/sessions':
230+
get:
231+
summary: GetTopicSessions
232+
description: GetTopicSessions
233+
operationId: GetTopicSessions
234+
parameters:
235+
- name: id
236+
in: path
237+
description: Format - int32.
238+
required: true
239+
style: simple
240+
schema:
241+
type: integer
242+
responses:
243+
'200':
244+
description: OK
245+
content:
246+
application/vnd.collection+json: { }
247+
components:
248+
schemas:
249+
Body:
250+
type: string
251+
securitySchemes:
252+
apiKeyHeader:
253+
type: apiKey
254+
name: Ocp-Apim-Subscription-Key
255+
in: header
256+
apiKeyQuery:
257+
type: apiKey
258+
name: subscription-key
259+
in: query
260+
security:
261+
- apiKeyHeader: [ ]
262+
- apiKeyQuery: [ ]

‎SampleArtifacts/apis/demo-conference-api/tags.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[
2+
{
3+
"name": "booking"
4+
},
5+
{
6+
"name": "tag2"
7+
}
8+
]

‎SampleArtifacts/apis/helloworldfromfuncapp/apiInformation.json‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"properties": {
3+
"apiRevision": "1",
4+
"authenticationSettings": {},
5+
"description": "Import from \u0022helloworldfromfuncapp\u0022 Function App",
6+
"displayName": "helloworldfromfuncapp",
7+
"isCurrent": true,
8+
"path": "helloworldfromfuncapp",
9+
"protocols": [
10+
"https"
11+
],
12+
"serviceUrl": "[your function url goes here]",
13+
"subscriptionKeyParameterNames": {
14+
"header": "Ocp-Apim-Subscription-Key",
15+
"query": "subscription-key"
16+
},
17+
"subscriptionRequired": true
18+
}
19+
}

‎SampleArtifacts/apis/helloworldfromfuncapp/operations/get-httptrigger1/policy.xml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<policies>
2+
<inbound>
3+
<base />
4+
<set-backend-service id="apim-generated-policy" backend-id="helloworldfromfuncapp" />
5+
</inbound>
6+
<backend>
7+
<base />
8+
</backend>
9+
<outbound>
10+
<base />
11+
</outbound>
12+
<on-error>
13+
<base />
14+
</on-error>
15+
</policies>

‎SampleArtifacts/apis/helloworldfromfuncapp/operations/post-httptrigger1/policy.xml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<policies>
2+
<inbound>
3+
<base />
4+
<set-backend-service id="apim-generated-policy" backend-id="helloworldfromfuncapp" />
5+
</inbound>
6+
<backend>
7+
<base />
8+
</backend>
9+
<outbound>
10+
<base />
11+
</outbound>
12+
<on-error>
13+
<base />
14+
</on-error>
15+
</policies>

‎SampleArtifacts/apis/helloworldfromfuncapp/specification.yaml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
openapi: 3.0.1
2+
info:
3+
title: helloworldfromfuncapp
4+
description: Import from "helloworldfromfuncapp" Function App
5+
version: '1.0'
6+
servers:
7+
- url: [url goes here]]
8+
- url: [url goes here]]
9+
paths:
10+
/HttpTrigger1:
11+
get:
12+
summary: HttpTrigger1
13+
description: HttpTrigger1
14+
operationId: get-httptrigger1
15+
responses:
16+
'200':
17+
description: ''
18+
post:
19+
summary: HttpTrigger1
20+
description: HttpTrigger1
21+
operationId: post-httptrigger1
22+
responses:
23+
'200':
24+
description: ''
25+
components:
26+
securitySchemes:
27+
apiKeyHeader:
28+
type: apiKey
29+
name: Ocp-Apim-Subscription-Key
30+
in: header
31+
apiKeyQuery:
32+
type: apiKey
33+
name: subscription-key
34+
in: query
35+
security:
36+
- apiKeyHeader: [ ]
37+
- apiKeyQuery: [ ]

0 commit comments

Comments
 (0)