Created
February 16, 2019 15:26
-
-
Save appkr/96481a171b899680d19a8cf1ab3f862c to your computer and use it in GitHub Desktop.
Jhipster Generated Open API Spec Example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| openapi: 3.0.0 | |
| info: | |
| title: jhipsterdemo API | |
| description: jhipsterdemo API documentation | |
| contact: {} | |
| version: '0.0.1' | |
| servers: | |
| - url: http://localhost:8080/ | |
| variables: {} | |
| paths: | |
| /api/account: | |
| get: | |
| tags: | |
| - account-resource | |
| summary: getAccountUsingGET | |
| description: getAccount | |
| operationId: GetAccountUsingGET | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/UserDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| post: | |
| tags: | |
| - account-resource | |
| summary: saveAccountUsingPOST | |
| description: saveAccount | |
| operationId: SaveAccountUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: userDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/UserDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/account/change-password: | |
| post: | |
| tags: | |
| - account-resource | |
| summary: changePasswordUsingPOST | |
| description: changePassword | |
| operationId: ChangePasswordUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: passwordChangeDto | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/PasswordChangeDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/account/reset-password/finish: | |
| post: | |
| tags: | |
| - account-resource | |
| summary: finishPasswordResetUsingPOST | |
| description: finishPasswordReset | |
| operationId: FinishPasswordResetUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: keyAndPassword | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/KeyAndPasswordVM' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/account/reset-password/init: | |
| post: | |
| tags: | |
| - account-resource | |
| summary: requestPasswordResetUsingPOST | |
| description: requestPasswordReset | |
| operationId: RequestPasswordResetUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: mail | |
| content: | |
| text/plain: | |
| schema: | |
| type: string | |
| description: mail | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/activate: | |
| get: | |
| tags: | |
| - account-resource | |
| summary: activateAccountUsingGET | |
| description: activateAccount | |
| operationId: ActivateAccountUsingGET | |
| parameters: | |
| - name: key | |
| in: query | |
| description: key | |
| required: true | |
| style: form | |
| explode: true | |
| schema: | |
| type: string | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/authenticate: | |
| get: | |
| tags: | |
| - account-resource | |
| summary: isAuthenticatedUsingGET | |
| description: isAuthenticated | |
| operationId: IsAuthenticatedUsingGET | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| type: string | |
| description: OK | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| post: | |
| tags: | |
| - user-jwt-controller | |
| summary: authorizeUsingPOST | |
| description: authorize | |
| operationId: AuthorizeUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: loginVM | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/LoginVM' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/JWTToken' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/register: | |
| post: | |
| tags: | |
| - account-resource | |
| summary: registerAccountUsingPOST | |
| description: registerAccount | |
| operationId: RegisterAccountUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: managedUserVM | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ManagedUserVM' | |
| required: true | |
| responses: | |
| 201: | |
| description: Created | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/countries: | |
| get: | |
| tags: | |
| - country-resource | |
| summary: getAllCountriesUsingGET | |
| description: getAllCountries | |
| operationId: GetAllCountriesUsingGET | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/CountryDTO' | |
| description: OK | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| post: | |
| tags: | |
| - country-resource | |
| summary: createCountryUsingPOST | |
| description: createCountry | |
| operationId: CreateCountryUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: countryDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/CountryDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/CountryDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| put: | |
| tags: | |
| - country-resource | |
| summary: updateCountryUsingPUT | |
| description: updateCountry | |
| operationId: UpdateCountryUsingPUT | |
| parameters: [] | |
| requestBody: | |
| description: countryDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/CountryDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/CountryDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/countries/{id}: | |
| get: | |
| tags: | |
| - country-resource | |
| summary: getCountryUsingGET | |
| description: getCountry | |
| operationId: GetCountryUsingGET | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/CountryDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| delete: | |
| tags: | |
| - country-resource | |
| summary: deleteCountryUsingDELETE | |
| description: deleteCountry | |
| operationId: DeleteCountryUsingDELETE | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| deprecated: false | |
| /api/departments: | |
| get: | |
| tags: | |
| - department-resource | |
| summary: getAllDepartmentsUsingGET | |
| description: getAllDepartments | |
| operationId: GetAllDepartmentsUsingGET | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/DepartmentDTO' | |
| description: OK | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| post: | |
| tags: | |
| - department-resource | |
| summary: createDepartmentUsingPOST | |
| description: createDepartment | |
| operationId: CreateDepartmentUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: departmentDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/DepartmentDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/DepartmentDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| put: | |
| tags: | |
| - department-resource | |
| summary: updateDepartmentUsingPUT | |
| description: updateDepartment | |
| operationId: UpdateDepartmentUsingPUT | |
| parameters: [] | |
| requestBody: | |
| description: departmentDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/DepartmentDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/DepartmentDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/departments/{id}: | |
| get: | |
| tags: | |
| - department-resource | |
| summary: getDepartmentUsingGET | |
| description: getDepartment | |
| operationId: GetDepartmentUsingGET | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/DepartmentDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| delete: | |
| tags: | |
| - department-resource | |
| summary: deleteDepartmentUsingDELETE | |
| description: deleteDepartment | |
| operationId: DeleteDepartmentUsingDELETE | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| deprecated: false | |
| /api/employees: | |
| get: | |
| tags: | |
| - employee-resource | |
| summary: getAllEmployeesUsingGET | |
| description: getAllEmployees | |
| operationId: GetAllEmployeesUsingGET | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| style: form | |
| explode: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| style: form | |
| explode: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: sort | |
| in: query | |
| description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' | |
| style: form | |
| explode: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/EmployeeDTO' | |
| description: OK | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| post: | |
| tags: | |
| - employee-resource | |
| summary: createEmployeeUsingPOST | |
| description: createEmployee | |
| operationId: CreateEmployeeUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: employeeDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EmployeeDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/EmployeeDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| put: | |
| tags: | |
| - employee-resource | |
| summary: updateEmployeeUsingPUT | |
| description: updateEmployee | |
| operationId: UpdateEmployeeUsingPUT | |
| parameters: [] | |
| requestBody: | |
| description: employeeDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EmployeeDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/EmployeeDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/employees/{id}: | |
| get: | |
| tags: | |
| - employee-resource | |
| summary: getEmployeeUsingGET | |
| description: getEmployee | |
| operationId: GetEmployeeUsingGET | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/EmployeeDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| delete: | |
| tags: | |
| - employee-resource | |
| summary: deleteEmployeeUsingDELETE | |
| description: deleteEmployee | |
| operationId: DeleteEmployeeUsingDELETE | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| deprecated: false | |
| /api/job-histories: | |
| get: | |
| tags: | |
| - job-history-resource | |
| summary: getAllJobHistoriesUsingGET | |
| description: getAllJobHistories | |
| operationId: GetAllJobHistoriesUsingGET | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| style: form | |
| explode: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| style: form | |
| explode: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: sort | |
| in: query | |
| description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' | |
| style: form | |
| explode: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/JobHistoryDTO' | |
| description: OK | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| post: | |
| tags: | |
| - job-history-resource | |
| summary: createJobHistoryUsingPOST | |
| description: createJobHistory | |
| operationId: CreateJobHistoryUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: jobHistoryDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/JobHistoryDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/JobHistoryDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| put: | |
| tags: | |
| - job-history-resource | |
| summary: updateJobHistoryUsingPUT | |
| description: updateJobHistory | |
| operationId: UpdateJobHistoryUsingPUT | |
| parameters: [] | |
| requestBody: | |
| description: jobHistoryDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/JobHistoryDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/JobHistoryDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/job-histories/{id}: | |
| get: | |
| tags: | |
| - job-history-resource | |
| summary: getJobHistoryUsingGET | |
| description: getJobHistory | |
| operationId: GetJobHistoryUsingGET | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/JobHistoryDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| delete: | |
| tags: | |
| - job-history-resource | |
| summary: deleteJobHistoryUsingDELETE | |
| description: deleteJobHistory | |
| operationId: DeleteJobHistoryUsingDELETE | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| deprecated: false | |
| /api/jobs: | |
| get: | |
| tags: | |
| - job-resource | |
| summary: getAllJobsUsingGET | |
| description: getAllJobs | |
| operationId: GetAllJobsUsingGET | |
| parameters: | |
| - name: eagerload | |
| in: query | |
| description: eagerload | |
| style: form | |
| explode: true | |
| schema: | |
| type: boolean | |
| default: false | |
| example: false | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| style: form | |
| explode: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| style: form | |
| explode: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: sort | |
| in: query | |
| description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' | |
| style: form | |
| explode: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/JobDTO' | |
| description: OK | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| post: | |
| tags: | |
| - job-resource | |
| summary: createJobUsingPOST | |
| description: createJob | |
| operationId: CreateJobUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: jobDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/JobDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/JobDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| put: | |
| tags: | |
| - job-resource | |
| summary: updateJobUsingPUT | |
| description: updateJob | |
| operationId: UpdateJobUsingPUT | |
| parameters: [] | |
| requestBody: | |
| description: jobDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/JobDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/JobDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/jobs/{id}: | |
| get: | |
| tags: | |
| - job-resource | |
| summary: getJobUsingGET | |
| description: getJob | |
| operationId: GetJobUsingGET | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/JobDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| delete: | |
| tags: | |
| - job-resource | |
| summary: deleteJobUsingDELETE | |
| description: deleteJob | |
| operationId: DeleteJobUsingDELETE | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| deprecated: false | |
| /api/locations: | |
| get: | |
| tags: | |
| - location-resource | |
| summary: getAllLocationsUsingGET | |
| description: getAllLocations | |
| operationId: GetAllLocationsUsingGET | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/LocationDTO' | |
| description: OK | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| post: | |
| tags: | |
| - location-resource | |
| summary: createLocationUsingPOST | |
| description: createLocation | |
| operationId: CreateLocationUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: locationDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/LocationDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/LocationDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| put: | |
| tags: | |
| - location-resource | |
| summary: updateLocationUsingPUT | |
| description: updateLocation | |
| operationId: UpdateLocationUsingPUT | |
| parameters: [] | |
| requestBody: | |
| description: locationDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/LocationDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/LocationDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/locations/{id}: | |
| get: | |
| tags: | |
| - location-resource | |
| summary: getLocationUsingGET | |
| description: getLocation | |
| operationId: GetLocationUsingGET | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/LocationDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| delete: | |
| tags: | |
| - location-resource | |
| summary: deleteLocationUsingDELETE | |
| description: deleteLocation | |
| operationId: DeleteLocationUsingDELETE | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| deprecated: false | |
| /api/regions: | |
| get: | |
| tags: | |
| - region-resource | |
| summary: getAllRegionsUsingGET | |
| description: getAllRegions | |
| operationId: GetAllRegionsUsingGET | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/RegionDTO' | |
| description: OK | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| post: | |
| tags: | |
| - region-resource | |
| summary: createRegionUsingPOST | |
| description: createRegion | |
| operationId: CreateRegionUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: regionDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/RegionDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/RegionDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| put: | |
| tags: | |
| - region-resource | |
| summary: updateRegionUsingPUT | |
| description: updateRegion | |
| operationId: UpdateRegionUsingPUT | |
| parameters: [] | |
| requestBody: | |
| description: regionDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/RegionDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/RegionDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/regions/{id}: | |
| get: | |
| tags: | |
| - region-resource | |
| summary: getRegionUsingGET | |
| description: getRegion | |
| operationId: GetRegionUsingGET | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/RegionDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| delete: | |
| tags: | |
| - region-resource | |
| summary: deleteRegionUsingDELETE | |
| description: deleteRegion | |
| operationId: DeleteRegionUsingDELETE | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| deprecated: false | |
| /api/tasks: | |
| get: | |
| tags: | |
| - task-resource | |
| summary: getAllTasksUsingGET | |
| description: getAllTasks | |
| operationId: GetAllTasksUsingGET | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TaskDTO' | |
| description: OK | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| post: | |
| tags: | |
| - task-resource | |
| summary: createTaskUsingPOST | |
| description: createTask | |
| operationId: CreateTaskUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: taskDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/TaskDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/TaskDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| put: | |
| tags: | |
| - task-resource | |
| summary: updateTaskUsingPUT | |
| description: updateTask | |
| operationId: UpdateTaskUsingPUT | |
| parameters: [] | |
| requestBody: | |
| description: taskDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/TaskDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/TaskDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/tasks/{id}: | |
| get: | |
| tags: | |
| - task-resource | |
| summary: getTaskUsingGET | |
| description: getTask | |
| operationId: GetTaskUsingGET | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/TaskDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| delete: | |
| tags: | |
| - task-resource | |
| summary: deleteTaskUsingDELETE | |
| description: deleteTask | |
| operationId: DeleteTaskUsingDELETE | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| deprecated: false | |
| /api/users: | |
| get: | |
| tags: | |
| - user-resource | |
| summary: getAllUsersUsingGET | |
| description: getAllUsers | |
| operationId: GetAllUsersUsingGET | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| style: form | |
| explode: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| style: form | |
| explode: true | |
| schema: | |
| type: integer | |
| format: int32 | |
| - name: sort | |
| in: query | |
| description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.' | |
| style: form | |
| explode: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/UserDTO' | |
| description: OK | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| post: | |
| tags: | |
| - user-resource | |
| summary: createUserUsingPOST | |
| description: createUser | |
| operationId: CreateUserUsingPOST | |
| parameters: [] | |
| requestBody: | |
| description: userDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/UserDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/User' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| put: | |
| tags: | |
| - user-resource | |
| summary: updateUserUsingPUT | |
| description: updateUser | |
| operationId: UpdateUserUsingPUT | |
| parameters: [] | |
| requestBody: | |
| description: userDTO | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/UserDTO' | |
| required: true | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/UserDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/users/authorities: | |
| get: | |
| tags: | |
| - user-resource | |
| summary: getAuthoritiesUsingGET | |
| description: getAuthorities | |
| operationId: GetAuthoritiesUsingGET | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| description: OK | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| /api/users/{login}: | |
| get: | |
| tags: | |
| - user-resource | |
| summary: getUserUsingGET | |
| description: getUser | |
| operationId: GetUserUsingGET | |
| parameters: | |
| - name: login | |
| in: path | |
| description: login | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: string | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/UserDTO' | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| 404: | |
| description: Not Found | |
| deprecated: false | |
| delete: | |
| tags: | |
| - user-resource | |
| summary: deleteUserUsingDELETE | |
| description: deleteUser | |
| operationId: DeleteUserUsingDELETE | |
| parameters: | |
| - name: login | |
| in: path | |
| description: login | |
| required: true | |
| style: simple | |
| explode: false | |
| schema: | |
| type: string | |
| responses: | |
| 200: | |
| description: OK | |
| headers: {} | |
| 401: | |
| description: Unauthorized | |
| 403: | |
| description: Forbidden | |
| deprecated: false | |
| components: | |
| schemas: | |
| CountryDTO: | |
| title: CountryDTO | |
| type: object | |
| properties: | |
| countryName: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| regionId: | |
| type: integer | |
| format: int64 | |
| DepartmentDTO: | |
| title: DepartmentDTO | |
| required: | |
| - departmentName | |
| type: object | |
| properties: | |
| departmentName: | |
| type: string | |
| id: | |
| type: integer | |
| description: A relationship | |
| format: int64 | |
| locationId: | |
| type: integer | |
| format: int64 | |
| EmployeeDTO: | |
| title: EmployeeDTO | |
| type: object | |
| properties: | |
| commissionPct: | |
| type: integer | |
| format: int64 | |
| departmentId: | |
| type: integer | |
| format: int64 | |
| email: | |
| type: string | |
| firstName: | |
| type: string | |
| description: The firstname attribute. | |
| hireDate: | |
| type: string | |
| format: date-time | |
| id: | |
| type: integer | |
| format: int64 | |
| lastName: | |
| type: string | |
| managerId: | |
| type: integer | |
| format: int64 | |
| phoneNumber: | |
| type: string | |
| salary: | |
| type: integer | |
| format: int64 | |
| description: The Employee entity. | |
| JWTToken: | |
| title: JWTToken | |
| type: object | |
| properties: | |
| id_token: | |
| type: string | |
| JobDTO: | |
| title: JobDTO | |
| type: object | |
| properties: | |
| employeeId: | |
| type: integer | |
| format: int64 | |
| id: | |
| type: integer | |
| format: int64 | |
| jobTitle: | |
| type: string | |
| maxSalary: | |
| type: integer | |
| format: int64 | |
| minSalary: | |
| type: integer | |
| format: int64 | |
| tasks: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TaskDTO' | |
| description: '' | |
| JobHistoryDTO: | |
| title: JobHistoryDTO | |
| type: object | |
| properties: | |
| departmentId: | |
| type: integer | |
| format: int64 | |
| employeeId: | |
| type: integer | |
| format: int64 | |
| endDate: | |
| type: string | |
| format: date-time | |
| id: | |
| type: integer | |
| format: int64 | |
| jobId: | |
| type: integer | |
| format: int64 | |
| language: | |
| $ref: '#/components/schemas/Language' | |
| startDate: | |
| type: string | |
| format: date-time | |
| KeyAndPasswordVM: | |
| title: KeyAndPasswordVM | |
| type: object | |
| properties: | |
| key: | |
| type: string | |
| newPassword: | |
| type: string | |
| LocationDTO: | |
| title: LocationDTO | |
| type: object | |
| properties: | |
| city: | |
| type: string | |
| countryId: | |
| type: integer | |
| format: int64 | |
| id: | |
| type: integer | |
| format: int64 | |
| postalCode: | |
| type: string | |
| stateProvince: | |
| type: string | |
| streetAddress: | |
| type: string | |
| description: not an ignored comment | |
| LoginVM: | |
| title: LoginVM | |
| required: | |
| - password | |
| - username | |
| type: object | |
| properties: | |
| password: | |
| maxLength: 100 | |
| minLength: 4 | |
| type: string | |
| rememberMe: | |
| type: boolean | |
| username: | |
| maxLength: 50 | |
| minLength: 1 | |
| type: string | |
| ManagedUserVM: | |
| title: ManagedUserVM | |
| type: object | |
| properties: | |
| activated: | |
| type: boolean | |
| authorities: | |
| type: array | |
| items: | |
| type: string | |
| description: '' | |
| createdBy: | |
| type: string | |
| createdDate: | |
| type: string | |
| format: date-time | |
| email: | |
| maxLength: 254 | |
| minLength: 5 | |
| type: string | |
| firstName: | |
| maxLength: 50 | |
| minLength: 0 | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| imageUrl: | |
| maxLength: 256 | |
| minLength: 0 | |
| type: string | |
| langKey: | |
| maxLength: 6 | |
| minLength: 2 | |
| type: string | |
| lastModifiedBy: | |
| type: string | |
| lastModifiedDate: | |
| type: string | |
| format: date-time | |
| lastName: | |
| maxLength: 50 | |
| minLength: 0 | |
| type: string | |
| login: | |
| maxLength: 50 | |
| minLength: 1 | |
| pattern: ^[_.@A-Za-z0-9-]*$ | |
| type: string | |
| password: | |
| maxLength: 100 | |
| minLength: 4 | |
| type: string | |
| PasswordChangeDTO: | |
| title: PasswordChangeDTO | |
| type: object | |
| properties: | |
| currentPassword: | |
| type: string | |
| newPassword: | |
| type: string | |
| RegionDTO: | |
| title: RegionDTO | |
| type: object | |
| properties: | |
| id: | |
| type: integer | |
| format: int64 | |
| regionName: | |
| type: string | |
| TaskDTO: | |
| title: TaskDTO | |
| type: object | |
| properties: | |
| description: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| title: | |
| type: string | |
| description: Task entity. @author The JHipster team. | |
| User: | |
| title: User | |
| required: | |
| - activated | |
| - login | |
| type: object | |
| properties: | |
| activated: | |
| type: boolean | |
| email: | |
| maxLength: 254 | |
| minLength: 5 | |
| type: string | |
| firstName: | |
| maxLength: 50 | |
| minLength: 0 | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| imageUrl: | |
| maxLength: 256 | |
| minLength: 0 | |
| type: string | |
| langKey: | |
| maxLength: 6 | |
| minLength: 2 | |
| type: string | |
| lastName: | |
| maxLength: 50 | |
| minLength: 0 | |
| type: string | |
| login: | |
| maxLength: 50 | |
| minLength: 1 | |
| pattern: ^[_.@A-Za-z0-9-]*$ | |
| type: string | |
| resetDate: | |
| type: string | |
| format: date-time | |
| UserDTO: | |
| title: UserDTO | |
| type: object | |
| properties: | |
| activated: | |
| type: boolean | |
| authorities: | |
| type: array | |
| items: | |
| type: string | |
| description: '' | |
| createdBy: | |
| type: string | |
| createdDate: | |
| type: string | |
| format: date-time | |
| email: | |
| maxLength: 254 | |
| minLength: 5 | |
| type: string | |
| firstName: | |
| maxLength: 50 | |
| minLength: 0 | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| imageUrl: | |
| maxLength: 256 | |
| minLength: 0 | |
| type: string | |
| langKey: | |
| maxLength: 6 | |
| minLength: 2 | |
| type: string | |
| lastModifiedBy: | |
| type: string | |
| lastModifiedDate: | |
| type: string | |
| format: date-time | |
| lastName: | |
| maxLength: 50 | |
| minLength: 0 | |
| type: string | |
| login: | |
| maxLength: 50 | |
| minLength: 1 | |
| pattern: ^[_.@A-Za-z0-9-]*$ | |
| type: string | |
| Language: | |
| title: Language | |
| enum: | |
| - FRENCH | |
| - ENGLISH | |
| - SPANISH | |
| type: string | |
| example: FRENCH | |
| tags: | |
| - name: account-resource | |
| description: Account Resource | |
| - name: country-resource | |
| description: Country Resource | |
| - name: department-resource | |
| description: Department Resource | |
| - name: employee-resource | |
| description: Employee Resource | |
| - name: job-history-resource | |
| description: Job History Resource | |
| - name: job-resource | |
| description: Job Resource | |
| - name: location-resource | |
| description: Location Resource | |
| - name: region-resource | |
| description: Region Resource | |
| - name: task-resource | |
| description: Task Resource | |
| - name: user-jwt-controller | |
| description: User JWT Controller | |
| - name: user-resource | |
| description: User Resource |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment