-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
YD-60 Add specific api docs for every app version (#164)
* feat: add api docs for every app version * fix: after merge fix
- Loading branch information
Showing
59 changed files
with
66,781 additions
and
57 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| { | ||
| "openapi": "3.0.0", | ||
| "info": { | ||
| "title": "YetiForce API for SMS. Type: SMS", | ||
| "description": "", | ||
| "termsOfService": "https://yetiforce.com/", | ||
| "contact": { | ||
| "name": "Devs API Team", | ||
| "url": "https://yetiforce.com/", | ||
| "email": "[email protected]" | ||
| }, | ||
| "license": { | ||
| "name": "YetiForce Public License", | ||
| "url": "https://yetiforce.com/en/yetiforce/license" | ||
| }, | ||
| "version": "0.1" | ||
| }, | ||
| "servers": [ | ||
| { | ||
| "url": "https://gitdeveloper.yetiforce.com", | ||
| "description": "Demo server of the development version" | ||
| }, | ||
| { | ||
| "url": "https://gitstable.yetiforce.com", | ||
| "description": "Demo server of the latest stable version" | ||
| } | ||
| ], | ||
| "paths": { | ||
| "/webservice/SMS/SMSAPI/Reception": { | ||
| "get": { | ||
| "tags": [ | ||
| "SMSAPI" | ||
| ], | ||
| "summary": "Receipt of SMS", | ||
| "description": "Add record.", | ||
| "externalDocs": { | ||
| "description": "SMSApi Documentation", | ||
| "url": "https://www.smsapi.pl/docs" | ||
| }, | ||
| "operationId": "1d5b693764111be12b9441546ea6e2cb", | ||
| "responses": { | ||
| "200": { | ||
| "description": "Result", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/SMS_SMSAPI_Post_Reception" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "401": { | ||
| "description": "`No sent token` OR `Invalid token` OR `wrong data provided in the request`" | ||
| }, | ||
| "403": { | ||
| "description": "No permissions for module" | ||
| }, | ||
| "405": { | ||
| "description": "Method Not Allowed" | ||
| } | ||
| }, | ||
| "security": [ | ||
| { | ||
| "ApiKeyAuth": [], | ||
| "token": [] | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "/webservice/SMS/SMSAPI/Report": { | ||
| "get": { | ||
| "tags": [ | ||
| "SMSAPI" | ||
| ], | ||
| "summary": "Report for sms", | ||
| "description": "Update record status.", | ||
| "externalDocs": { | ||
| "description": "SMSApi Documentation", | ||
| "url": "https://www.smsapi.pl/docs" | ||
| }, | ||
| "operationId": "82162b057882b4798a1d4844f9e0161f", | ||
| "responses": { | ||
| "200": { | ||
| "description": "Result", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/SMS_SMSAPI_Get_Report" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "401": { | ||
| "description": "`No sent token` OR `Invalid token` OR `wrong data provided in the request`" | ||
| }, | ||
| "403": { | ||
| "description": "No permissions for module" | ||
| }, | ||
| "405": { | ||
| "description": "Method Not Allowed" | ||
| } | ||
| }, | ||
| "security": [ | ||
| { | ||
| "ApiKeyAuth": [], | ||
| "token": [] | ||
| } | ||
| ] | ||
| }, | ||
| "post": { | ||
| "tags": [ | ||
| "SMSAPI" | ||
| ], | ||
| "summary": "Report for sms", | ||
| "description": "Update record status.", | ||
| "externalDocs": { | ||
| "description": "SMSApi Documentation", | ||
| "url": "https://www.smsapi.pl/docs" | ||
| }, | ||
| "operationId": "2d104552585271b46f199a9df6b49930", | ||
| "responses": { | ||
| "200": { | ||
| "description": "Result", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/SMS_SMSAPI_Post_Report" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "401": { | ||
| "description": "`No sent token` OR `Invalid token` OR `wrong data provided in the request`" | ||
| }, | ||
| "403": { | ||
| "description": "No permissions for module" | ||
| }, | ||
| "405": { | ||
| "description": "Method Not Allowed" | ||
| } | ||
| }, | ||
| "security": [ | ||
| { | ||
| "ApiKeyAuth": [], | ||
| "token": [] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "components": { | ||
| "schemas": { | ||
| "SMS_SMSAPI_Post_Reception": { | ||
| "title": "Response", | ||
| "description": "Response", | ||
| "type": "string", | ||
| "example": "OK" | ||
| }, | ||
| "SMS_SMSAPI_Get_Report": { | ||
| "title": "Response", | ||
| "description": "Response", | ||
| "type": "string", | ||
| "example": "OK" | ||
| }, | ||
| "SMS_SMSAPI_Post_Report": { | ||
| "title": "Response", | ||
| "description": "Response", | ||
| "type": "string", | ||
| "example": "OK" | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| openapi: 3.0.0 | ||
| info: | ||
| title: 'YetiForce API for SMS. Type: SMS' | ||
| description: '' | ||
| termsOfService: 'https://yetiforce.com/' | ||
| contact: | ||
| name: 'Devs API Team' | ||
| url: 'https://yetiforce.com/' | ||
| email: [email protected] | ||
| license: | ||
| name: 'YetiForce Public License' | ||
| url: 'https://yetiforce.com/en/yetiforce/license' | ||
| version: '0.1' | ||
| servers: | ||
| - | ||
| url: 'https://gitdeveloper.yetiforce.com' | ||
| description: 'Demo server of the development version' | ||
| - | ||
| url: 'https://gitstable.yetiforce.com' | ||
| description: 'Demo server of the latest stable version' | ||
| paths: | ||
| /webservice/SMS/SMSAPI/Reception: | ||
| get: | ||
| tags: | ||
| - SMSAPI | ||
| summary: 'Receipt of SMS' | ||
| description: 'Add record.' | ||
| externalDocs: | ||
| description: 'SMSApi Documentation' | ||
| url: 'https://www.smsapi.pl/docs' | ||
| operationId: 1d5b693764111be12b9441546ea6e2cb | ||
| responses: | ||
| '200': | ||
| description: Result | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/SMS_SMSAPI_Post_Reception' | ||
| '401': | ||
| description: '`No sent token` OR `Invalid token` OR `wrong data provided in the request`' | ||
| '403': | ||
| description: 'No permissions for module' | ||
| '405': | ||
| description: 'Method Not Allowed' | ||
| security: | ||
| - | ||
| ApiKeyAuth: [] | ||
| token: [] | ||
| /webservice/SMS/SMSAPI/Report: | ||
| get: | ||
| tags: | ||
| - SMSAPI | ||
| summary: 'Report for sms' | ||
| description: 'Update record status.' | ||
| externalDocs: | ||
| description: 'SMSApi Documentation' | ||
| url: 'https://www.smsapi.pl/docs' | ||
| operationId: 82162b057882b4798a1d4844f9e0161f | ||
| responses: | ||
| '200': | ||
| description: Result | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/SMS_SMSAPI_Get_Report' | ||
| '401': | ||
| description: '`No sent token` OR `Invalid token` OR `wrong data provided in the request`' | ||
| '403': | ||
| description: 'No permissions for module' | ||
| '405': | ||
| description: 'Method Not Allowed' | ||
| security: | ||
| - | ||
| ApiKeyAuth: [] | ||
| token: [] | ||
| post: | ||
| tags: | ||
| - SMSAPI | ||
| summary: 'Report for sms' | ||
| description: 'Update record status.' | ||
| externalDocs: | ||
| description: 'SMSApi Documentation' | ||
| url: 'https://www.smsapi.pl/docs' | ||
| operationId: 2d104552585271b46f199a9df6b49930 | ||
| responses: | ||
| '200': | ||
| description: Result | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/SMS_SMSAPI_Post_Report' | ||
| '401': | ||
| description: '`No sent token` OR `Invalid token` OR `wrong data provided in the request`' | ||
| '403': | ||
| description: 'No permissions for module' | ||
| '405': | ||
| description: 'Method Not Allowed' | ||
| security: | ||
| - | ||
| ApiKeyAuth: [] | ||
| token: [] | ||
| components: | ||
| schemas: | ||
| SMS_SMSAPI_Post_Reception: | ||
| title: Response | ||
| description: Response | ||
| type: string | ||
| example: OK | ||
| SMS_SMSAPI_Get_Report: | ||
| title: Response | ||
| description: Response | ||
| type: string | ||
| example: OK | ||
| SMS_SMSAPI_Post_Report: | ||
| title: Response | ||
| description: Response | ||
| type: string | ||
| example: OK | ||
| securitySchemes: | ||
| ApiKeyAuth: | ||
| type: apiKey | ||
| description: 'Webservice api key header' | ||
| name: X-API-KEY | ||
| in: header | ||
| token: | ||
| type: apiKey | ||
| description: 'Webservice api token by user header' | ||
| name: X-TOKEN | ||
| in: header |
Oops, something went wrong.