Created
October 9, 2017 06:41
-
-
Save dynamicguy/4ebb0662bd3092a7cd6815c35ac25ba1 to your computer and use it in GitHub Desktop.
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
| swagger: '2.0' | |
| info: | |
| description: Skillshill API documentation | |
| version: 0.0.9 | |
| title: Skillshill API | |
| termsOfService: 'http://skillshill.com/#/terms' | |
| contact: | |
| name: Site Master | |
| url: 'http://skillshill.com/#/contact' | |
| email: [email protected] | |
| license: | |
| name: All rights reserved | |
| url: 'http://skillshill.com/#/license' | |
| host: 'localhost:9060' | |
| basePath: / | |
| tags: | |
| - name: course-of-the-day-resource | |
| description: Course Of The Day Resource | |
| - name: user-jwt-controller | |
| description: User JWT Controller | |
| - name: location-resource | |
| description: Location Resource | |
| - name: operation-resource | |
| description: Operation Resource | |
| - name: webpage-resource | |
| description: Webpage Resource | |
| - name: label-resource | |
| description: Label Resource | |
| - name: cat-resource | |
| description: Cat Resource | |
| - name: guide-resource | |
| description: Guide Resource | |
| - name: company-resource | |
| description: Company Resource | |
| - name: config-resource | |
| description: Config Resource | |
| - name: job-resource | |
| description: Job Resource | |
| - name: report-resource | |
| description: Report Resource | |
| - name: comment-resource | |
| description: Comment Resource | |
| - name: profile-info-resource | |
| description: Profile Info Resource | |
| - name: account-resource | |
| description: Account Resource | |
| - name: city-resource | |
| description: City Resource | |
| - name: tip-resource | |
| description: Tip Resource | |
| - name: user-resource | |
| description: User Resource | |
| - name: bookmark-resource | |
| description: Bookmark Resource | |
| - name: country-resource | |
| description: Country Resource | |
| - name: doodle-resource | |
| description: Doodle Resource | |
| - name: author-resource | |
| description: Author Resource | |
| - name: region-resource | |
| description: Region Resource | |
| - name: bank-account-resource | |
| description: Bank Account Resource | |
| paths: | |
| /api/_search/comments: | |
| get: | |
| tags: | |
| - comment-resource | |
| summary: searchComments | |
| operationId: searchCommentsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: query | |
| in: query | |
| description: query | |
| required: true | |
| type: string | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CommentDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/_search/jobs: | |
| get: | |
| tags: | |
| - job-resource | |
| summary: searchJobs | |
| operationId: searchJobsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: query | |
| in: query | |
| description: query | |
| required: true | |
| type: string | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/SolrJob' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/_search/webpages: | |
| get: | |
| tags: | |
| - webpage-resource | |
| summary: searchWebpages | |
| operationId: searchWebpagesUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: query | |
| in: query | |
| description: query | |
| required: true | |
| type: string | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/SolrWebpage' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/account: | |
| get: | |
| tags: | |
| - account-resource | |
| summary: getAccount | |
| operationId: getAccountUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/UserDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - account-resource | |
| summary: saveAccount | |
| operationId: saveAccountUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: userDTO | |
| description: userDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/UserDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: object | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/account/change-password: | |
| post: | |
| tags: | |
| - account-resource | |
| summary: changePassword | |
| operationId: changePasswordUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - text/plain | |
| parameters: | |
| - in: body | |
| name: password | |
| description: password | |
| required: true | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: object | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/account/reset-password/finish: | |
| post: | |
| tags: | |
| - account-resource | |
| summary: finishPasswordReset | |
| operationId: finishPasswordResetUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - text/plain | |
| parameters: | |
| - in: body | |
| name: keyAndPassword | |
| description: keyAndPassword | |
| required: true | |
| schema: | |
| $ref: '#/definitions/KeyAndPasswordVM' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/account/reset-password/init: | |
| post: | |
| tags: | |
| - account-resource | |
| summary: requestPasswordReset | |
| operationId: requestPasswordResetUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - text/plain | |
| parameters: | |
| - in: body | |
| name: mail | |
| description: mail | |
| required: true | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: object | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/activate: | |
| get: | |
| tags: | |
| - account-resource | |
| summary: activateAccount | |
| operationId: activateAccountUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: key | |
| in: query | |
| description: key | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/authenticate: | |
| get: | |
| tags: | |
| - account-resource | |
| summary: isAuthenticated | |
| operationId: isAuthenticatedUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - user-jwt-controller | |
| summary: authorize | |
| operationId: authorizeUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: loginVM | |
| description: loginVM | |
| required: true | |
| schema: | |
| $ref: '#/definitions/LoginVM' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/ResponseEntity' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/authors: | |
| get: | |
| tags: | |
| - author-resource | |
| summary: getAllAuthors | |
| operationId: getAllAuthorsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/AuthorDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - author-resource | |
| summary: createAuthor | |
| operationId: createAuthorUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: authorDTO | |
| description: authorDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/AuthorDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/AuthorDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - author-resource | |
| summary: updateAuthor | |
| operationId: updateAuthorUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: authorDTO | |
| description: authorDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/AuthorDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/AuthorDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/authors/{id}': | |
| get: | |
| tags: | |
| - author-resource | |
| summary: getAuthor | |
| operationId: getAuthorUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/AuthorDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - author-resource | |
| summary: deleteAuthor | |
| operationId: deleteAuthorUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/bank-accounts: | |
| get: | |
| tags: | |
| - bank-account-resource | |
| summary: getAllBankAccounts | |
| operationId: getAllBankAccountsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/BankAccountDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - bank-account-resource | |
| summary: createBankAccount | |
| operationId: createBankAccountUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: bankAccountDTO | |
| description: bankAccountDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/BankAccountDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/BankAccountDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - bank-account-resource | |
| summary: updateBankAccount | |
| operationId: updateBankAccountUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: bankAccountDTO | |
| description: bankAccountDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/BankAccountDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/BankAccountDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/bank-accounts/{id}': | |
| get: | |
| tags: | |
| - bank-account-resource | |
| summary: getBankAccount | |
| operationId: getBankAccountUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/BankAccountDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - bank-account-resource | |
| summary: deleteBankAccount | |
| operationId: deleteBankAccountUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/bookmarks: | |
| get: | |
| tags: | |
| - bookmark-resource | |
| summary: getAllBookmarks | |
| operationId: getAllBookmarksUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/BookmarkDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - bookmark-resource | |
| summary: createBookmark | |
| operationId: createBookmarkUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: bookmarkDTO | |
| description: bookmarkDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/BookmarkDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/BookmarkDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - bookmark-resource | |
| summary: updateBookmark | |
| operationId: updateBookmarkUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: bookmarkDTO | |
| description: bookmarkDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/BookmarkDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/BookmarkDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/bookmarks/{id}': | |
| get: | |
| tags: | |
| - bookmark-resource | |
| summary: getBookmark | |
| operationId: getBookmarkUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/BookmarkDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - bookmark-resource | |
| summary: deleteBookmark | |
| operationId: deleteBookmarkUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/cats: | |
| get: | |
| tags: | |
| - cat-resource | |
| summary: getAllCats | |
| operationId: getAllCatsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CatDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - cat-resource | |
| summary: createCat | |
| operationId: createCatUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: catDTO | |
| description: catDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CatDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CatDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - cat-resource | |
| summary: updateCat | |
| operationId: updateCatUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: catDTO | |
| description: catDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CatDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CatDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/cats/status/{status}': | |
| get: | |
| tags: | |
| - cat-resource | |
| summary: getAllByStatus | |
| operationId: getAllByStatusUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: status | |
| in: path | |
| description: status | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/Cat' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/cats/{id}': | |
| get: | |
| tags: | |
| - cat-resource | |
| summary: getCat | |
| operationId: getCatUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CatDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - cat-resource | |
| summary: deleteCat | |
| operationId: deleteCatUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/cities: | |
| get: | |
| tags: | |
| - city-resource | |
| summary: getAllCities | |
| operationId: getAllCitiesUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CityDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - city-resource | |
| summary: createCity | |
| operationId: createCityUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: cityDTO | |
| description: cityDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CityDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CityDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - city-resource | |
| summary: updateCity | |
| operationId: updateCityUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: cityDTO | |
| description: cityDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CityDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CityDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/cities/{id}': | |
| get: | |
| tags: | |
| - city-resource | |
| summary: getCity | |
| operationId: getCityUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CityDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - city-resource | |
| summary: deleteCity | |
| operationId: deleteCityUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/comments: | |
| get: | |
| tags: | |
| - comment-resource | |
| summary: getAllComments | |
| operationId: getAllCommentsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CommentDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - comment-resource | |
| summary: createComment | |
| operationId: createCommentUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: commentDTO | |
| description: commentDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CommentDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CommentDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - comment-resource | |
| summary: updateComment | |
| operationId: updateCommentUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: commentDTO | |
| description: commentDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CommentDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CommentDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/comments/by_webpage/{webpageId}': | |
| get: | |
| tags: | |
| - comment-resource | |
| summary: getAllCommentsByWebpage | |
| operationId: getAllCommentsByWebpageUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: webpageId | |
| in: path | |
| description: webpageId | |
| required: true | |
| type: integer | |
| format: int64 | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CommentDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/comments/my: | |
| get: | |
| tags: | |
| - comment-resource | |
| summary: getMyComments | |
| operationId: getMyCommentsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CommentDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/comments/{id}': | |
| get: | |
| tags: | |
| - comment-resource | |
| summary: getComment | |
| operationId: getCommentUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CommentDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - comment-resource | |
| summary: deleteComment | |
| operationId: deleteCommentUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/companies: | |
| get: | |
| tags: | |
| - company-resource | |
| summary: getAllCompanies | |
| operationId: getAllCompaniesUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CompanyDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - company-resource | |
| summary: createCompany | |
| operationId: createCompanyUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: companyDTO | |
| description: companyDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CompanyDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CompanyDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - company-resource | |
| summary: updateCompany | |
| operationId: updateCompanyUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: companyDTO | |
| description: companyDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CompanyDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CompanyDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/companies/{id}': | |
| get: | |
| tags: | |
| - company-resource | |
| summary: getCompany | |
| operationId: getCompanyUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CompanyDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - company-resource | |
| summary: deleteCompany | |
| operationId: deleteCompanyUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/configs: | |
| get: | |
| tags: | |
| - config-resource | |
| summary: getAllConfigs | |
| operationId: getAllConfigsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/ConfigDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - config-resource | |
| summary: createConfig | |
| operationId: createConfigUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: configDTO | |
| description: configDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/ConfigDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/ConfigDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - config-resource | |
| summary: updateConfig | |
| operationId: updateConfigUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: configDTO | |
| description: configDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/ConfigDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/ConfigDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/configs/key/{key}': | |
| get: | |
| tags: | |
| - config-resource | |
| summary: getConfigByKey | |
| operationId: getConfigByKeyUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: key | |
| in: path | |
| description: key | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/ConfigDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/configs/{id}': | |
| get: | |
| tags: | |
| - config-resource | |
| summary: getConfig | |
| operationId: getConfigUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/ConfigDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - config-resource | |
| summary: deleteConfig | |
| operationId: deleteConfigUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/countries: | |
| get: | |
| tags: | |
| - country-resource | |
| summary: getAllCountries | |
| operationId: getAllCountriesUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CountryDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - country-resource | |
| summary: createCountry | |
| operationId: createCountryUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: countryDTO | |
| description: countryDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CountryDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CountryDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - country-resource | |
| summary: updateCountry | |
| operationId: updateCountryUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: countryDTO | |
| description: countryDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CountryDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CountryDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/countries/{id}': | |
| get: | |
| tags: | |
| - country-resource | |
| summary: getCountry | |
| operationId: getCountryUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CountryDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - country-resource | |
| summary: deleteCountry | |
| operationId: deleteCountryUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/course-of-the-days: | |
| get: | |
| tags: | |
| - course-of-the-day-resource | |
| summary: getAllCourseOfTheDays | |
| operationId: getAllCourseOfTheDaysUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CourseOfTheDayDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - course-of-the-day-resource | |
| summary: createCourseOfTheDay | |
| operationId: createCourseOfTheDayUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: courseOfTheDayDTO | |
| description: courseOfTheDayDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CourseOfTheDayDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CourseOfTheDayDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - course-of-the-day-resource | |
| summary: updateCourseOfTheDay | |
| operationId: updateCourseOfTheDayUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: courseOfTheDayDTO | |
| description: courseOfTheDayDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/CourseOfTheDayDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CourseOfTheDayDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/course-of-the-days/all_webpages: | |
| get: | |
| tags: | |
| - course-of-the-day-resource | |
| summary: getAllCourseOfTheDaysWebpagesId | |
| operationId: getAllCourseOfTheDaysWebpagesIdUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| format: int64 | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/course-of-the-days/by_webpage/{webpageId}': | |
| get: | |
| tags: | |
| - course-of-the-day-resource | |
| summary: getCourseOfTheDayByWebpage | |
| operationId: getCourseOfTheDayByWebpageUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: webpageId | |
| in: path | |
| description: webpageId | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CourseOfTheDayDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/course-of-the-days/today: | |
| get: | |
| tags: | |
| - course-of-the-day-resource | |
| summary: getCourseOfTheDayForToday | |
| operationId: getCourseOfTheDayForTodayUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CourseOfTheDay' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/course-of-the-days/{id}': | |
| get: | |
| tags: | |
| - course-of-the-day-resource | |
| summary: getCourseOfTheDay | |
| operationId: getCourseOfTheDayUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/CourseOfTheDayDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - course-of-the-day-resource | |
| summary: deleteCourseOfTheDay | |
| operationId: deleteCourseOfTheDayUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/doodles: | |
| get: | |
| tags: | |
| - doodle-resource | |
| summary: getAllDoodles | |
| operationId: getAllDoodlesUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/DoodleDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - doodle-resource | |
| summary: createDoodle | |
| operationId: createDoodleUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: doodleDTO | |
| description: doodleDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/DoodleDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/DoodleDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - doodle-resource | |
| summary: updateDoodle | |
| operationId: updateDoodleUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: doodleDTO | |
| description: doodleDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/DoodleDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/DoodleDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/doodles/{id}': | |
| get: | |
| tags: | |
| - doodle-resource | |
| summary: getDoodle | |
| operationId: getDoodleUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/DoodleDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - doodle-resource | |
| summary: deleteDoodle | |
| operationId: deleteDoodleUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/guides: | |
| get: | |
| tags: | |
| - guide-resource | |
| summary: getAllGuides | |
| operationId: getAllGuidesUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/GuideDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - guide-resource | |
| summary: createGuide | |
| operationId: createGuideUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: guideDTO | |
| description: guideDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/GuideDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/GuideDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - guide-resource | |
| summary: updateGuide | |
| operationId: updateGuideUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: guideDTO | |
| description: guideDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/GuideDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/GuideDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/guides/{id}': | |
| get: | |
| tags: | |
| - guide-resource | |
| summary: getGuide | |
| operationId: getGuideUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/GuideDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - guide-resource | |
| summary: deleteGuide | |
| operationId: deleteGuideUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/jobs: | |
| get: | |
| tags: | |
| - job-resource | |
| summary: getAllJobs | |
| operationId: getAllJobsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/JobDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - job-resource | |
| summary: createJob | |
| operationId: createJobUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: jobDTO | |
| description: jobDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/JobDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/JobDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - job-resource | |
| summary: updateJob | |
| operationId: updateJobUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: jobDTO | |
| description: jobDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/JobDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/JobDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/jobs/recommend-for-document: | |
| get: | |
| tags: | |
| - job-resource | |
| summary: getRecommendationsForDocument | |
| operationId: getRecommendationsForDocumentUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: query | |
| description: id | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/RecommendationDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/jobs/recommend-for-query: | |
| get: | |
| tags: | |
| - job-resource | |
| summary: getRecommendationsForQuery | |
| operationId: getRecommendationsForQueryUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: q | |
| in: query | |
| description: q | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/RecommendationDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/jobs/search_jobs: | |
| get: | |
| tags: | |
| - job-resource | |
| summary: searchJobsAdvanced | |
| operationId: searchJobsAdvancedUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: q | |
| in: query | |
| description: q | |
| required: true | |
| type: string | |
| - name: fq | |
| in: query | |
| description: fq | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| - name: page | |
| in: query | |
| description: page | |
| required: false | |
| type: integer | |
| default: 1 | |
| format: int32 | |
| - name: per_page | |
| in: query | |
| description: per_page | |
| required: false | |
| type: integer | |
| default: 10 | |
| format: int32 | |
| - name: sort | |
| in: query | |
| description: sort | |
| required: false | |
| type: string | |
| default: score | |
| - name: dir | |
| in: query | |
| description: dir | |
| required: false | |
| type: string | |
| default: desc | |
| - name: User-Agent | |
| in: header | |
| description: User-Agent | |
| required: true | |
| type: string | |
| default: foo | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/JobAPIResponse' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/jobs/solr: | |
| get: | |
| tags: | |
| - job-resource | |
| summary: getDocumentFromSolr | |
| operationId: getDocumentFromSolrUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: query | |
| description: id | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/JobDoc' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - job-resource | |
| summary: deleteJobDTOFromSolr | |
| operationId: deleteJobDTOFromSolrUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: query | |
| description: id | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/jobs/suggest: | |
| get: | |
| tags: | |
| - job-resource | |
| summary: suggest | |
| operationId: suggestUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: q | |
| in: query | |
| description: q | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/MySuggester' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/jobs/{id}': | |
| get: | |
| tags: | |
| - job-resource | |
| summary: getJob | |
| operationId: getJobUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/JobDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - job-resource | |
| summary: deleteJob | |
| operationId: deleteJobUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/labels: | |
| get: | |
| tags: | |
| - label-resource | |
| summary: getAllLabels | |
| operationId: getAllLabelsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/LabelDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - label-resource | |
| summary: createLabel | |
| operationId: createLabelUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: labelDTO | |
| description: labelDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/LabelDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/LabelDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - label-resource | |
| summary: updateLabel | |
| operationId: updateLabelUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: labelDTO | |
| description: labelDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/LabelDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/LabelDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/labels/{id}': | |
| get: | |
| tags: | |
| - label-resource | |
| summary: getLabel | |
| operationId: getLabelUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/LabelDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - label-resource | |
| summary: deleteLabel | |
| operationId: deleteLabelUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/locations: | |
| get: | |
| tags: | |
| - location-resource | |
| summary: getAllLocations | |
| operationId: getAllLocationsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/LocationDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - location-resource | |
| summary: createLocation | |
| operationId: createLocationUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: locationDTO | |
| description: locationDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/LocationDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/LocationDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - location-resource | |
| summary: updateLocation | |
| operationId: updateLocationUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: locationDTO | |
| description: locationDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/LocationDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/LocationDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/locations/{id}': | |
| get: | |
| tags: | |
| - location-resource | |
| summary: getLocation | |
| operationId: getLocationUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/LocationDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - location-resource | |
| summary: deleteLocation | |
| operationId: deleteLocationUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/operations: | |
| get: | |
| tags: | |
| - operation-resource | |
| summary: getAllOperations | |
| operationId: getAllOperationsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/OperationDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - operation-resource | |
| summary: createOperation | |
| operationId: createOperationUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: operationDTO | |
| description: operationDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/OperationDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/OperationDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - operation-resource | |
| summary: updateOperation | |
| operationId: updateOperationUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: operationDTO | |
| description: operationDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/OperationDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/OperationDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/operations/{id}': | |
| get: | |
| tags: | |
| - operation-resource | |
| summary: getOperation | |
| operationId: getOperationUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/OperationDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - operation-resource | |
| summary: deleteOperation | |
| operationId: deleteOperationUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/profile-info: | |
| get: | |
| tags: | |
| - profile-info-resource | |
| summary: getActiveProfiles | |
| operationId: getActiveProfilesUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/ProfileInfoVM' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/regions: | |
| get: | |
| tags: | |
| - region-resource | |
| summary: getAllRegions | |
| operationId: getAllRegionsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/RegionDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - region-resource | |
| summary: createRegion | |
| operationId: createRegionUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: regionDTO | |
| description: regionDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/RegionDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/RegionDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - region-resource | |
| summary: updateRegion | |
| operationId: updateRegionUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: regionDTO | |
| description: regionDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/RegionDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/RegionDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/regions/{id}': | |
| get: | |
| tags: | |
| - region-resource | |
| summary: getRegion | |
| operationId: getRegionUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/RegionDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - region-resource | |
| summary: deleteRegion | |
| operationId: deleteRegionUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/register: | |
| post: | |
| tags: | |
| - account-resource | |
| summary: registerAccount | |
| operationId: registerAccountUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - application/json | |
| - text/plain | |
| parameters: | |
| - in: body | |
| name: managedUserVM | |
| description: managedUserVM | |
| required: true | |
| schema: | |
| $ref: '#/definitions/ManagedUserVM' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: object | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/reports: | |
| get: | |
| tags: | |
| - report-resource | |
| summary: getAllReports | |
| operationId: getAllReportsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/ReportDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - report-resource | |
| summary: createReport | |
| operationId: createReportUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: reportDTO | |
| description: reportDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/ReportDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/ReportDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - report-resource | |
| summary: updateReport | |
| operationId: updateReportUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: reportDTO | |
| description: reportDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/ReportDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/ReportDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/reports/{id}': | |
| get: | |
| tags: | |
| - report-resource | |
| summary: getReport | |
| operationId: getReportUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/ReportDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - report-resource | |
| summary: deleteReport | |
| operationId: deleteReportUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/tips: | |
| get: | |
| tags: | |
| - tip-resource | |
| summary: getAllTips | |
| operationId: getAllTipsUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/TipDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - tip-resource | |
| summary: createTip | |
| operationId: createTipUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: tipDTO | |
| description: tipDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/TipDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/TipDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - tip-resource | |
| summary: updateTip | |
| operationId: updateTipUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: tipDTO | |
| description: tipDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/TipDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/TipDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/tips/{id}': | |
| get: | |
| tags: | |
| - tip-resource | |
| summary: getTip | |
| operationId: getTipUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/TipDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - tip-resource | |
| summary: deleteTip | |
| operationId: deleteTipUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/users: | |
| get: | |
| tags: | |
| - user-resource | |
| summary: getAllUsers | |
| operationId: getAllUsersUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/UserDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - user-resource | |
| summary: createUser | |
| operationId: createUserUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: managedUserVM | |
| description: managedUserVM | |
| required: true | |
| schema: | |
| $ref: '#/definitions/ManagedUserVM' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/ResponseEntity' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - user-resource | |
| summary: updateUser | |
| operationId: updateUserUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: managedUserVM | |
| description: managedUserVM | |
| required: true | |
| schema: | |
| $ref: '#/definitions/ManagedUserVM' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/UserDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/users/authorities: | |
| get: | |
| tags: | |
| - user-resource | |
| summary: getAuthorities | |
| operationId: getAuthoritiesUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/users/{login}': | |
| get: | |
| tags: | |
| - user-resource | |
| summary: getUser | |
| operationId: getUserUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: login | |
| in: path | |
| description: login | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/UserDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - user-resource | |
| summary: deleteUser | |
| operationId: deleteUserUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: login | |
| in: path | |
| description: login | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/webpages: | |
| get: | |
| tags: | |
| - webpage-resource | |
| summary: getAllWebpages | |
| operationId: getAllWebpagesUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/WebpageDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| post: | |
| tags: | |
| - webpage-resource | |
| summary: createWebpage | |
| operationId: createWebpageUsingPOST | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: webpageDTO | |
| description: webpageDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/WebpageDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/WebpageDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| put: | |
| tags: | |
| - webpage-resource | |
| summary: updateWebpage | |
| operationId: updateWebpageUsingPUT | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - in: body | |
| name: webpageDTO | |
| description: webpageDTO | |
| required: true | |
| schema: | |
| $ref: '#/definitions/WebpageDTO' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/WebpageDTO' | |
| '201': | |
| description: Created | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/webpages/category/{slug}': | |
| get: | |
| tags: | |
| - webpage-resource | |
| summary: getAllWebpagesByCatSlug | |
| operationId: getAllWebpagesByCatSlugUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: slug | |
| in: path | |
| description: slug | |
| required: true | |
| type: string | |
| - name: page | |
| in: query | |
| description: Page number of the requested page | |
| required: false | |
| type: integer | |
| format: int32 | |
| - name: size | |
| in: query | |
| description: Size of a page | |
| required: false | |
| 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. | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/definitions/WebpageDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/webpages/recommend-for-document: | |
| get: | |
| tags: | |
| - webpage-resource | |
| summary: getRecommendationsForDocument | |
| operationId: getRecommendationsForDocumentUsingGET_1 | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: query | |
| description: id | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/RecommendationDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/webpages/recommend-for-query: | |
| get: | |
| tags: | |
| - webpage-resource | |
| summary: getRecommendationsForQuery | |
| operationId: getRecommendationsForQueryUsingGET_1 | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: q | |
| in: query | |
| description: q | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/RecommendationDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/webpages/search_webpages: | |
| get: | |
| tags: | |
| - webpage-resource | |
| summary: searchWebpagesAdvanced | |
| operationId: searchWebpagesAdvancedUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: q | |
| in: query | |
| description: q | |
| required: true | |
| type: string | |
| - name: fq | |
| in: query | |
| description: fq | |
| required: false | |
| type: array | |
| items: | |
| type: string | |
| collectionFormat: multi | |
| - name: page | |
| in: query | |
| description: page | |
| required: false | |
| type: integer | |
| default: 1 | |
| format: int32 | |
| - name: per_page | |
| in: query | |
| description: per_page | |
| required: false | |
| type: integer | |
| default: 10 | |
| format: int32 | |
| - name: sort | |
| in: query | |
| description: sort | |
| required: false | |
| type: string | |
| default: score | |
| - name: dir | |
| in: query | |
| description: dir | |
| required: false | |
| type: string | |
| default: desc | |
| - name: User-Agent | |
| in: header | |
| description: User-Agent | |
| required: true | |
| type: string | |
| default: foo | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/APIResponse' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| /api/webpages/solr: | |
| get: | |
| tags: | |
| - webpage-resource | |
| summary: getDocumentFromSolr | |
| operationId: getDocumentFromSolrUsingGET_1 | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: query | |
| description: id | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/Doc' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - webpage-resource | |
| summary: deleteWebpageDTOFromSolr | |
| operationId: deleteWebpageDTOFromSolrUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: query | |
| description: id | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| /api/webpages/suggest: | |
| get: | |
| tags: | |
| - webpage-resource | |
| summary: suggest | |
| operationId: suggestUsingGET_1 | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: q | |
| in: query | |
| description: q | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/MySuggester' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| '/api/webpages/{id}': | |
| get: | |
| tags: | |
| - webpage-resource | |
| summary: getWebpage | |
| operationId: getWebpageUsingGET | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/WebpageDTO' | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| '404': | |
| description: Not Found | |
| delete: | |
| tags: | |
| - webpage-resource | |
| summary: deleteWebpage | |
| operationId: deleteWebpageUsingDELETE | |
| consumes: | |
| - application/json | |
| produces: | |
| - '*/*' | |
| parameters: | |
| - name: id | |
| in: path | |
| description: id | |
| required: true | |
| type: integer | |
| format: int64 | |
| responses: | |
| '200': | |
| description: OK | |
| '204': | |
| description: No Content | |
| '401': | |
| description: Unauthorized | |
| '403': | |
| description: Forbidden | |
| definitions: | |
| APIResponse: | |
| type: object | |
| properties: | |
| facet_counts: | |
| $ref: '#/definitions/FacetCounts' | |
| highlighting: | |
| $ref: '#/definitions/Highlighting' | |
| response: | |
| $ref: '#/definitions/Response' | |
| responseHeader: | |
| $ref: '#/definitions/ResponseHeader' | |
| spellcheck: | |
| $ref: '#/definitions/Spellcheck' | |
| Author: | |
| type: object | |
| required: | |
| - name | |
| properties: | |
| description: | |
| type: string | |
| gender: | |
| type: string | |
| enum: | |
| - MALE | |
| - FEMALE | |
| - OTHER | |
| id: | |
| type: integer | |
| format: int64 | |
| name: | |
| type: string | |
| phone: | |
| type: string | |
| photo: | |
| type: string | |
| format: byte | |
| photoContentType: | |
| type: string | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| url: | |
| type: string | |
| AuthorDTO: | |
| type: object | |
| required: | |
| - name | |
| properties: | |
| description: | |
| type: string | |
| gender: | |
| type: string | |
| enum: | |
| - MALE | |
| - FEMALE | |
| - OTHER | |
| id: | |
| type: integer | |
| format: int64 | |
| name: | |
| type: string | |
| phone: | |
| type: string | |
| photo: | |
| type: string | |
| format: byte | |
| photoContentType: | |
| type: string | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| url: | |
| type: string | |
| BankAccountDTO: | |
| type: object | |
| required: | |
| - accountNo | |
| - name | |
| properties: | |
| accountNo: | |
| type: string | |
| balance: | |
| type: number | |
| format: double | |
| id: | |
| type: integer | |
| format: int64 | |
| name: | |
| type: string | |
| userId: | |
| type: integer | |
| format: int64 | |
| userLogin: | |
| type: string | |
| BookmarkDTO: | |
| type: object | |
| properties: | |
| id: | |
| type: integer | |
| format: int64 | |
| jobId: | |
| type: integer | |
| format: int64 | |
| jobTitle: | |
| type: string | |
| remarks: | |
| type: string | |
| userId: | |
| type: integer | |
| format: int64 | |
| userLogin: | |
| type: string | |
| webpageId: | |
| type: integer | |
| format: int64 | |
| webpageTitle: | |
| type: string | |
| Cat: | |
| type: object | |
| required: | |
| - name | |
| properties: | |
| icon: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| name: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| parent: | |
| type: integer | |
| format: int32 | |
| photo: | |
| type: string | |
| format: byte | |
| photoContentType: | |
| type: string | |
| priority: | |
| type: integer | |
| format: int32 | |
| slug: | |
| type: string | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| description: Category entity Also known as Subject | |
| CatDTO: | |
| type: object | |
| required: | |
| - name | |
| properties: | |
| icon: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| name: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| parent: | |
| type: integer | |
| format: int32 | |
| photo: | |
| type: string | |
| format: byte | |
| photoContentType: | |
| type: string | |
| priority: | |
| type: integer | |
| format: int32 | |
| slug: | |
| type: string | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| City: | |
| type: object | |
| required: | |
| - name | |
| properties: | |
| country: | |
| $ref: '#/definitions/Country' | |
| description: | |
| type: string | |
| division: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| name: | |
| type: string | |
| population: | |
| type: integer | |
| format: int64 | |
| CityDTO: | |
| type: object | |
| required: | |
| - name | |
| properties: | |
| countryId: | |
| type: integer | |
| format: int64 | |
| countryName: | |
| type: string | |
| description: | |
| type: string | |
| division: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| name: | |
| type: string | |
| population: | |
| type: integer | |
| format: int64 | |
| Collations: | |
| type: object | |
| CommentDTO: | |
| type: object | |
| required: | |
| properties: | |
| content: | |
| type: string | |
| email: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| ipAddress: | |
| type: string | |
| parent: | |
| type: integer | |
| format: int64 | |
| userAgent: | |
| type: string | |
| userId: | |
| type: integer | |
| format: int64 | |
| userLogin: | |
| type: string | |
| webpageId: | |
| type: integer | |
| format: int64 | |
| webpageTitle: | |
| type: string | |
| CompanyDTO: | |
| type: object | |
| required: | |
| - name | |
| properties: | |
| address: | |
| type: string | |
| description: | |
| type: string | |
| email: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| logo: | |
| type: string | |
| format: byte | |
| logoContentType: | |
| type: string | |
| name: | |
| type: string | |
| phoneNumber: | |
| type: string | |
| userId: | |
| type: integer | |
| format: int64 | |
| userLogin: | |
| type: string | |
| website: | |
| type: string | |
| ConfigDTO: | |
| type: object | |
| required: | |
| - key | |
| - value | |
| properties: | |
| id: | |
| type: integer | |
| format: int64 | |
| key: | |
| type: string | |
| lang: | |
| type: string | |
| enum: | |
| - AR | |
| - BN | |
| - DE | |
| - EN | |
| - FR | |
| - HI | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| userId: | |
| type: integer | |
| format: int64 | |
| userLogin: | |
| type: string | |
| value: | |
| type: string | |
| Country: | |
| type: object | |
| required: | |
| - code | |
| - name | |
| properties: | |
| callingCode: | |
| type: integer | |
| format: int64 | |
| capital: | |
| type: integer | |
| format: int64 | |
| code: | |
| type: string | |
| minLength: 0 | |
| maxLength: 3 | |
| gnp: | |
| type: number | |
| format: float | |
| gnpOld: | |
| type: number | |
| format: float | |
| governmentForm: | |
| type: string | |
| headOfState: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| indepYear: | |
| type: integer | |
| format: int64 | |
| isoCode2: | |
| type: string | |
| minLength: 0 | |
| maxLength: 2 | |
| lifeExpectancy: | |
| type: number | |
| format: float | |
| localName: | |
| type: string | |
| name: | |
| type: string | |
| population: | |
| type: integer | |
| format: int64 | |
| region: | |
| $ref: '#/definitions/Region' | |
| surfaceArea: | |
| type: number | |
| format: float | |
| CountryDTO: | |
| type: object | |
| required: | |
| - code | |
| - name | |
| properties: | |
| callingCode: | |
| type: integer | |
| format: int64 | |
| capital: | |
| type: integer | |
| format: int64 | |
| code: | |
| type: string | |
| minLength: 0 | |
| maxLength: 3 | |
| gnp: | |
| type: number | |
| format: float | |
| gnpOld: | |
| type: number | |
| format: float | |
| governmentForm: | |
| type: string | |
| headOfState: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| indepYear: | |
| type: integer | |
| format: int64 | |
| isoCode2: | |
| type: string | |
| minLength: 0 | |
| maxLength: 2 | |
| lifeExpectancy: | |
| type: number | |
| format: float | |
| localName: | |
| type: string | |
| name: | |
| type: string | |
| population: | |
| type: integer | |
| format: int64 | |
| regionId: | |
| type: integer | |
| format: int64 | |
| regionName: | |
| type: string | |
| surfaceArea: | |
| type: number | |
| format: float | |
| Counts: | |
| type: object | |
| CourseOfTheDay: | |
| type: object | |
| properties: | |
| date: | |
| type: string | |
| format: date | |
| id: | |
| type: integer | |
| format: int64 | |
| remarks: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| webpage: | |
| $ref: '#/definitions/Webpage' | |
| CourseOfTheDayDTO: | |
| type: object | |
| properties: | |
| date: | |
| type: string | |
| format: date | |
| id: | |
| type: integer | |
| format: int64 | |
| remarks: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| webpageId: | |
| type: integer | |
| format: int64 | |
| webpageTitle: | |
| type: string | |
| Doc: | |
| type: object | |
| properties: | |
| description: | |
| type: array | |
| items: | |
| type: string | |
| fetchedDate_dt: | |
| type: string | |
| id: | |
| type: string | |
| images: | |
| type: array | |
| items: | |
| type: string | |
| keywords: | |
| type: array | |
| items: | |
| type: string | |
| last_modified: | |
| type: string | |
| length_l: | |
| type: integer | |
| format: int64 | |
| status: | |
| type: string | |
| title: | |
| type: array | |
| items: | |
| type: string | |
| title_lang: | |
| type: string | |
| type_s: | |
| type: string | |
| url: | |
| type: string | |
| DoodleDTO: | |
| type: object | |
| required: | |
| - name | |
| properties: | |
| active: | |
| type: boolean | |
| description: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| lang: | |
| type: string | |
| enum: | |
| - AR | |
| - BN | |
| - DE | |
| - EN | |
| - FR | |
| - HI | |
| name: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| photo: | |
| type: string | |
| format: byte | |
| photoContentType: | |
| type: string | |
| FacetCounts: | |
| type: object | |
| properties: | |
| facet_fields: | |
| $ref: '#/definitions/FacetFields' | |
| facet_heatmaps: | |
| $ref: '#/definitions/FacetHeatmaps' | |
| facet_intervals: | |
| $ref: '#/definitions/FacetIntervals' | |
| facet_queries: | |
| $ref: '#/definitions/FacetQueries' | |
| facet_ranges: | |
| $ref: '#/definitions/FacetRanges' | |
| FacetFields: | |
| type: object | |
| properties: | |
| keywords: | |
| $ref: '#/definitions/Keywords' | |
| FacetHeatmaps: | |
| type: object | |
| FacetIntervals: | |
| type: object | |
| FacetQueries: | |
| type: object | |
| FacetRanges: | |
| type: object | |
| properties: | |
| last_modified: | |
| $ref: '#/definitions/LastModified' | |
| GuideDTO: | |
| type: object | |
| required: | |
| - name | |
| properties: | |
| active: | |
| type: boolean | |
| content: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| lang: | |
| type: string | |
| enum: | |
| - AR | |
| - BN | |
| - DE | |
| - EN | |
| - FR | |
| - HI | |
| name: | |
| type: string | |
| photo: | |
| type: string | |
| format: byte | |
| photoContentType: | |
| type: string | |
| Header: | |
| type: object | |
| properties: | |
| queryParams: | |
| $ref: '#/definitions/QueryParams' | |
| totalTime: | |
| type: integer | |
| format: int32 | |
| Highlighting: | |
| type: object | |
| Item: | |
| type: object | |
| properties: | |
| docId: | |
| type: string | |
| weight: | |
| type: number | |
| format: double | |
| JobAPIResponse: | |
| type: object | |
| properties: | |
| facet_counts: | |
| $ref: '#/definitions/FacetCounts' | |
| highlighting: | |
| $ref: '#/definitions/Highlighting' | |
| response: | |
| $ref: '#/definitions/JobResponse' | |
| responseHeader: | |
| $ref: '#/definitions/ResponseHeader' | |
| spellcheck: | |
| $ref: '#/definitions/Spellcheck' | |
| JobDTO: | |
| type: object | |
| required: | |
| - title | |
| - url | |
| properties: | |
| cats: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CatDTO' | |
| companyId: | |
| type: integer | |
| format: int64 | |
| companyName: | |
| type: string | |
| description: | |
| type: string | |
| expireDate: | |
| type: string | |
| format: date-time | |
| fetchedDate: | |
| type: string | |
| format: date-time | |
| id: | |
| type: integer | |
| format: int64 | |
| keywords: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| lang: | |
| type: string | |
| enum: | |
| - AR | |
| - BN | |
| - DE | |
| - EN | |
| - FR | |
| - HI | |
| location: | |
| type: string | |
| position: | |
| type: string | |
| postedDate: | |
| type: string | |
| format: date-time | |
| remarks: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| requirements: | |
| type: string | |
| salaryRange: | |
| type: string | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| statusText: | |
| type: string | |
| title: | |
| type: string | |
| type: | |
| type: string | |
| url: | |
| type: string | |
| JobDoc: | |
| type: object | |
| properties: | |
| charSet_s: | |
| type: string | |
| description: | |
| type: array | |
| items: | |
| type: string | |
| expire_date: | |
| type: string | |
| fetchedDate_dt: | |
| type: string | |
| fileSize_l: | |
| type: integer | |
| format: int32 | |
| id: | |
| type: string | |
| job_type: | |
| type: string | |
| keywords: | |
| type: array | |
| items: | |
| type: string | |
| last_modified: | |
| type: string | |
| length_l: | |
| type: integer | |
| format: int32 | |
| location: | |
| type: array | |
| items: | |
| type: string | |
| mimeType_s: | |
| type: string | |
| origin_logo: | |
| type: string | |
| origin_name: | |
| type: string | |
| origin_url: | |
| type: string | |
| parsing_s: | |
| type: string | |
| parsing_time_l: | |
| type: integer | |
| format: int32 | |
| title: | |
| type: array | |
| items: | |
| type: string | |
| url: | |
| type: string | |
| JobResponse: | |
| type: object | |
| properties: | |
| docs: | |
| type: array | |
| items: | |
| $ref: '#/definitions/JobDoc' | |
| maxScore: | |
| type: number | |
| format: float | |
| numFound: | |
| type: integer | |
| format: int64 | |
| start: | |
| type: integer | |
| format: int64 | |
| KeyAndPasswordVM: | |
| type: object | |
| properties: | |
| key: | |
| type: string | |
| newPassword: | |
| type: string | |
| Keywords: | |
| type: object | |
| properties: | |
| dhaka: | |
| type: integer | |
| format: int64 | |
| LabelDTO: | |
| type: object | |
| required: | |
| - name | |
| properties: | |
| id: | |
| type: integer | |
| format: int64 | |
| name: | |
| type: string | |
| operations: | |
| type: array | |
| items: | |
| $ref: '#/definitions/OperationDTO' | |
| LastModified: | |
| type: object | |
| properties: | |
| after: | |
| type: integer | |
| format: int64 | |
| before: | |
| type: integer | |
| format: int64 | |
| between: | |
| type: integer | |
| format: int64 | |
| counts: | |
| $ref: '#/definitions/Counts' | |
| end: | |
| type: string | |
| gap: | |
| type: string | |
| start: | |
| type: string | |
| LocationDTO: | |
| type: object | |
| required: | |
| - streetAddress | |
| properties: | |
| cityId: | |
| type: integer | |
| format: int64 | |
| cityName: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| lat: | |
| type: number | |
| format: float | |
| lon: | |
| type: number | |
| format: float | |
| postalCode: | |
| type: string | |
| stateProvince: | |
| type: string | |
| streetAddress: | |
| type: string | |
| streetAddressLine2: | |
| type: string | |
| LoginVM: | |
| type: object | |
| required: | |
| - password | |
| - username | |
| properties: | |
| password: | |
| type: string | |
| minLength: 4 | |
| maxLength: 100 | |
| rememberMe: | |
| type: boolean | |
| username: | |
| type: string | |
| minLength: 1 | |
| maxLength: 50 | |
| pattern: '^[_''.@A-Za-z0-9-]*$' | |
| ManagedUserVM: | |
| type: object | |
| required: | |
| - login | |
| properties: | |
| activated: | |
| type: boolean | |
| authorities: | |
| type: array | |
| items: | |
| type: string | |
| createdBy: | |
| type: string | |
| createdDate: | |
| type: string | |
| format: date-time | |
| email: | |
| type: string | |
| minLength: 5 | |
| maxLength: 100 | |
| firstName: | |
| type: string | |
| minLength: 0 | |
| maxLength: 50 | |
| id: | |
| type: integer | |
| format: int64 | |
| imageUrl: | |
| type: string | |
| langKey: | |
| type: string | |
| minLength: 2 | |
| maxLength: 5 | |
| lastModifiedBy: | |
| type: string | |
| lastModifiedDate: | |
| type: string | |
| format: date-time | |
| lastName: | |
| type: string | |
| minLength: 0 | |
| maxLength: 50 | |
| login: | |
| type: string | |
| minLength: 1 | |
| maxLength: 100 | |
| pattern: '^[_''.@A-Za-z0-9-]*$' | |
| password: | |
| type: string | |
| minLength: 4 | |
| maxLength: 100 | |
| MySuggester: | |
| type: object | |
| properties: | |
| term: | |
| $ref: '#/definitions/Term' | |
| OperationDTO: | |
| type: object | |
| required: | |
| - title | |
| properties: | |
| amount: | |
| type: number | |
| format: double | |
| bankAccountId: | |
| type: integer | |
| format: int64 | |
| description: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| title: | |
| type: string | |
| transferDate: | |
| type: string | |
| format: date-time | |
| ProfileInfoVM: | |
| type: object | |
| properties: | |
| activeProfiles: | |
| type: array | |
| items: | |
| type: string | |
| ribbonEnv: | |
| type: string | |
| QueryParams: | |
| type: object | |
| properties: | |
| aggrRows: | |
| type: integer | |
| format: int32 | |
| aggrType: | |
| type: string | |
| collection: | |
| type: string | |
| debug: | |
| type: boolean | |
| fq: | |
| type: array | |
| items: | |
| type: object | |
| q: | |
| type: string | |
| rows: | |
| type: integer | |
| format: int32 | |
| RecommendationDTO: | |
| type: object | |
| properties: | |
| header: | |
| $ref: '#/definitions/Header' | |
| items: | |
| type: array | |
| items: | |
| $ref: '#/definitions/Item' | |
| Region: | |
| type: object | |
| required: | |
| - name | |
| properties: | |
| continent: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| name: | |
| type: string | |
| RegionDTO: | |
| type: object | |
| required: | |
| - name | |
| properties: | |
| continent: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| name: | |
| type: string | |
| ReportDTO: | |
| type: object | |
| required: | |
| - title | |
| properties: | |
| description: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| pdf: | |
| type: string | |
| format: byte | |
| pdfContentType: | |
| type: string | |
| photo: | |
| type: string | |
| format: byte | |
| photoContentType: | |
| type: string | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| subTitle: | |
| type: string | |
| title: | |
| type: string | |
| Response: | |
| type: object | |
| properties: | |
| docs: | |
| type: array | |
| items: | |
| $ref: '#/definitions/Doc' | |
| maxScore: | |
| type: number | |
| format: float | |
| numFound: | |
| type: integer | |
| format: int64 | |
| start: | |
| type: integer | |
| format: int64 | |
| ResponseEntity: | |
| type: object | |
| properties: | |
| body: | |
| type: object | |
| statusCode: | |
| type: string | |
| enum: | |
| - '100' | |
| - '101' | |
| - '102' | |
| - '103' | |
| - '200' | |
| - '201' | |
| - '202' | |
| - '203' | |
| - '204' | |
| - '205' | |
| - '206' | |
| - '207' | |
| - '208' | |
| - '226' | |
| - '300' | |
| - '301' | |
| - '302' | |
| - '303' | |
| - '304' | |
| - '305' | |
| - '307' | |
| - '308' | |
| - '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' | |
| - '426' | |
| - '428' | |
| - '429' | |
| - '431' | |
| - '451' | |
| - '500' | |
| - '501' | |
| - '502' | |
| - '503' | |
| - '504' | |
| - '505' | |
| - '506' | |
| - '507' | |
| - '508' | |
| - '509' | |
| - '510' | |
| - '511' | |
| statusCodeValue: | |
| type: integer | |
| format: int32 | |
| ResponseHeader: | |
| type: object | |
| properties: | |
| QTime: | |
| type: integer | |
| format: int64 | |
| status: | |
| type: integer | |
| format: int64 | |
| zkConnected: | |
| type: boolean | |
| SolrJob: | |
| type: object | |
| required: | |
| - title | |
| - url | |
| properties: | |
| cats: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CatDTO' | |
| companyId: | |
| type: integer | |
| format: int64 | |
| companyName: | |
| type: string | |
| description: | |
| type: string | |
| expireDate: | |
| type: string | |
| format: date-time | |
| fetchedDate: | |
| type: string | |
| format: date-time | |
| id: | |
| type: string | |
| keywords: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| lang: | |
| type: string | |
| enum: | |
| - AR | |
| - BN | |
| - DE | |
| - EN | |
| - FR | |
| - HI | |
| location: | |
| type: string | |
| position: | |
| type: string | |
| postedDate: | |
| type: string | |
| format: date-time | |
| remarks: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| requirements: | |
| type: string | |
| salaryRange: | |
| type: string | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| statusText: | |
| type: string | |
| title: | |
| type: string | |
| type: | |
| type: string | |
| url: | |
| type: string | |
| SolrWebpage: | |
| type: object | |
| required: | |
| - title | |
| - type | |
| - url | |
| properties: | |
| affiliate: | |
| type: string | |
| authorId: | |
| type: string | |
| authorName: | |
| type: string | |
| cats: | |
| type: array | |
| items: | |
| $ref: '#/definitions/Cat' | |
| checkoutUrl: | |
| type: string | |
| cities: | |
| type: array | |
| items: | |
| $ref: '#/definitions/City' | |
| currency: | |
| type: string | |
| description: | |
| type: string | |
| discountPrice: | |
| type: number | |
| format: double | |
| discountText: | |
| type: string | |
| duration: | |
| type: string | |
| endDate: | |
| type: string | |
| format: date-time | |
| features: | |
| type: string | |
| fetchedDate: | |
| type: string | |
| format: date-time | |
| headline: | |
| type: string | |
| id: | |
| type: string | |
| images: | |
| type: string | |
| keywords: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| lang: | |
| type: string | |
| enum: | |
| - AR | |
| - BN | |
| - DE | |
| - EN | |
| - FR | |
| - HI | |
| learnersCount: | |
| type: integer | |
| format: int64 | |
| location: | |
| type: string | |
| originLogo: | |
| type: string | |
| originName: | |
| type: string | |
| parent: | |
| type: string | |
| photo: | |
| type: string | |
| format: byte | |
| photoContentType: | |
| type: string | |
| price: | |
| type: number | |
| format: double | |
| rating: | |
| type: string | |
| ratingCount: | |
| type: string | |
| ratingText: | |
| type: string | |
| skillLevel: | |
| type: string | |
| startDate: | |
| type: string | |
| format: date-time | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| statusText: | |
| type: string | |
| title: | |
| type: string | |
| type: | |
| type: string | |
| url: | |
| type: string | |
| user: | |
| $ref: '#/definitions/User' | |
| Spellcheck: | |
| type: object | |
| properties: | |
| collations: | |
| $ref: '#/definitions/Collations' | |
| correctlySpelled: | |
| type: boolean | |
| suggestions: | |
| $ref: '#/definitions/Suggestions' | |
| Suggestions: | |
| type: object | |
| Term: | |
| type: object | |
| TipDTO: | |
| type: object | |
| required: | |
| - title | |
| properties: | |
| description: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| language: | |
| type: string | |
| enum: | |
| - AR | |
| - BN | |
| - DE | |
| - EN | |
| - FR | |
| - HI | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| title: | |
| type: string | |
| userId: | |
| type: integer | |
| format: int64 | |
| userLogin: | |
| type: string | |
| User: | |
| type: object | |
| required: | |
| - activated | |
| - login | |
| properties: | |
| activated: | |
| type: boolean | |
| email: | |
| type: string | |
| minLength: 5 | |
| maxLength: 100 | |
| firstName: | |
| type: string | |
| minLength: 0 | |
| maxLength: 50 | |
| id: | |
| type: integer | |
| format: int64 | |
| imageUrl: | |
| type: string | |
| langKey: | |
| type: string | |
| minLength: 2 | |
| maxLength: 5 | |
| lastName: | |
| type: string | |
| minLength: 0 | |
| maxLength: 50 | |
| login: | |
| type: string | |
| minLength: 1 | |
| maxLength: 100 | |
| pattern: '^[_''.@A-Za-z0-9-]*$' | |
| resetDate: | |
| type: string | |
| format: date-time | |
| UserDTO: | |
| type: object | |
| required: | |
| - login | |
| properties: | |
| activated: | |
| type: boolean | |
| authorities: | |
| type: array | |
| items: | |
| type: string | |
| createdBy: | |
| type: string | |
| createdDate: | |
| type: string | |
| format: date-time | |
| email: | |
| type: string | |
| minLength: 5 | |
| maxLength: 100 | |
| firstName: | |
| type: string | |
| minLength: 0 | |
| maxLength: 50 | |
| id: | |
| type: integer | |
| format: int64 | |
| imageUrl: | |
| type: string | |
| langKey: | |
| type: string | |
| minLength: 2 | |
| maxLength: 5 | |
| lastModifiedBy: | |
| type: string | |
| lastModifiedDate: | |
| type: string | |
| format: date-time | |
| lastName: | |
| type: string | |
| minLength: 0 | |
| maxLength: 50 | |
| login: | |
| type: string | |
| minLength: 1 | |
| maxLength: 100 | |
| pattern: '^[_''.@A-Za-z0-9-]*$' | |
| Webpage: | |
| type: object | |
| required: | |
| - title | |
| - type | |
| - url | |
| properties: | |
| affiliate: | |
| type: string | |
| authors: | |
| type: array | |
| items: | |
| $ref: '#/definitions/Author' | |
| cats: | |
| type: array | |
| items: | |
| $ref: '#/definitions/Cat' | |
| checkoutUrl: | |
| type: string | |
| cities: | |
| type: array | |
| items: | |
| $ref: '#/definitions/City' | |
| currency: | |
| type: string | |
| description: | |
| type: string | |
| discountPrice: | |
| type: number | |
| format: double | |
| discountText: | |
| type: string | |
| duration: | |
| type: string | |
| endDate: | |
| type: string | |
| format: date-time | |
| features: | |
| type: string | |
| fetchedDate: | |
| type: string | |
| format: date-time | |
| headline: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| images: | |
| type: string | |
| keywords: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| lang: | |
| type: string | |
| enum: | |
| - AR | |
| - BN | |
| - DE | |
| - EN | |
| - FR | |
| - HI | |
| learnersCount: | |
| type: integer | |
| format: int64 | |
| location: | |
| type: string | |
| originLogo: | |
| type: string | |
| originName: | |
| type: string | |
| parent: | |
| type: string | |
| photo: | |
| type: string | |
| format: byte | |
| photoContentType: | |
| type: string | |
| price: | |
| type: number | |
| format: double | |
| rating: | |
| type: string | |
| ratingCount: | |
| type: string | |
| ratingText: | |
| type: string | |
| skillLevel: | |
| type: string | |
| startDate: | |
| type: string | |
| format: date-time | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| statusText: | |
| type: string | |
| title: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| type: | |
| type: string | |
| url: | |
| type: string | |
| user: | |
| $ref: '#/definitions/User' | |
| WebpageDTO: | |
| type: object | |
| required: | |
| - title | |
| - type | |
| - url | |
| properties: | |
| affiliate: | |
| type: string | |
| authors: | |
| type: array | |
| items: | |
| $ref: '#/definitions/AuthorDTO' | |
| cats: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CatDTO' | |
| checkoutUrl: | |
| type: string | |
| cities: | |
| type: array | |
| items: | |
| $ref: '#/definitions/CityDTO' | |
| currency: | |
| type: string | |
| description: | |
| type: string | |
| discountPrice: | |
| type: number | |
| format: double | |
| discountText: | |
| type: string | |
| duration: | |
| type: string | |
| endDate: | |
| type: string | |
| format: date-time | |
| features: | |
| type: string | |
| fetchedDate: | |
| type: string | |
| format: date-time | |
| headline: | |
| type: string | |
| id: | |
| type: integer | |
| format: int64 | |
| images: | |
| type: string | |
| keywords: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| lang: | |
| type: string | |
| enum: | |
| - AR | |
| - BN | |
| - DE | |
| - EN | |
| - FR | |
| - HI | |
| learnersCount: | |
| type: integer | |
| format: int64 | |
| location: | |
| type: string | |
| originLogo: | |
| type: string | |
| originName: | |
| type: string | |
| parent: | |
| type: string | |
| photo: | |
| type: string | |
| format: byte | |
| photoContentType: | |
| type: string | |
| price: | |
| type: number | |
| format: double | |
| rating: | |
| type: string | |
| ratingCount: | |
| type: string | |
| ratingText: | |
| type: string | |
| skillLevel: | |
| type: string | |
| startDate: | |
| type: string | |
| format: date-time | |
| status: | |
| type: string | |
| enum: | |
| - DRAFT | |
| - PUBLISHED | |
| - EXPIRED | |
| - DONE | |
| - ON_HOLD | |
| - DELETED | |
| - ERROR | |
| - FEATURED | |
| statusText: | |
| type: string | |
| title: | |
| type: string | |
| minLength: 0 | |
| maxLength: 512 | |
| type: | |
| type: string | |
| url: | |
| type: string | |
| userId: | |
| type: integer | |
| format: int64 | |
| userLogin: | |
| type: string |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment