openapi: 3.0.3 info: title: 'Guideline Api 100% light' description: '100% Light api for storing article information and exporting to Navision' version: 1.0.0 servers: - url: 'https://dev-api.100p.xcs.be' paths: /api/v1/articles: post: summary: Copy operationId: copy description: 'Create a new article by copying another one' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Copy successfully created' data: id: 12411116-copy F_1: 12411116-copy F_3: 'BH30-IP20-LG08-CRI90-6,1W-4K-BM45°-RFL-WHT-IDD350mADC(DALI)' F_5: '' F_80000: 'BULLET HOLE 30 - IP20 - LED G08 - CRI 90 - 6,1 W - 4000K - BEAM 45°-REFLECTOR' F_80001: 'MATT WHITE TEXTURED - INCL. DIM. DRIVER 350mA DC (DALI)' F_80002: '' F_80003: '' F_80007: '' C_75048: 'BULLET HOLE' C_75027: 'BULLET HOLE 30' C_75000: INDOOR C_75001: CEILING F_80006: 20/06/2022 properties: status: type: string example: success message: type: string example: 'Copy successfully created' data: type: object properties: id: type: string example: 12411116-copy F_1: type: string example: 12411116-copy F_3: type: string example: 'BH30-IP20-LG08-CRI90-6,1W-4K-BM45°-RFL-WHT-IDD350mADC(DALI)' F_5: type: string example: '' F_80000: type: string example: 'BULLET HOLE 30 - IP20 - LED G08 - CRI 90 - 6,1 W - 4000K - BEAM 45°-REFLECTOR' F_80001: type: string example: 'MATT WHITE TEXTURED - INCL. DIM. DRIVER 350mA DC (DALI)' F_80002: type: string example: '' F_80003: type: string example: '' F_80007: type: string example: '' C_75048: type: string example: 'BULLET HOLE' C_75027: type: string example: 'BULLET HOLE 30' C_75000: type: string example: INDOOR C_75001: type: string example: CEILING F_80006: type: string example: 20/06/2022 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Article requestBody: required: true content: application/json: schema: type: object properties: customNumber: type: string description: 'The new article number for copy.' example: '"12411116-copy"' F_1: type: string description: 'The article number to copy.' example: '"12411116"' 'F_*': type: string description: 'optional Params to add or overrule on the copy for "F" params.' example: '"F_5"' 'C_*': type: string description: 'optional Params to add or overrule on the copy for "C" params.' example: '"C_75015"' required: - customNumber - F_1 /api/v1/articles/delta-update: post: summary: 'Delta Update' operationId: deltaUpdate description: "Call articles delta updates routine\nThis will add jobs to the queue to handle the file and all operations therein" parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Delta file accepted and added to the job queue' data: null properties: status: type: string example: success message: type: string example: 'Delta file accepted and added to the job queue' data: type: string example: null 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Article requestBody: required: true content: application/json: schema: type: object properties: file: type: string description: 'The url to the delta update json file.' example: '"http://localhost/data/test.TestHandleSyncRequestMix.json"' files: type: string description: 'Array of urls to the delta update json file(s).' example: '"[http://localhost/data/test.TestHandleSyncRequestMix.json, http://localhost/data/test.TestHandleSyncRequestMix2.json]"' required: - file - files /api/v1/articles/update: post: summary: Update operationId: update description: 'Update an article' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Update successful' data: id: '12411116' F_1: '12411116' F_3: 'BH30-IP20-LG08-CRI90-6,1W-4K-BM45°-RFL-WHT-IDD350mADC(DALI)' F_5: '' F_80000: 'BULLET HOLE 30 - IP20 - LED G08 - CRI 90 - 6,1 W - 4000K - BEAM 45°-REFLECTOR' F_80001: 'MATT WHITE TEXTURED - INCL. DIM. DRIVER 350mA DC (DALI)' F_80002: '' F_80003: '' F_80007: '' C_75048: 'BULLET HOLE' C_75027: 'BULLET HOLE 30' C_75000: INDOOR C_75001: CEILING F_80006: 20/06/2022 properties: status: type: string example: success message: type: string example: 'Update successful' data: type: object properties: id: type: string example: '12411116' F_1: type: string example: '12411116' F_3: type: string example: 'BH30-IP20-LG08-CRI90-6,1W-4K-BM45°-RFL-WHT-IDD350mADC(DALI)' F_5: type: string example: '' F_80000: type: string example: 'BULLET HOLE 30 - IP20 - LED G08 - CRI 90 - 6,1 W - 4000K - BEAM 45°-REFLECTOR' F_80001: type: string example: 'MATT WHITE TEXTURED - INCL. DIM. DRIVER 350mA DC (DALI)' F_80002: type: string example: '' F_80003: type: string example: '' F_80007: type: string example: '' C_75048: type: string example: 'BULLET HOLE' C_75027: type: string example: 'BULLET HOLE 30' C_75000: type: string example: INDOOR C_75001: type: string example: CEILING F_80006: type: string example: 20/06/2022 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Article requestBody: required: true content: application/json: schema: type: object properties: customNumber: type: string description: '' example: minima F_1: type: string description: 'The article number to copy.' example: '"12411116"' 'F_*': type: string description: 'optional Params to add or update for "F" params.' example: '"F_5"' 'C_*': type: string description: 'optional Params to add or update for "C" params.' example: '"C_75015"' required: - customNumber - F_1 '/api/v1/articles/delete/{articleNumber}': get: summary: Delete operationId: delete description: 'Delete an article by its number "F_1" which is the id used internally (Navision)' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Articles deleted' data: _index: articles _type: _doc _id: '12411116' _version: 4 result: deleted _shards: total: 2 successful: 1 failed: 0 _seq_no: 2338 _primary_term: 26 properties: status: type: string example: success message: type: string example: 'Articles deleted' data: type: object properties: _index: type: string example: articles _type: type: string example: _doc _id: type: string example: '12411116' _version: type: integer example: 4 result: type: string example: deleted _shards: type: object properties: total: type: integer example: 2 successful: type: integer example: 1 failed: type: integer example: 0 _seq_no: type: integer example: 2338 _primary_term: type: integer example: 26 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Article parameters: - in: path name: articleNumber description: 'The article number on "F_1".' example: '"12411116"' required: true schema: type: string '/api/v1/articles/{articleNumber}': get: summary: Search operationId: search description: 'Search an article by its number "F_1" which is the id used internally (Navision)' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Articles found' data: id: '12411116' F_1: '12411116' F_3: 'BH30-IP20-LG08-CRI90-6,1W-4K-BM45°-RFL-WHT-IDD350mADC(DALI)' F_5: '' F_80000: 'BULLET HOLE 30 - IP20 - LED G08 - CRI 90 - 6,1 W - 4000K - BEAM 45°-REFLECTOR' F_80001: 'MATT WHITE TEXTURED - INCL. DIM. DRIVER 350mA DC (DALI)' F_80002: '' F_80003: '' F_80007: '' C_75048: 'BULLET HOLE' C_75027: 'BULLET HOLE 30' C_75000: INDOOR C_75001: CEILING F_80006: 20/06/2022 properties: status: type: string example: success message: type: string example: 'Articles found' data: type: object properties: id: type: string example: '12411116' F_1: type: string example: '12411116' F_3: type: string example: 'BH30-IP20-LG08-CRI90-6,1W-4K-BM45°-RFL-WHT-IDD350mADC(DALI)' F_5: type: string example: '' F_80000: type: string example: 'BULLET HOLE 30 - IP20 - LED G08 - CRI 90 - 6,1 W - 4000K - BEAM 45°-REFLECTOR' F_80001: type: string example: 'MATT WHITE TEXTURED - INCL. DIM. DRIVER 350mA DC (DALI)' F_80002: type: string example: '' F_80003: type: string example: '' F_80007: type: string example: '' C_75048: type: string example: 'BULLET HOLE' C_75027: type: string example: 'BULLET HOLE 30' C_75000: type: string example: INDOOR C_75001: type: string example: CEILING F_80006: type: string example: 20/06/2022 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Article parameters: - in: path name: articleNumber description: 'The article number on "F_1".' example: '"12411116"' required: true schema: type: string /api/v1/jobs/job: get: summary: Job operationId: job description: "Get first job.\nThis is the first job found in the queue, same as calling jobs with (1)" parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Jobs found [job]' data: - payload: file: 'http://localhost/data/test.TestHandleSyncRequestMix.json' tries: 1 timeout: 300 failOnTimeout: true queue: delta-file middleware: [] chained: [] properties: status: type: string example: success message: type: string example: 'Jobs found [job]' data: type: array example: - payload: file: 'http://localhost/data/test.TestHandleSyncRequestMix.json' tries: 1 timeout: 300 failOnTimeout: true queue: delta-file middleware: [] chained: [] items: type: object properties: payload: type: object properties: file: type: string example: 'http://localhost/data/test.TestHandleSyncRequestMix.json' tries: type: integer example: 1 timeout: type: integer example: 300 failOnTimeout: type: boolean example: true queue: type: string example: delta-file middleware: type: array example: [] chained: type: array example: [] 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Job /api/v1/jobs/jobs: get: summary: Jobs operationId: jobs description: "Get all jobs paginated.\nThese are the jobs that still need to be handled" parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Jobs found [jobs]' data: - payload: file: 'http://localhost/data/test.TestHandleSyncRequestMix.json' tries: 1 timeout: 300 failOnTimeout: true queue: delta-file middleware: [] chained: [] properties: status: type: string example: success message: type: string example: 'Jobs found [jobs]' data: type: array example: - payload: file: 'http://localhost/data/test.TestHandleSyncRequestMix.json' tries: 1 timeout: 300 failOnTimeout: true queue: delta-file middleware: [] chained: [] items: type: object properties: payload: type: object properties: file: type: string example: 'http://localhost/data/test.TestHandleSyncRequestMix.json' tries: type: integer example: 1 timeout: type: integer example: 300 failOnTimeout: type: boolean example: true queue: type: string example: delta-file middleware: type: array example: [] chained: type: array example: [] 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Job /api/v1/jobs/files: get: summary: Files operationId: files description: "This fetches a list of files in job queue.\nIt is meant to be used as a reference point of files that still need processing" parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'files found (1)' data: - 'http://localhost/data/test.TestHandleSyncRequestMix.json.gz' properties: status: type: string example: success message: type: string example: 'files found (1)' data: type: array example: - 'http://localhost/data/test.TestHandleSyncRequestMix.json.gz' items: type: string 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Job /api/v1/jobs/failedjob: get: summary: 'Failed Job' operationId: failedJob description: "Get first failed job.\nThis gets the original failed job that prevents the rest from running, same as failed jobs (1)" parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Failed job found' data: errors: - 'Trying to add feature to an existing article, but the article does not exist: 12411112' payload: articleData: F_1: '12411112' F_80004: '248,28' file: 'http://localhost/data/test.TestHandleSyncRequestMix.json' operation: replace-article-feature tries: 1 timeout: 60 failOnTimeout: true queue: delta-article middleware: [] chained: [] properties: status: type: string example: success message: type: string example: 'Failed job found' data: type: object properties: errors: type: array example: - 'Trying to add feature to an existing article, but the article does not exist: 12411112' items: type: string payload: type: object properties: articleData: type: object properties: F_1: type: string example: '12411112' F_80004: type: string example: '248,28' file: type: string example: 'http://localhost/data/test.TestHandleSyncRequestMix.json' operation: type: string example: replace-article-feature tries: type: integer example: 1 timeout: type: integer example: 60 failOnTimeout: type: boolean example: true queue: type: string example: delta-article middleware: type: array example: [] chained: type: array example: [] 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Job /api/v1/jobs/failedjobs: get: summary: 'Failed Jobs' operationId: failedJobs description: "Get all failed jobs paginated.\nthese are the jobs in order of first to last that failed to run.\nCheck payload for original file and errors for exceptions that caused the issue" parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Failed jobs found' data: errors: - 'Trying to add feature to an existing article, but the article does not exist: 12411112' payload: articleData: F_1: '12411112' F_80004: '248,28' file: 'http://localhost/data/test.TestHandleSyncRequestMix.json' operation: replace-article-feature tries: 1 timeout: 60 failOnTimeout: true queue: delta-article middleware: [] chained: [] properties: status: type: string example: success message: type: string example: 'Failed jobs found' data: type: object properties: errors: type: array example: - 'Trying to add feature to an existing article, but the article does not exist: 12411112' items: type: string payload: type: object properties: articleData: type: object properties: F_1: type: string example: '12411112' F_80004: type: string example: '248,28' file: type: string example: 'http://localhost/data/test.TestHandleSyncRequestMix.json' operation: type: string example: replace-article-feature tries: type: integer example: 1 timeout: type: integer example: 60 failOnTimeout: type: boolean example: true queue: type: string example: delta-article middleware: type: array example: [] chained: type: array example: [] 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Job /api/v1/jobs/failedarticles: get: summary: 'Failed Articles' operationId: failedArticles description: "This fetches a list of article numbers that have failed jobs.\nIt is meant to be used as a reference point of articles that need to be re-evaluated and uploaded using the delta-update after a flush." parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Failed articles found (10)' data: - '12411112' - '12411122' - '12411132' - '12411142' - '12411152' - '12411162' - '12411172' - '12411182' - '12411212' - '12411222' properties: status: type: string example: success message: type: string example: 'Failed articles found (10)' data: type: array example: - '12411112' - '12411122' - '12411132' - '12411142' - '12411152' - '12411162' - '12411172' - '12411182' - '12411212' - '12411222' items: type: string 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Job /api/v1/jobs/failedfiles: get: summary: 'Failed Files' operationId: failedFiles description: "This fetches a list of files connected to failed jobs.\nIt is meant to be used as a reference point of files that need to be re-evaluated and uploaded using the delta-update after a flush." parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Failed files found (1)' data: - 'http://localhost/data/test.TestHandleSyncRequestMix.json.gz' properties: status: type: string example: success message: type: string example: 'Failed files found (1)' data: type: array example: - 'http://localhost/data/test.TestHandleSyncRequestMix.json.gz' items: type: string 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Job /api/v1/jobs/successfulfiles: get: summary: 'Successful Files' operationId: successfulFiles description: "This fetches a list of successful files in job queue.\nIt is meant to be used as a reference point of files that have been processed successfully" parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'successful files found (1)' data: - 'http://localhost/data/test.TestHandleSyncRequestMix.json.gz' properties: status: type: string example: success message: type: string example: 'successful files found (1)' data: type: array example: - 'http://localhost/data/test.TestHandleSyncRequestMix.json.gz' items: type: string 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Job /api/v1/jobs/clear: get: summary: 'Clear Jobs' operationId: clearJobs description: 'this clears all active jobs from the queue before they are finished' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Clear of jobs queue successful' data: null properties: status: type: string example: success message: type: string example: 'Clear of jobs queue successful' data: type: string example: null 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Job /api/v1/jobs/clearsuccessful: get: summary: 'Clear Successful Jobs' operationId: clearSuccessfulJobs description: 'this clears all successful jobs from thecustom database' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Clear of finished jobs successful' data: null properties: status: type: string example: success message: type: string example: 'Clear of finished jobs successful' data: type: string example: null 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Job /api/v1/jobs/flush: get: summary: 'Flush Failed Jobs' operationId: flushFailedJobs description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {YOUR_AUTH_KEY}' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Accept-Encoding description: '' example: 'gzip, deflate, br' schema: type: string - in: header name: Connection description: '' example: keep-alive schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: status: success message: 'Flush of failed jobs queue successful' data: null properties: status: type: string example: success message: type: string example: 'Flush of failed jobs queue successful' data: type: string example: null 401: description: '' content: application/json: schema: type: object example: status: error message: 'Message describing the error' data: null properties: status: type: string example: error message: type: string example: 'Message describing the error' data: type: string example: null tags: - Job tags: - name: Article description: "\nArticle api calls. To create, edit, delete, etc. articles." - name: Job description: "\nJob api calls. To see, flush and clear jobs in the job queue." components: securitySchemes: default: type: http scheme: bearer description: '' security: - default: []