Creating an Open Api specification

openapi-codegen-php.json

@@ -0,0 +1,7 @@
+{
+	"composerVendorName": "xtrime-ru",
+	"composerProjectName": "TelegramPhpClient",
+	"artifactVersion": "1.10.4",
+	"invokerPackage": "xtrime-ru\\TelegramPhpClient",
+	"packagePath": "TelegramPhpClient"
+}

openapi-codegen-readme.md

@@ -0,0 +1,93 @@
+## Download swagger-codegen binary
+
+```bash
+wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.22/swagger-codegen-cli-3.0.22.jar -O swagger-codegen-cli.jar
+```
+
+
+## Generate single open api yaml file
+
+```bash
+docker run --rm -v ${PWD}:/local -w /local openjdk java -jar swagger-codegen-cli.jar generate \
+    --input-spec /local/openapi.yaml --lang openapi-yaml --output /local/out/ -c /local/openapi-codegen-php.json
+```
+
+## Generate PHP client library
+
+```bash
+docker run --rm -v ${PWD}:/local -w /local openjdk java -jar swagger-codegen-cli.jar generate \
+    --input-spec /local/openapi.yaml --lang php --output /local/out/ -c /local/openapi-codegen-php.json
+```
+
+### Use custom codegenerator templates
+
+`--template-dir /local/php/`
+
+## Generate other
+
+docker run --rm -v ${PWD}:/local -w /local openjdk java -jar swagger-codegen-cli.jar generate \
+    --input-spec /local/openapi.yaml --lang dynamic-html --output /local/out/ -c /local/openapi-codegen-php.json
+
+docker run --rm -v ${PWD}:/local -w /local openjdk java -jar swagger-codegen-cli.jar generate \
+    --input-spec /local/openapi.yaml --lang html --output /local/out/ -c /local/openapi-codegen-php.json
+
+
+
+
+docker run --rm \
+    -v $PWD:/local \
+    openapitools/openapi-generator-cli \
+    generate \
+    -i /local/openapi.yaml \
+    -g asciidoc \
+    -o /local/out/asciidoc
+
+
+docker run --rm \
+    -v $PWD:/local \
+    openapitools/openapi-generator-cli \
+    generate \
+    -i /local/openapi.yaml \
+    -g dynamic-html \
+    -o /local/out/dynamic-html
+
+
+docker run --rm \
+    -v $PWD:/local \
+    openapitools/openapi-generator-cli \
+    generate \
+    -i /local/openapi.yaml \
+    -g html2 \
+    -o /local/out/html2
+
+
+docker run --rm \
+    -v $PWD:/local \
+    openapitools/openapi-generator-cli \
+    generate \
+    -i /local/openapi.yaml \
+    -g openapi \
+    -o /local/out/openapi
+
+
+docker run --rm \
+    -v $PWD:/local \
+    openapitools/openapi-generator-cli \
+    generate \
+    -i /local/openapi.yaml \
+    -g openapi-yaml \
+    -o /local/out/openapi-yaml
+
+
+    docker run --rm \
+    --network host \
+    -v $PWD:/local \
+    openapitools/openapi-generator-cli \
+    generate \
+    -i https://docs.api2.dev.hoqu.com/docs/api.yml \
+    -g openapi-yaml \
+    -o /local/out/hoq0-openapi-yaml
+
+
+Swagger-Codegen/1.10.4/php
+

openapi.yaml

@@ -0,0 +1,63 @@
+openapi: 3.0.1
+
+info:
+  title: Telegram Api Server
+  description: 'Fast, simple, async php telegram api server: MadelineProto + Amp HTTP
+    Server'
+  license:
+    name: MIT License
+    url: https://github.com/xtrime-ru/TelegramApiServer/blob/master/LICENSE
+  version: 1.10.4
+
+externalDocs:
+  description: Async PHP client/server API for the telegram MTProto protocol
+  url: https://github.com/danog/MadelineProto
+
+servers:
+- url: https://example.com/
+- url: http://example.com/
+
+#security:
+#- basicAuth: []
+
+tags:
+- name: system
+  description: Different settings for sessions
+  externalDocs:
+    description: Find out more
+    url: https://github.com/xtrime-ru/TelegramApiServer#different-settings-for-sessions
+
+- name: api
+  description: All methods from MadelineProto supported
+  externalDocs:
+    description: Methods List
+    url: https://docs.madelineproto.xyz/API_docs/methods/
+
+- name: login
+  description: Login methods from MadelineProto
+  externalDocs:
+    description: Methods List
+    url: https://docs.madelineproto.xyz/API_docs/methods/
+
+paths:
+  /system/getSessionList:
+    $ref: './openapi/paths/system/getSessionList.yaml'
+
+  /system/addSession:
+    $ref: './openapi/paths/system/addSession.yaml'
+
+  /api/{session}/phoneLogin:
+    $ref: './openapi/paths/api/phoneLogin.yaml'
+
+  /api/{session}/completePhoneLogin:
+    $ref: './openapi/paths/api/completePhoneLogin.yaml'
+
+  /api/{session}/completeSignup:
+    $ref: './openapi/paths/api/completeSignup.yaml'
+
+
+
+#  securitySchemes:
+#    basicAuth:
+#      type: http
+#      scheme: basic

