/backend/swagger/api.yaml

https://github.com/awslabs/realworld-serverless-application · YAML · 424 lines · 419 code · 3 blank · 2 comment · 0 complexity · c8f5652ed569eef2d7594f49371e01b4 MD5 · raw file 

    

  1. openapi: 3.0.0
    2. 

  2. 

  3. info:
    4. 

  4.   title:
    5. 

  5.     Fn::Sub: realworld-serverless-application-backend-${Stage}
    6. 

  6.   description: A simplified implementation of AWS Serverless Application Repository
    7. 

  7.   version: 2019-10-13
    8. 

  8. 

  9. # Enable request validator. See doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-validation-sample-api-swagger.html
    10. 

  10. x-amazon-apigateway-request-validators:
    11. 

  11.   all:
    12. 

  12.     validateRequestBody: true
    13. 

  13.     validateRequestParameters: true
    14. 

  14. x-amazon-apigateway-request-validator: all
    15. 

  15. 

  16. x-amazon-apigateway-gateway-responses:
    17. 

  17.   # Provide more detailed error message for bad request body errors. See doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.html
    18. 

  18.   BAD_REQUEST_BODY:
    19. 

  19.     responseTemplates:
    20. 

  20.       application/json: '{"errorCode": "BadRequestBody", "message": "$context.error.validationErrorString"}'
    21. 

  21.     responseParameters:
    22. 

  22.       gatewayresponse.header.Access-Control-Allow-Origin: "'*'"
    23. 

  23.   DEFAULT_4XX:
    24. 

  24.     responseParameters:
    25. 

  25.       gatewayresponse.header.Access-Control-Allow-Origin: "'*'"
    26. 

  26.   DEFAULT_5XX:
    27. 

  27.     responseParameters:
    28. 

  28.       gatewayresponse.header.Access-Control-Allow-Origin: "'*'"
    29. 

  29. paths:
    30. 

  30.   /applications:
    31. 

  31.     post:
    32. 

  32.       operationId: CreateApplication
    33. 

  33.       requestBody:
    34. 

  34.         content:
    35. 

  35.           application/json:
    36. 

  36.             schema:
    37. 

  37.               $ref: "#/components/schemas/CreateApplicationInput"
    38. 

  38.         required: true
    39. 

  39.       responses:
    40. 

  40.         "201":
    41. 

  41.           description: "Successfully Created an application."
    42. 

  42.           content:
    43. 

  43.             application/json:
    44. 

  44.               schema:
    45. 

  45.                 $ref: "#/components/schemas/Application"
    46. 

  46.         "400":
    47. 

  47.           description: "Bad Request Exception"
    48. 

  48.           content:
    49. 

  49.             application/json:
    50. 

  50.               schema:
    51. 

  51.                 $ref: "#/components/schemas/BadRequestException"
    52. 

  52.         "401":
    53. 

  53.           description: "Unauthorized Exception"
    54. 

  54.           content:
    55. 

  55.             application/json:
    56. 

  56.               schema:
    57. 

  57.                 $ref: "#/components/schemas/UnauthorizedException"
    58. 

  58.         "409":
    59. 

  59.           description: "Conflict Exception"
    60. 

  60.           content:
    61. 

  61.             application/json:
    62. 

  62.               schema:
    63. 

  63.                 $ref: "#/components/schemas/ConflictException"
    64. 

  64.         "429":
    65. 

  65.           description: "Too Many Requests Exception"
    66. 

  66.           content:
    67. 

  67.             application/json:
    68. 

  68.               schema:
    69. 

  69.                 $ref: "#/components/schemas/TooManyRequestsException"
    70. 

  70.         "500":
    71. 

  71.           description: "Internal Server Error"
    72. 

  72.           content:
    73. 

  73.             application/json:
    74. 

  74.               schema:
    75. 

  75.                 $ref: "#/components/schemas/InternalServerErrorException"
    76. 

  76.       x-amazon-apigateway-integration:
    77. 

  77.         uri:
    78. 

  78.           Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${ApiLambda.Arn}:live/invocations
    79. 

  79.         httpMethod: POST
    80. 

  80.         type: aws_proxy
    81. 

  81.         passthroughBehavior: never
    82. 

  82.       security:
    83. 

  83.         - cognitoAuthorizer: []
    84. 

  84.     get:
    85. 

  85.       operationId: ListApplications
    86. 

  86.       parameters:
    87. 

  87.         - name: nextToken
    88. 

  88.           in: query
    89. 

  89.           required: false
    90. 

  90.           schema:
    91. 

  91.             type: string
    92. 

  92.         - name: maxItems
    93. 

  93.           in: query
    94. 

  94.           required: false
    95. 

  95.           schema:
    96. 

  96.             type: integer
    97. 

  97.             minimum: 1
    98. 

  98.             maximum: 100
    99. 

  99.       responses:
    100. 

  100.         "200":
    101. 

  101.           description: "Successfully list applications"
    102. 

  102.           content:
    103. 

  103.             application/json:
    104. 

  104.               schema:
    105. 

  105.                 $ref: "#/components/schemas/ApplicationList"
    106. 

  106.         "400":
    107. 

  107.           description: "Bad Request Exception"
    108. 

  108.           content:
    109. 

  109.             application/json:
    110. 

  110.               schema:
    111. 

  111.                 $ref: "#/components/schemas/BadRequestException"
    112. 

  112.         "401":
    113. 

  113.           description: "Unauthorized Exception"
    114. 

  114.           content:
    115. 

  115.             application/json:
    116. 

  116.               schema:
    117. 

  117.                 $ref: "#/components/schemas/UnauthorizedException"
    118. 

  118.         "429":
    119. 

  119.           description: "Too Many Requests Exception"
    120. 

  120.           content:
    121. 

  121.             application/json:
    122. 

  122.               schema:
    123. 

  123.                 $ref: "#/components/schemas/TooManyRequestsException"
    124. 

  124.         "500":
    125. 

  125.           description: "Internal Server Error"
    126. 

  126.           content:
    127. 

  127.             application/json:
    128. 

  128.               schema:
    129. 

  129.                 $ref: "#/components/schemas/InternalServerErrorException"
    130. 

  130.       x-amazon-apigateway-integration:
    131. 

  131.         uri:
    132. 

  132.           Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${ApiLambda.Arn}:live/invocations
    133. 

  133.         httpMethod: POST
    134. 

  134.         type: aws_proxy
    135. 

  135.         passthroughBehavior: never
    136. 

  136.       security:
    137. 

  137.         - cognitoAuthorizer: []
    138. 

  138.   "/applications/{applicationId}":
    139. 

  139.     get:
    140. 

  140.       operationId: GetApplication
    141. 

  141.       parameters:
    142. 

  142.         - name: applicationId
    143. 

  143.           in: path
    144. 

  144.           required: true
    145. 

  145.           schema:
    146. 

  146.             type: string
    147. 

  147.             pattern: ^[a-zA-Z0-9\-]{3,128}$
    148. 

  148.       responses:
    149. 

  149.         "200":
    150. 

  150.           description: "Successfully get an application"
    151. 

  151.           content:
    152. 

  152.             application/json:
    153. 

  153.               schema:
    154. 

  154.                 $ref: "#/components/schemas/Application"
    155. 

  155.         "400":
    156. 

  156.           description: "Bad Request Exception"
    157. 

  157.           content:
    158. 

  158.             application/json:
    159. 

  159.               schema:
    160. 

  160.                 $ref: "#/components/schemas/BadRequestException"
    161. 

  161.         "401":
    162. 

  162.           description: "Unauthorized Exception"
    163. 

  163.           content:
    164. 

  164.             application/json:
    165. 

  165.               schema:
    166. 

  166.                 $ref: "#/components/schemas/UnauthorizedException"
    167. 

  167.         "404":
    168. 

  168.           description: "Not Found Exception"
    169. 

  169.           content:
    170. 

  170.             application/json:
    171. 

  171.               schema:
    172. 

  172.                 $ref: "#/components/schemas/NotFoundException"
    173. 

  173.         "429":
    174. 

  174.           description: "Too Many Requests Exception"
    175. 

  175.           content:
    176. 

  176.             application/json:
    177. 

  177.               schema:
    178. 

  178.                 $ref: "#/components/schemas/TooManyRequestsException"
    179. 

  179.         "500":
    180. 

  180.           description: "Internal Server Error"
    181. 

  181.           content:
    182. 

  182.             application/json:
    183. 

  183.               schema:
    184. 

  184.                 $ref: "#/components/schemas/InternalServerErrorException"
    185. 

  185.       x-amazon-apigateway-integration:
    186. 

  186.         uri:
    187. 

  187.           Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${ApiLambda.Arn}:live/invocations
    188. 

  188.         httpMethod: POST
    189. 

  189.         type: aws_proxy
    190. 

  190.         passthroughBehavior: never
    191. 

  191.       security:
    192. 

  192.         - cognitoAuthorizer: []
    193. 

  193.     patch:
    194. 

  194.       operationId: UpdateApplication
    195. 

  195.       parameters:
    196. 

  196.         - name: applicationId
    197. 

  197.           in: path
    198. 

  198.           required: true
    199. 

  199.           schema:
    200. 

  200.             type: string
    201. 

  201.             pattern: ^[a-zA-Z0-9\-]{3,128}$
    202. 

  202.       requestBody:
    203. 

  203.         content:
    204. 

  204.           application/json:
    205. 

  205.             schema:
    206. 

  206.               $ref: "#/components/schemas/UpdateApplicationInput"
    207. 

  207.         required: true
    208. 

  208.       responses:
    209. 

  209.         "200":
    210. 

  210.           description: "Successfully update an application"
    211. 

  211.           content:
    212. 

  212.             application/json:
    213. 

  213.               schema:
    214. 

  214.                 $ref: "#/components/schemas/Application"
    215. 

  215.         "400":
    216. 

  216.           description: "Bad Request Exception"
    217. 

  217.           content:
    218. 

  218.             application/json:
    219. 

  219.               schema:
    220. 

  220.                 $ref: "#/components/schemas/BadRequestException"
    221. 

  221.         "401":
    222. 

  222.           description: "Unauthorized Exception"
    223. 

  223.           content:
    224. 

  224.             application/json:
    225. 

  225.               schema:
    226. 

  226.                 $ref: "#/components/schemas/UnauthorizedException"
    227. 

  227.         "404":
    228. 

  228.           description: "Not Found Exception"
    229. 

  229.           content:
    230. 

  230.             application/json:
    231. 

  231.               schema:
    232. 

  232.                 $ref: "#/components/schemas/NotFoundException"
    233. 

  233.         "429":
    234. 

  234.           description: "Too Many Requests Exception"
    235. 

  235.           content:
    236. 

  236.             application/json:
    237. 

  237.               schema:
    238. 

  238.                 $ref: "#/components/schemas/TooManyRequestsException"
    239. 

  239.         "500":
    240. 

  240.           description: "Internal Server Error"
    241. 

  241.           content:
    242. 

  242.             application/json:
    243. 

  243.               schema:
    244. 

  244.                 $ref: "#/components/schemas/InternalServerErrorException"
    245. 

  245.       x-amazon-apigateway-integration:
    246. 

  246.         uri:
    247. 

  247.           Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${ApiLambda.Arn}:live/invocations
    248. 

  248.         httpMethod: POST
    249. 

  249.         type: aws_proxy
    250. 

  250.         passthroughBehavior: never
    251. 

  251.       security:
    252. 

  252.         - cognitoAuthorizer: []
    253. 

  253.     delete:
    254. 

  254.       operationId: DeleteApplication
    255. 

  255.       parameters:
    256. 

  256.         - name: applicationId
    257. 

  257.           in: path
    258. 

  258.           required: true
    259. 

  259.           schema:
    260. 

  260.             type: string
    261. 

  261.             pattern: ^[a-zA-Z0-9\-]{3,128}$
    262. 

  262.       responses:
    263. 

  263.         "204":
    264. 

  264.           description: "Successfully delete an application"
    265. 

  265.         "400":
    266. 

  266.           description: "Bad Request Exception"
    267. 

  267.           content:
    268. 

  268.             application/json:
    269. 

  269.               schema:
    270. 

  270.                 $ref: "#/components/schemas/BadRequestException"
    271. 

  271.         "401":
    272. 

  272.           description: "Unauthorized Exception"
    273. 

  273.           content:
    274. 

  274.             application/json:
    275. 

  275.               schema:
    276. 

  276.                 $ref: "#/components/schemas/UnauthorizedException"
    277. 

  277.         "404":
    278. 

  278.           description: "Not Found Exception"
    279. 

  279.           content:
    280. 

  280.             application/json:
    281. 

  281.               schema:
    282. 

  282.                 $ref: "#/components/schemas/NotFoundException"
    283. 

  283.         "429":
    284. 

  284.           description: "Too Many Requests Exception"
    285. 

  285.           content:
    286. 

  286.             application/json:
    287. 

  287.               schema:
    288. 

  288.                 $ref: "#/components/schemas/TooManyRequestsException"
    289. 

  289.         "500":
    290. 

  290.           description: "Internal Server Error"
    291. 

  291.           content:
    292. 

  292.             application/json:
    293. 

  293.               schema:
    294. 

  294.                 $ref: "#/components/schemas/InternalServerErrorException"
    295. 

  295.       x-amazon-apigateway-integration:
    296. 

  296.         uri:
    297. 

  297.           Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${ApiLambda.Arn}:live/invocations
    298. 

  298.         httpMethod: POST
    299. 

  299.         type: aws_proxy
    300. 

  300.         passthroughBehavior: never
    301. 

  301.       security:
    302. 

  302.         - cognitoAuthorizer: []
    303. 

  303. components:
    304. 

  304.   securitySchemes:
    305. 

  305.     cognitoAuthorizer:
    306. 

  306.       type: apiKey
    307. 

  307.       name: Authorization
    308. 

  308.       in: header
    309. 

  309.       x-amazon-apigateway-authtype: cognito_user_pools
    310. 

  310.       x-amazon-apigateway-authorizer:
    311. 

  311.         providerARNs:
    312. 

  312.           - Fn::GetAtt: ApplicationsApiUserPool.Arn
    313. 

  313.         type: cognito_user_pools
    314. 

  314.   schemas:
    315. 

  315.     BadRequestException:
    316. 

  316.       type: object
    317. 

  317.       properties:
    318. 

  318.         message:
    319. 

  319.           type: string
    320. 

  320.         errorCode:
    321. 

  321.           type: string
    322. 

  322.     UnauthorizedException:
    323. 

  323.       type: object
    324. 

  324.       properties:
    325. 

  325.         message:
    326. 

  326.           type: string
    327. 

  327.         errorCode:
    328. 

  328.           type: string
    329. 

  329.     NotFoundException:
    330. 

  330.       type: object
    331. 

  331.       properties:
    332. 

  332.         message:
    333. 

  333.           type: string
    334. 

  334.         errorCode:
    335. 

  335.           type: string
    336. 

  336.     ConflictException:
    337. 

  337.       type: object
    338. 

  338.       properties:
    339. 

  339.         message:
    340. 

  340.           type: string
    341. 

  341.         errorCode:
    342. 

  342.           type: string
    343. 

  343.     TooManyRequestsException:
    344. 

  344.       type: object
    345. 

  345.       properties:
    346. 

  346.         message:
    347. 

  347.           type: string
    348. 

  348.         errorCode:
    349. 

  349.           type: string
    350. 

  350.     InternalServerErrorException:
    351. 

  351.       type: object
    352. 

  352.       properties:
    353. 

  353.         message:
    354. 

  354.           type: string
    355. 

  355.         errorCode:
    356. 

  356.           type: string
    357. 

  357.     CreateApplicationInput:
    358. 

  358.       type: object
    359. 

  359.       required:
    360. 

  360.         - applicationId
    361. 

  361.         - description
    362. 

  362.         - author
    363. 

  363.       properties:
    364. 

  364.         applicationId:
    365. 

  365.           type: string
    366. 

  366.           pattern: ^[a-zA-Z0-9\-]{3,128}$
    367. 

  367.         description:
    368. 

  368.           type: string
    369. 

  369.           minLength: 3
    370. 

  370.           maxLength: 256
    371. 

  371.         author:
    372. 

  372.           type: string
    373. 

  373.           pattern: ^[a-zA-Z0-9\-]{1,128}$
    374. 

  374.         homePageUrl:
    375. 

  375.           type: string
    376. 

  376.           pattern: ^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$
    377. 

  377.     UpdateApplicationInput:
    378. 

  378.       type: object
    379. 

  379.       properties:
    380. 

  380.         description:
    381. 

  381.           type: string
    382. 

  382.           minLength: 3
    383. 

  383.           maxLength: 256
    384. 

  384.         author:
    385. 

  385.           type: string
    386. 

  386.           pattern: ^[a-zA-Z0-9\-]{1,128}$
    387. 

  387.         homePageUrl:
    388. 

  388.           type: string
    389. 

  389.           pattern: ^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$
    390. 

  390.     Application:
    391. 

  391.       type: object
    392. 

  392.       required:
    393. 

  393.         - applicationId
    394. 

  394.         - description
    395. 

  395.         - author
    396. 

  396.       properties:
    397. 

  397.         applicationId:
    398. 

  398.           type: string
    399. 

  399.         description:
    400. 

  400.           type: string
    401. 

  401.         author:
    402. 

  402.           type: string
    403. 

  403.         creationTime:
    404. 

  404.           type: string
    405. 

  405.         homePageUrl:
    406. 

  406.           type: string
    407. 

  407.     ApplicationSummary:
    408. 

  408.       type: object
    409. 

  409.       properties:
    410. 

  410.         applicationId:
    411. 

  411.           type: string
    412. 

  412.         description:
    413. 

  413.           type: string
    414. 

  414.         creationTime:
    415. 

  415.           type: string
    416. 

  416.     ApplicationList:
    417. 

  417.       type: object
    418. 

  418.       properties:
    419. 

  419.         applications:
    420. 

  420.           type: array
    421. 

  421.           items:
    422. 

  422.             $ref: "#/components/schemas/ApplicationSummary"
    423. 

  423.         nextToken:
    424. 

  424.           type: string
    425.