File size: 23,266 Bytes
6c50d1f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 | openapi: 3.0.1
info:
title: Api Documentation
description: Api Documentation
termsOfService: urn:tos
contact: {}
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0
version: "1.0"
servers:
- url: http://localhost:30115
tags:
- name: basic-error-controller
description: Basic Error Controller
- name: login-rest-controller
description: Login Rest Controller
- name: rbac-rest-controller
description: RBAC Rest Controller
- name: register-rest-controller
description: Register Rest Controller
- name: user-rest-controller
description: User Rest Controller
paths:
/error:
get:
tags:
- basic-error-controller
summary: errorHtml
operationId: errorHtmlUsingGET
responses:
"200":
description: OK
content:
text/html:
schema:
$ref: '#/components/schemas/ModelAndView'
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
put:
tags:
- basic-error-controller
summary: errorHtml
operationId: errorHtmlUsingPUT
responses:
"200":
description: OK
content:
text/html:
schema:
$ref: '#/components/schemas/ModelAndView'
"201":
description: Created
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
post:
tags:
- basic-error-controller
summary: errorHtml
operationId: errorHtmlUsingPOST
responses:
"200":
description: OK
content:
text/html:
schema:
$ref: '#/components/schemas/ModelAndView'
"201":
description: Created
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
delete:
tags:
- basic-error-controller
summary: errorHtml
operationId: errorHtmlUsingDELETE
responses:
"200":
description: OK
content:
text/html:
schema:
$ref: '#/components/schemas/ModelAndView'
"204":
description: No Content
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
deprecated: false
head:
tags:
- basic-error-controller
summary: errorHtml
operationId: errorHtmlUsingHEAD
responses:
"200":
description: OK
content:
text/html:
schema:
$ref: '#/components/schemas/ModelAndView'
"204":
description: No Content
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
deprecated: false
patch:
tags:
- basic-error-controller
summary: errorHtml
operationId: errorHtmlUsingPATCH
responses:
"200":
description: OK
content:
text/html:
schema:
$ref: '#/components/schemas/ModelAndView'
"204":
description: No Content
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
deprecated: false
/login:
post:
tags:
- login-rest-controller
summary: login
operationId: loginUsingPOST
requestBody:
description: loginRequestDTO
content:
application/json:
schema:
$ref: '#/components/schemas/LoginRequestDTO'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDTO'
"201":
description: Created
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
x-codegen-request-body-name: loginRequestDTO
/users:
get:
tags:
- user-rest-controller
summary: getUserPresentationList
operationId: getUserPresentationListUsingGET
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserListDTO'
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
post:
tags:
- user-rest-controller
summary: createUser
operationId: createUserUsingPOST
requestBody:
description: createOrUpdateUserDTO
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOrUpdateUserDTO'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDTO'
"201":
description: Created
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
x-codegen-request-body-name: createOrUpdateUserDTO
/users/rbac/permissions:
get:
tags:
- rbac-rest-controller
summary: getPermissionPresentationList
operationId: getPermissionPresentationListUsingGET
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/PermissionDTO'
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
/users/rbac/roles:
get:
tags:
- rbac-rest-controller
summary: getRolePresentationList
operationId: getRolePresentationListUsingGET
responses:
"200":
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/RoleDTO'
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
post:
tags:
- rbac-rest-controller
summary: createRole
operationId: createRoleUsingPOST
requestBody:
description: role
content:
application/json:
schema:
type: string
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RoleDTO'
"201":
description: Created
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
x-codegen-request-body-name: role
/users/rbac/roles/{roleId}:
get:
tags:
- rbac-rest-controller
summary: getRoleById
operationId: getRoleByIdUsingGET
parameters:
- name: roleId
in: path
description: roleId
required: true
schema:
type: integer
format: int64
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RoleDTO'
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
delete:
tags:
- rbac-rest-controller
summary: deleteRoleById
operationId: deleteRoleByIdUsingDELETE
parameters:
- name: roleId
in: path
description: roleId
required: true
schema:
type: integer
format: int64
responses:
"200":
description: OK
content:
'*/*':
schema:
type: object
"204":
description: No Content
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
deprecated: false
/users/rbac/roles/{roleId}/permissions/{permissionKey}:
post:
tags:
- rbac-rest-controller
summary: addPermissionOnRole
operationId: addPermissionOnRoleUsingPOST
parameters:
- name: permissionKey
in: path
description: permissionKey
required: true
schema:
type: string
- name: roleId
in: path
description: roleId
required: true
schema:
type: integer
format: int64
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RoleDTO'
"201":
description: Created
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
delete:
tags:
- rbac-rest-controller
summary: removePermissionOnRole
operationId: removePermissionOnRoleUsingDELETE
parameters:
- name: permissionKey
in: path
description: permissionKey
required: true
schema:
type: string
- name: roleId
in: path
description: roleId
required: true
schema:
type: integer
format: int64
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RoleDTO'
"204":
description: No Content
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
deprecated: false
/users/register:
post:
tags:
- register-rest-controller
summary: registerNewUserAccount
operationId: registerNewUserAccountUsingPOST
requestBody:
description: registerUserAccountDTO
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterUserAccountDTO'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDTO'
"201":
description: Created
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
x-codegen-request-body-name: registerUserAccountDTO
/users/{id}:
get:
tags:
- user-rest-controller
summary: getUserById
operationId: getUserByIdUsingGET
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int64
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDTO'
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
put:
tags:
- user-rest-controller
summary: updateUser
operationId: updateUserUsingPUT
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int64
requestBody:
description: updateUserDTO
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOrUpdateUserDTO'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDTO'
"201":
description: Created
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
x-codegen-request-body-name: updateUserDTO
delete:
tags:
- user-rest-controller
summary: deleteById
operationId: deleteByIdUsingDELETE
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int64
responses:
"200":
description: OK
content:
'*/*':
schema:
type: object
"204":
description: No Content
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
deprecated: false
/users/{id}/roles/{roleId}:
post:
tags:
- user-rest-controller
summary: addRole
operationId: addRoleUsingPOST
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int64
- name: roleId
in: path
description: roleId
required: true
schema:
type: integer
format: int64
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDTO'
"201":
description: Created
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
"404":
description: Not Found
content: {}
deprecated: false
delete:
tags:
- user-rest-controller
summary: removeRole
operationId: removeRoleUsingDELETE
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int64
- name: roleId
in: path
description: roleId
required: true
schema:
type: integer
format: int64
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserDTO'
"204":
description: No Content
content: {}
"401":
description: Unauthorized
content: {}
"403":
description: Forbidden
content: {}
deprecated: false
components:
schemas:
AddressDTO:
title: AddressDTO
type: object
properties:
address:
type: string
address2:
type: string
city:
type: string
country:
type: string
zipCode:
type: string
ContactDTO:
title: ContactDTO
type: object
properties:
contactNote:
type: string
email:
type: string
facebook:
type: string
linkedin:
type: string
phone:
type: string
skype:
type: string
website:
type: string
CreateOrUpdateUserDTO:
title: CreateOrUpdateUserDTO
type: object
properties:
address:
type: string
address2:
type: string
birthDate:
type: string
format: date
city:
type: string
contactNote:
type: string
country:
type: string
email:
type: string
enabled:
type: boolean
facebook:
type: string
gender:
type: string
linkedin:
type: string
mobile:
type: string
name:
type: string
note:
type: string
password:
type: string
secured:
type: boolean
skype:
type: string
surname:
type: string
username:
type: string
website:
type: string
zipCode:
type: string
LoginRequestDTO:
title: LoginRequestDTO
type: object
properties:
password:
type: string
username:
type: string
ModelAndView:
title: ModelAndView
type: object
properties:
empty:
type: boolean
model:
type: object
properties: {}
modelMap:
type: object
additionalProperties:
type: object
properties: {}
reference:
type: boolean
status:
type: string
enum:
- 100 CONTINUE
- 101 SWITCHING_PROTOCOLS
- 102 PROCESSING
- 103 CHECKPOINT
- 200 OK
- 201 CREATED
- 202 ACCEPTED
- 203 NON_AUTHORITATIVE_INFORMATION
- 204 NO_CONTENT
- 205 RESET_CONTENT
- 206 PARTIAL_CONTENT
- 207 MULTI_STATUS
- 208 ALREADY_REPORTED
- 226 IM_USED
- 300 MULTIPLE_CHOICES
- 301 MOVED_PERMANENTLY
- 302 FOUND
- 302 MOVED_TEMPORARILY
- 303 SEE_OTHER
- 304 NOT_MODIFIED
- 305 USE_PROXY
- 307 TEMPORARY_REDIRECT
- 308 PERMANENT_REDIRECT
- 400 BAD_REQUEST
- 401 UNAUTHORIZED
- 402 PAYMENT_REQUIRED
- 403 FORBIDDEN
- 404 NOT_FOUND
- 405 METHOD_NOT_ALLOWED
- 406 NOT_ACCEPTABLE
- 407 PROXY_AUTHENTICATION_REQUIRED
- 408 REQUEST_TIMEOUT
- 409 CONFLICT
- 410 GONE
- 411 LENGTH_REQUIRED
- 412 PRECONDITION_FAILED
- 413 PAYLOAD_TOO_LARGE
- 413 REQUEST_ENTITY_TOO_LARGE
- 414 URI_TOO_LONG
- 414 REQUEST_URI_TOO_LONG
- 415 UNSUPPORTED_MEDIA_TYPE
- 416 REQUESTED_RANGE_NOT_SATISFIABLE
- 417 EXPECTATION_FAILED
- 418 I_AM_A_TEAPOT
- 419 INSUFFICIENT_SPACE_ON_RESOURCE
- 420 METHOD_FAILURE
- 421 DESTINATION_LOCKED
- 422 UNPROCESSABLE_ENTITY
- 423 LOCKED
- 424 FAILED_DEPENDENCY
- 425 TOO_EARLY
- 426 UPGRADE_REQUIRED
- 428 PRECONDITION_REQUIRED
- 429 TOO_MANY_REQUESTS
- 431 REQUEST_HEADER_FIELDS_TOO_LARGE
- 451 UNAVAILABLE_FOR_LEGAL_REASONS
- 500 INTERNAL_SERVER_ERROR
- 501 NOT_IMPLEMENTED
- 502 BAD_GATEWAY
- 503 SERVICE_UNAVAILABLE
- 504 GATEWAY_TIMEOUT
- 505 HTTP_VERSION_NOT_SUPPORTED
- 506 VARIANT_ALSO_NEGOTIATES
- 507 INSUFFICIENT_STORAGE
- 508 LOOP_DETECTED
- 509 BANDWIDTH_LIMIT_EXCEEDED
- 510 NOT_EXTENDED
- 511 NETWORK_AUTHENTICATION_REQUIRED
view:
$ref: '#/components/schemas/View'
viewName:
type: string
PermissionDTO:
title: PermissionDTO
type: object
properties:
id:
type: integer
format: int64
permission:
type: string
RegisterUserAccountDTO:
title: RegisterUserAccountDTO
type: object
properties:
email:
type: string
gender:
type: string
name:
type: string
password:
type: string
surname:
type: string
username:
type: string
RoleDTO:
title: RoleDTO
type: object
properties:
id:
type: integer
format: int64
permissions:
type: array
items:
$ref: '#/components/schemas/PermissionDTO'
role:
type: string
UserDTO:
title: UserDTO
type: object
properties:
addressDTO:
$ref: '#/components/schemas/AddressDTO'
birthDate:
type: string
format: date
contactDTO:
$ref: '#/components/schemas/ContactDTO'
creationDt:
type: string
format: date-time
enabled:
type: boolean
gender:
type: string
id:
type: integer
format: int64
loginDt:
type: string
format: date-time
name:
type: string
note:
type: string
permissions:
type: array
items:
type: string
roles:
type: array
items:
type: string
secured:
type: boolean
surname:
type: string
updatedDt:
type: string
format: date-time
username:
type: string
UserListDTO:
title: UserListDTO
type: object
properties:
userList:
type: array
items:
$ref: '#/components/schemas/UserDTO'
View:
title: View
type: object
properties:
contentType:
type: string
x-original-swagger-version: "2.0"
|