openapi/models/api/AccountNeedSignup.yaml

@@ -0,0 +1,7 @@
+type: object
+properties:
+  _:
+    type: string
+    default: "account.needSignup"
+  terms_of_service:
+    $ref: '../api/TermsOfService.yaml'

openapi/models/api/AuthAuthorization.yaml

@@ -0,0 +1,7 @@
+type: object
+properties:
+  _:
+    type: string
+    default: "auth.authorization"
+  user:
+    $ref: '../api/User.yaml'

openapi/models/api/AuthSentCode.yaml

@@ -0,0 +1,18 @@
+type: object
+properties:
+  _:
+    type: string
+    default: "auth.sentCode"
+  type:
+    $ref: '../api/SentCodeTypeSms.yaml'
+  phone_code_hash:
+    type: string
+    example: "3aae168ea0609da27f"
+  next_type:
+    $ref: '../api/CodeTypeCall.yaml'
+  timeout:
+    type: integer
+    example: 120
+  phone_number:
+    type: string
+    example: "+79636025112"

openapi/models/api/CodeTypeCall.yaml

@@ -0,0 +1,4 @@
+properties:
+  _:
+    type: string
+    default: "auth.codeTypeCall"

openapi/models/api/SentCodeTypeSms.yaml

@@ -0,0 +1,7 @@
+properties:
+  _:
+    type: string
+    default: "auth.sentCodeTypeSms"
+  length:
+    type: integer
+    example: 5

openapi/models/api/TermsOfService.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  _:
+    type: string
+    default: "help.termsOfService"
+  popup:
+    type: boolean
+    default: false
+  id:
+    $ref: '../api/TermsOfServiceId.yaml'
+  text:
+    type: string
+    default: "By signing up for Telegram, you agree not to:\n\n- Use our service to send spam or scam users.\n- Promote violence on publicly viewable Telegram bots, groups or channels.\n- Post pornographic content on publicly viewable Telegram bots, groups or channels.\n\nWe reserve the right to update these Terms of Service later."
+  entities:
+    type: array
+    items: {}

openapi/models/api/TermsOfServiceId.yaml

@@ -0,0 +1,19 @@
+properties:
+  country:
+    type: string
+    example: "RU"
+  min_age:
+    type: boolean
+    default: false
+  terms_key:
+    type: string
+    example: "TERMS_OF_SERVICE"
+  terms_lang:
+    type: string
+    example: "en"
+  terms_version:
+    type: integer
+    default: 1
+  terms_hash:
+    type: string
+    default: "7dca806cb8d387c07c778ce9ef6aac04"

openapi/models/api/User.yaml

@@ -0,0 +1,40 @@
+properties:
+  _:
+    type: string
+    default: "user"
+  self:
+    type: boolean
+  contact:
+    type: boolean
+  mutual_contact:
+    type: boolean
+  deleted:
+    type: boolean
+  bot:
+    type: boolean
+  bot_chat_history:
+    type: boolean
+  bot_nochats:
+    type: boolean
+  verified:
+    type: boolean
+  restricted:
+    type: boolean
+  min:
+    type: boolean
+  bot_inline_geo:
+    type: boolean
+  support:
+    type: boolean
+  scam:
+    type: boolean
+  id:
+    type: integer
+  access_hash:
+    type: integer
+    example: 4963221948965825237
+  first_name:
+    type: string
+  phone:
+    type: string
+    example: "79636025112"

openapi/models/common/Backtrace.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  file:
+    type: string
+  line:
+    type: integer
+  function:
+    type: string
+  class:
+    type: string
+  type:
+    type: string
+  args:
+    type: array
+    items: {}

openapi/models/common/BacktraceArray.yaml

@@ -0,0 +1,3 @@
+type: array
+items:
+    $ref: '../models/Backtrace.yaml'

openapi/models/common/Error.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  exception:
+    type: string
+  message:
+    type: string
+  file:
+    type: string
+  line:
+    type: integer
+  code:
+    type: integer
+  backtrace:
+    type: array
+    items:
+      $ref: '../common/Backtrace.yaml'

openapi/models/system/AppInfo.yaml

@@ -0,0 +1,7 @@
+properties:
+  app_id:
+    type: integer
+    description: App api_id
+  app_hash:
+    type: string
+    description: App api_hash

openapi/models/system/Session.yaml

@@ -0,0 +1,14 @@
+properties:
+  session:
+    type: string
+  file:
+    type: string
+  status:
+    type: string
+    enum:
+    - NOT_LOGGED_IN
+    - WAITING_CODE
+    - WAITING_PASSWORD
+    - WAITING_SIGNUP
+    - LOGGED_IN
+    - LOADING

openapi/models/system/SessionList.yaml

@@ -0,0 +1,7 @@
+properties:
+  sessions:
+    type: object
+    additionalProperties:
+      $ref: '../system/Session.yaml'
+  memory:
+    type: string

openapi/models/system/SessionSettings.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  app_info:
+    $ref: '../system/AppInfo.yaml'

openapi/parameters/session.yaml

@@ -0,0 +1,6 @@
+in: path
+name: session
+schema:
+  type: string
+required: true
+description: Session name