/modules/apps/headless/headless-admin-address/headless-admin-address-impl/rest-openapi.yaml

https://github.com/danielreuther/liferay-portal · YAML · 544 lines · 544 code · 0 blank · 0 comment · 0 complexity · e3f874fe9024c1faa1338c77ea491462 MD5 · raw file

  1. components:
  2. schemas:
  3. Country:
  4. properties:
  5. a2:
  6. pattern: "[A-Z]{2}"
  7. type: string
  8. a3:
  9. pattern: "[A-Z]{3}"
  10. type: string
  11. active:
  12. default: true
  13. type: boolean
  14. billingAllowed:
  15. default: true
  16. type: boolean
  17. groupFilterEnabled:
  18. default: false
  19. type: boolean
  20. id:
  21. format: int64
  22. readOnly: true
  23. type: integer
  24. idd:
  25. type: integer
  26. name:
  27. type: string
  28. number:
  29. type: integer
  30. position:
  31. default: 0.0
  32. format: double
  33. type: number
  34. regions:
  35. items:
  36. $ref: "#/components/schemas/Region"
  37. readOnly: true
  38. type: array
  39. shippingAllowed:
  40. default: true
  41. type: boolean
  42. subjectToVAT:
  43. default: false
  44. type: boolean
  45. title_i18n:
  46. additionalProperties:
  47. type: string
  48. type: object
  49. zipRequired:
  50. default: true
  51. type: boolean
  52. required:
  53. - a2
  54. - a3
  55. - name
  56. - number
  57. type: object
  58. Region:
  59. properties:
  60. active:
  61. default: true
  62. type: boolean
  63. countryId:
  64. format: int64
  65. readOnly: true
  66. type: integer
  67. id:
  68. format: int64
  69. readOnly: true
  70. type: integer
  71. name:
  72. type: string
  73. position:
  74. default: 0.0
  75. format: double
  76. type: number
  77. regionCode:
  78. type: string
  79. title_i18n:
  80. additionalProperties:
  81. type: string
  82. type: object
  83. required:
  84. - regionCode
  85. - name
  86. info:
  87. description:
  88. "A Java client JAR is available for use with the group ID 'com.liferay', artifact ID
  89. 'com.liferay.headless.admin.address.client', and version '1.0.6'."
  90. license:
  91. name: "Apache 2.0"
  92. url: "http://www.apache.org/licenses/LICENSE-2.0.html"
  93. title: "Headless Admin Address"
  94. version: v1.0
  95. openapi: 3.0.1
  96. paths:
  97. "/countries":
  98. get:
  99. operationId: getCountriesPage
  100. parameters:
  101. - in: query
  102. name: active
  103. schema:
  104. type: boolean
  105. - in: query
  106. name: page
  107. schema:
  108. type: integer
  109. - in: query
  110. name: pageSize
  111. schema:
  112. type: integer
  113. - in: query
  114. name: search
  115. schema:
  116. type: string
  117. - in: query
  118. name: sort
  119. schema:
  120. type: string
  121. responses:
  122. 200:
  123. content:
  124. application/json:
  125. schema:
  126. items:
  127. $ref: "#/components/schemas/Country"
  128. type: array
  129. application/xml:
  130. schema:
  131. items:
  132. $ref: "#/components/schemas/Country"
  133. type: array
  134. tags: ["Country"]
  135. post:
  136. operationId: postCountry
  137. requestBody:
  138. content:
  139. application/json:
  140. schema:
  141. $ref: "#/components/schemas/Country"
  142. application/xml:
  143. schema:
  144. $ref: "#/components/schemas/Country"
  145. responses:
  146. 201:
  147. content:
  148. application/json:
  149. schema:
  150. $ref: "#/components/schemas/Country"
  151. application/xml:
  152. schema:
  153. $ref: "#/components/schemas/Country"
  154. tags: ["Country"]
  155. "/countries/by-a2/{a2}":
  156. get:
  157. operationId: getCountryByA2
  158. parameters:
  159. - in: path
  160. name: a2
  161. required: true
  162. schema:
  163. pattern: "[A-Z]{2}"
  164. type: string
  165. responses:
  166. 200:
  167. content:
  168. application/json:
  169. schema:
  170. $ref: "#/components/schemas/Country"
  171. application/xml:
  172. schema:
  173. $ref: "#/components/schemas/Country"
  174. tags: ["Country"]
  175. "/countries/by-a3/{a3}":
  176. get:
  177. operationId: getCountryByA3
  178. parameters:
  179. - in: path
  180. name: a3
  181. required: true
  182. schema:
  183. pattern: "[A-Z]{3}"
  184. type: string
  185. responses:
  186. 200:
  187. content:
  188. application/json:
  189. schema:
  190. $ref: "#/components/schemas/Country"
  191. application/xml:
  192. schema:
  193. $ref: "#/components/schemas/Country"
  194. tags: ["Country"]
  195. "/countries/by-name/{name}":
  196. get:
  197. operationId: getCountryByName
  198. parameters:
  199. - in: path
  200. name: name
  201. required: true
  202. schema:
  203. type: string
  204. responses:
  205. 200:
  206. content:
  207. application/json:
  208. schema:
  209. $ref: "#/components/schemas/Country"
  210. application/xml:
  211. schema:
  212. $ref: "#/components/schemas/Country"
  213. tags: ["Country"]
  214. "/countries/by-number/{number}":
  215. get:
  216. operationId: getCountryByNumber
  217. parameters:
  218. - in: path
  219. name: number
  220. required: true
  221. schema:
  222. type: integer
  223. responses:
  224. 200:
  225. content:
  226. application/json:
  227. schema:
  228. $ref: "#/components/schemas/Country"
  229. application/xml:
  230. schema:
  231. $ref: "#/components/schemas/Country"
  232. tags: ["Country"]
  233. "/countries/{countryId}":
  234. delete:
  235. operationId: deleteCountry
  236. parameters:
  237. - in: path
  238. name: countryId
  239. required: true
  240. schema:
  241. format: int64
  242. type: integer
  243. responses:
  244. 204:
  245. content:
  246. application/json: {}
  247. application/xml: {}
  248. tags: ["Country"]
  249. get:
  250. operationId: getCountry
  251. parameters:
  252. - in: path
  253. name: countryId
  254. required: true
  255. schema:
  256. format: int64
  257. type: integer
  258. responses:
  259. 200:
  260. content:
  261. application/json:
  262. schema:
  263. $ref: "#/components/schemas/Country"
  264. application/xml:
  265. schema:
  266. $ref: "#/components/schemas/Country"
  267. tags: ["Country"]
  268. patch:
  269. operationId: patchCountry
  270. parameters:
  271. - in: path
  272. name: countryId
  273. required: true
  274. schema:
  275. format: int64
  276. type: integer
  277. requestBody:
  278. content:
  279. application/json:
  280. schema:
  281. $ref: "#/components/schemas/Country"
  282. application/xml:
  283. schema:
  284. $ref: "#/components/schemas/Country"
  285. responses:
  286. 200:
  287. content:
  288. application/json:
  289. schema:
  290. $ref: "#/components/schemas/Country"
  291. application/xml:
  292. schema:
  293. $ref: "#/components/schemas/Country"
  294. tags: ["Country"]
  295. put:
  296. operationId: putCountry
  297. parameters:
  298. - in: path
  299. name: countryId
  300. required: true
  301. schema:
  302. format: int64
  303. type: integer
  304. requestBody:
  305. content:
  306. application/json:
  307. schema:
  308. $ref: "#/components/schemas/Country"
  309. application/xml:
  310. schema:
  311. $ref: "#/components/schemas/Country"
  312. responses:
  313. 200:
  314. content:
  315. application/json:
  316. schema:
  317. $ref: "#/components/schemas/Country"
  318. application/xml:
  319. schema:
  320. $ref: "#/components/schemas/Country"
  321. tags: ["Country"]
  322. "/countries/{countryId}/regions":
  323. get:
  324. operationId: getCountryRegionsPage
  325. parameters:
  326. - in: path
  327. name: countryId
  328. required: true
  329. schema:
  330. format: int64
  331. type: integer
  332. - in: query
  333. name: active
  334. schema:
  335. type: boolean
  336. - in: query
  337. name: page
  338. schema:
  339. type: integer
  340. - in: query
  341. name: pageSize
  342. schema:
  343. type: integer
  344. - in: query
  345. name: search
  346. schema:
  347. type: string
  348. - in: query
  349. name: sort
  350. schema:
  351. type: string
  352. responses:
  353. 200:
  354. content:
  355. application/json:
  356. schema:
  357. items:
  358. $ref: "#/components/schemas/Region"
  359. type: array
  360. application/xml:
  361. schema:
  362. items:
  363. $ref: "#/components/schemas/Region"
  364. type: array
  365. tags: ["Region"]
  366. post:
  367. operationId: postCountryRegion
  368. parameters:
  369. - in: path
  370. name: countryId
  371. required: true
  372. schema:
  373. format: int64
  374. type: integer
  375. requestBody:
  376. content:
  377. application/json:
  378. schema:
  379. $ref: "#/components/schemas/Region"
  380. application/xml:
  381. schema:
  382. $ref: "#/components/schemas/Region"
  383. responses:
  384. 201:
  385. content:
  386. application/json:
  387. schema:
  388. $ref: "#/components/schemas/Region"
  389. application/xml:
  390. schema:
  391. $ref: "#/components/schemas/Region"
  392. tags: ["Region"]
  393. "/countries/{countryId}/regions/by-region-code/{regionCode}":
  394. get:
  395. operationId: getCountryRegionByRegionCode
  396. parameters:
  397. - in: path
  398. name: countryId
  399. required: true
  400. schema:
  401. format: int64
  402. type: integer
  403. - in: path
  404. name: regionCode
  405. required: true
  406. schema:
  407. type: string
  408. responses:
  409. 200:
  410. content:
  411. application/json:
  412. schema:
  413. $ref: "#/components/schemas/Region"
  414. application/xml:
  415. schema:
  416. $ref: "#/components/schemas/Region"
  417. tags: ["Region"]
  418. "/regions":
  419. get:
  420. operationId: getRegionsPage
  421. parameters:
  422. - in: query
  423. name: active
  424. schema:
  425. type: boolean
  426. - in: query
  427. name: page
  428. schema:
  429. type: integer
  430. - in: query
  431. name: pageSize
  432. schema:
  433. type: integer
  434. - in: query
  435. name: search
  436. schema:
  437. type: string
  438. - in: query
  439. name: sort
  440. schema:
  441. type: string
  442. responses:
  443. 200:
  444. content:
  445. application/json:
  446. schema:
  447. items:
  448. $ref: "#/components/schemas/Region"
  449. type: array
  450. application/xml:
  451. schema:
  452. items:
  453. $ref: "#/components/schemas/Region"
  454. type: array
  455. tags: ["Region"]
  456. "/regions/{regionId}":
  457. delete:
  458. operationId: deleteRegion
  459. parameters:
  460. - in: path
  461. name: regionId
  462. required: true
  463. schema:
  464. format: int64
  465. type: integer
  466. responses:
  467. 204:
  468. content:
  469. application/json: {}
  470. application/xml: {}
  471. tags: ["Region"]
  472. get:
  473. operationId: getRegion
  474. parameters:
  475. - in: path
  476. name: regionId
  477. required: true
  478. schema:
  479. format: int64
  480. type: integer
  481. responses:
  482. 200:
  483. content:
  484. application/json:
  485. schema:
  486. $ref: "#/components/schemas/Region"
  487. application/xml:
  488. schema:
  489. $ref: "#/components/schemas/Region"
  490. tags: ["Region"]
  491. patch:
  492. operationId: patchRegion
  493. parameters:
  494. - in: path
  495. name: regionId
  496. required: true
  497. schema:
  498. format: int64
  499. type: integer
  500. requestBody:
  501. content:
  502. application/json:
  503. schema:
  504. $ref: "#/components/schemas/Region"
  505. application/xml:
  506. schema:
  507. $ref: "#/components/schemas/Region"
  508. responses:
  509. 200:
  510. content:
  511. application/json:
  512. schema:
  513. $ref: "#/components/schemas/Region"
  514. application/xml:
  515. schema:
  516. $ref: "#/components/schemas/Region"
  517. tags: ["Region"]
  518. put:
  519. operationId: putRegion
  520. parameters:
  521. - in: path
  522. name: regionId
  523. required: true
  524. schema:
  525. format: int64
  526. type: integer
  527. requestBody:
  528. content:
  529. application/json:
  530. schema:
  531. $ref: "#/components/schemas/Region"
  532. application/xml:
  533. schema:
  534. $ref: "#/components/schemas/Region"
  535. responses:
  536. 200:
  537. content:
  538. application/json:
  539. schema:
  540. $ref: "#/components/schemas/Region"
  541. application/xml:
  542. schema:
  543. $ref: "#/components/schemas/Region"
  544. tags: ["Region"]