Skip to content

Instantly share code, notes, and snippets.

@guhkun13

guhkun13/gist:28572b91b3681dda4d3b83011fb7c8d6

Last active December 19, 2023 10:40
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save guhkun13/28572b91b3681dda4d3b83011fb7c8d6 to your computer and use it in GitHub Desktop.
Save guhkun13/28572b91b3681dda4d3b83011fb7c8d6 to your computer and use it in GitHub Desktop.
Download ZIP
Kecilin SIGMA API postman doc
Raw
gistfile1.yaml
openapi: 3.0.3
info:
title: Sigma API (Kecilin Kloud)
version: 1.0.0
contact: {}
servers:
- url: '{{url}}'
paths:
/api/v1/users/create:
post:
tags:
- Users
summary: Create
description: Create
operationId: create
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Rosyid
password:
type: string
example: rosyid
username:
type: string
example: rosyid
examples:
Create:
value:
name: Rosyid
password: rosyid
username: rosyid
responses:
'200':
description: '200'
headers:
content-length:
schema:
type: string
example: '46'
date:
schema:
type: string
example: Wed, 17 May 2023 05:57:44 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Success create user
status:
type: number
example: 200
examples:
'200':
value:
message: Success create user
status: 200
/api/v1/users/auth:
post:
tags:
- Users
summary: Auth
description: Auth
operationId: auth
requestBody:
content:
application/json:
schema:
type: object
properties:
password:
type: string
example: rosyiddd
username:
type: string
example: rosyid
examples:
Auth:
value:
password: rosyiddd
username: rosyid
responses:
'200':
description: 200 / 401
headers:
content-length:
schema:
type: string
example: '55'
date:
schema:
type: string
example: Wed, 17 May 2023 06:22:13 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: >-
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY0NjQ2Y2Q4YzE5YWE3YjFkZGMzZWM5NCIsInVzZXJuYW1lIjoicm9zeWlkIiwiZXhwIjoxNjg0MzI2MDU4fQ.X9K9HxkettzbWWKUvMJOERB_aixwnQiH3JqfNNLrth0
status:
type: number
example: 200
examples:
'200':
value:
message: >-
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY0NjQ2Y2Q4YzE5YWE3YjFkZGMzZWM5NCIsInVzZXJuYW1lIjoicm9zeWlkIiwiZXhwIjoxNjg0MzI2MDU4fQ.X9K9HxkettzbWWKUvMJOERB_aixwnQiH3JqfNNLrth0
status: 200
'401':
value:
message: Invalid username or password
status: 401
/api/v1/users/test:
get:
tags:
- Users
summary: Test Auth
description: Test Auth
operationId: testAuth
parameters:
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token}}'
responses:
'200':
description: '200'
headers:
content-length:
schema:
type: string
example: '40'
date:
schema:
type: string
example: Wed, 17 May 2023 06:21:30 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Already login
status:
type: number
example: 200
examples:
'200':
value:
message: Already login
status: 200
'401':
description: '401'
headers:
content-length:
schema:
type: string
example: '39'
date:
schema:
type: string
example: Wed, 17 May 2023 06:21:52 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Unauthorized
status:
type: number
example: 401
examples:
'401':
value:
message: Unauthorized
status: 401
/api/v1/users/:
get:
tags:
- Users
summary: Index
description: Index
operationId: index
parameters:
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token_expired}}'
responses:
'200':
description: '200'
headers:
content-length:
schema:
type: string
example: '68'
date:
schema:
type: string
example: Mon, 18 Dec 2023 10:48:09 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
data:
nullable: true
example: null
message:
type: string
example: User API Index
status:
type: number
example: 200
success:
type: boolean
example: true
examples:
'200':
value:
data: null
message: User API Index
status: 200
success: true
/api/v1/cloud_accounts:
get:
tags:
- Cloud Account
summary: Index
description: >-
This endpoint makes an HTTP GET request to retrieve a list of cloud
accounts from the specified URL. The request does not include a request
body.
### Response
- status (number): The HTTP status code of the response.
- message (string): A message indicating the result of the API call,
which in this case is "Cloud Accounts API Index".
operationId: index1
parameters:
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token}}'
responses:
'200':
description: '200'
headers:
content-length:
schema:
type: string
example: '51'
date:
schema:
type: string
example: Wed, 17 May 2023 06:24:38 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Cloud Accounts API Index
status:
type: number
example: 200
examples:
'200':
value:
message: Cloud Accounts API Index
status: 200
'401':
description: '401'
headers:
content-length:
schema:
type: string
example: '39'
date:
schema:
type: string
example: Wed, 17 May 2023 06:24:59 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Unauthorized
status:
type: number
example: 401
examples:
'401':
value:
message: Unauthorized
status: 401
/api/v1/cloud_accounts/all:
get:
tags:
- Cloud Account
summary: Get Account
description: Get Account
operationId: getAccount
parameters:
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token}}'
responses:
'200':
description: 200 / Get Account
headers:
content-length:
schema:
type: string
example: '221'
date:
schema:
type: string
example: Wed, 17 May 2023 13:28:09 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
message:
type: array
items: {}
example: []
status:
type: number
example: 200
examples:
'200':
value:
message: []
status: 200
Get Account:
value:
message:
- _id:
$oid: 6464d600e43ca8494ffcaa16
config:
access_key_id: AKIAAAWDSFAW
bucket: testsaja
secret_access_key: g/asdasewWSffsad
service: aws
status: 200
/api/v1/cloud_accounts/create:
post:
tags:
- Cloud Account
summary: Create Account
description: Create Account
operationId: createAccount
parameters:
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token}}'
requestBody:
content:
application/json:
schema:
type: object
properties:
config:
type: object
properties:
access_key_id:
type: string
example: AKIAWRLP6O5SQ7CYHKN5
bucket:
type: string
example: testvodbca
secret_access_key:
type: string
example: g/JSRYxaSUrpal9lOyZdUMKDjCCiNIr4OsVj15Nw
slug:
type: string
example: aws
examples:
Create Account:
value:
config:
access_key_id: AKIAWRLP6O5SQ7CYHKN5
bucket: testvodbca
secret_access_key: g/JSRYxaSUrpal9lOyZdUMKDjCCiNIr4OsVj15Nw
slug: aws
Create Account - SFTP:
value:
config:
access_key_id: AKIAWRLP6O5SQ7CYHKN5
bucket: testvodbca
secret_access_key: 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
slug: aws
responses:
'200':
description: 200 / Create Account / 200 / Create Account
headers:
content-length:
schema:
type: string
example: '46'
date:
schema:
type: string
example: Wed, 17 May 2023 13:38:07 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Account already exist
message:
type: string
example: Success Create Cloud Account
status:
type: number
example: 200
examples:
'200':
value:
message: Success Create Cloud Account
status: 200
Create Account:
value:
error: Account already exist
status: 200
/api/v1/compression:
get:
tags:
- Cloud Compress
summary: Index
description: Index
operationId: index2
parameters:
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token}}'
responses:
'200':
description: '200'
headers:
content-length:
schema:
type: string
example: '48'
date:
schema:
type: string
example: Wed, 17 May 2023 06:32:52 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Compression API Index
status:
type: number
example: 200
examples:
'200':
value:
message: Compression API Index
status: 200
/api/v1/compression/active:
get:
tags:
- Cloud Compress
summary: Get Active Engine
description: Get Active Engine
operationId: getActiveEngine
parameters:
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token}}'
responses:
'200':
description: '200'
headers:
content-length:
schema:
type: string
example: '51'
date:
schema:
type: string
example: Wed, 17 May 2023 06:33:06 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
message:
type: array
items:
type: string
example: jpg
example:
- jpg
- jpeg
- mp4
- pdf
status:
type: number
example: 200
examples:
'200':
value:
message:
- jpg
- jpeg
- mp4
- pdf
status: 200
/api/v1/compression/1123123/status:
get:
tags:
- Cloud Compress
summary: Get Compression Status
description: Get Compression Status
operationId: getCompressionStatus
parameters:
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token}}'
responses:
'200':
description: '200'
headers:
content-length:
schema:
type: string
example: '51'
date:
schema:
type: string
example: Wed, 17 May 2023 06:33:06 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
message:
type: array
items:
type: string
example: jpg
example:
- jpg
- jpeg
- mp4
- pdf
status:
type: number
example: 200
examples:
'200':
value:
message:
- jpg
- jpeg
- mp4
- pdf
status: 200
/api/v1/compression/upload:
post:
tags:
- Cloud Compress
summary: Upload File
description: Upload File
operationId: uploadFile
parameters:
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token}}'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
account:
type: string
example: 646487e8b3d07d5f39a63bc4
file:
type: string
format: binary
path:
type: string
example: a/b/c/df/coba2.jpg
responses:
'200':
description: >-
200 - Object storage not found / 200 - Failed upload compressed file
/ Upload File Success
headers:
content-length:
schema:
type: string
example: '70'
date:
schema:
type: string
example: Wed, 17 May 2023 08:08:07 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Failed upload compressed file GPIO_fan_connection-1.jpg
message:
type: string
example: Object storage account not found
status:
type: number
example: 200
examples:
200 - Failed upload compressed file:
value:
error: Failed upload compressed file GPIO_fan_connection-1.jpg
status: 200
200 - Object storage not found:
value:
message: Object storage account not found
status: 200
Upload File Success:
value:
message: Success compress file to a/b/c/df/coba2.jpg
status: 200
/api/v1/compression/logs:
get:
tags:
- Cloud Compress
summary: Logs
description: Logs
operationId: logs
parameters:
- name: username
in: query
schema:
type: string
example: all
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token}}'
responses:
'200':
description: '200'
headers:
content-length:
schema:
type: string
example: '371'
date:
schema:
type: string
example: Sun, 30 Jul 2023 17:00:24 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
message:
type: array
items:
type: object
properties:
cloud_account:
type: object
properties:
$oid:
type: string
example: 64c69345acf5c2900103046e
compressed_size:
type: string
example: '0'
created_at:
type: object
properties:
$date:
type: number
example: 1690735919007
filename:
type: string
example: file_example_PNG_3MB.png
ori_size:
type: string
example: '0'
state:
type: string
example: extension not allowed
example:
- compressed_size: '0'
created_at:
$date: 1690735919007
filename: file_example_PNG_3MB.png
ori_size: '0'
state: extension not allowed
- cloud_account:
$oid: 64c69345acf5c2900103046e
compressed_size: '16963'
created_at:
$date: 1690736415240
filename: Lampu_Gantung_Panjang_Kayu.jpeg
ori_size: '39539'
state: success
status:
type: number
example: 200
examples:
'200':
value:
message:
- compressed_size: '0'
created_at:
$date: 1690735919007
filename: file_example_PNG_3MB.png
ori_size: '0'
state: extension not allowed
- cloud_account:
$oid: 64c69345acf5c2900103046e
compressed_size: '16963'
created_at:
$date: 1690736415240
filename: Lampu_Gantung_Panjang_Kayu.jpeg
ori_size: '39539'
state: success
status: 200
/api/v1/cloud_services:
get:
tags:
- Cloud Services
summary: Index
description: Index
operationId: index3
parameters:
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token}}'
responses:
'200':
description: '200'
headers:
content-length:
schema:
type: string
example: '51'
date:
schema:
type: string
example: Wed, 17 May 2023 06:27:49 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Cloud Services API Index
status:
type: number
example: 200
examples:
'200':
value:
message: Cloud Services API Index
status: 200
/api/v1/cloud_services/all:
get:
tags:
- Cloud Services
summary: Get All Services
description: Get All Services
operationId: getAllServices
parameters:
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token}}'
responses:
'200':
description: '200'
headers:
content-length:
schema:
type: string
example: '226'
date:
schema:
type: string
example: Fri, 04 Aug 2023 10:36:04 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
name:
type: string
example: Amazon Web Service
slug:
type: string
example: aws
example:
- name: Amazon Web Service
slug: aws
- name: Google Cloud Platform
slug: gcp
- name: SFTP
slug: sftp
- name: S3 Compatible
slug: s3
- name: Alibaba Cloud OSS
slug: albb_oss
status:
type: number
example: 200
examples:
'200':
value:
data:
- name: Amazon Web Service
slug: aws
- name: Google Cloud Platform
slug: gcp
- name: SFTP
slug: sftp
- name: S3 Compatible
slug: s3
- name: Alibaba Cloud OSS
slug: albb_oss
status: 200
/api/v1/cloud_services/config:
get:
tags:
- Cloud Services
summary: Get Service Config
description: Get Service Config
operationId: getServiceConfig
parameters:
- name: slug
in: query
schema:
type: string
example: albb_oss
- name: '{{tokenHeaderName}}'
in: header
schema:
type: string
example: '{{token}}'
responses:
'200':
description: 200 / sftp / aws / gcp / s3 / albb_oss
headers:
content-length:
schema:
type: string
example: '243'
date:
schema:
type: string
example: Fri, 04 Aug 2023 10:37:06 GMT
server:
schema:
type: string
example: uvicorn
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
name:
type: string
example: access_key_id
order:
type: number
example: 1
title:
type: string
example: Access Key ID
example:
- name: access_key_id
order: 1
title: Access Key ID
- name: secret_access_key
order: 2
title: Secret Access Key
- name: bucket
order: 3
title: Bucket
status:
type: number
example: 200
examples:
'200':
value:
data:
- name: access_key_id
order: 1
title: Access Key ID
- name: secret_access_key
order: 2
title: Secret Access Key
- name: bucket
order: 3
title: Bucket
status: 200
albb_oss:
value:
data:
- name: endpoint
order: 1
title: Endpoint
- name: access_key_id
order: 2
title: Access Key ID
- name: secret_access_key
order: 3
title: Secret Access Key
- name: bucket
order: 4
title: Bucket
status: 200
aws:
value:
data:
- name: access_key_id
order: 1
title: Access Key ID
- name: secret_access_key
order: 2
title: Secret Access Key
- name: bucket
order: 3
title: Bucket
status: 200
gcp:
value:
data:
- name: file_credential
order: 1
title: File Credential
- name: bucket
order: 2
title: Bucket
status: 200
s3:
value:
data:
- name: endpoint
order: 1
title: S3 Endpoint
- name: access_key_id
order: 2
title: Access Key ID
- name: secret_access_key
order: 3
title: Secret Access Key
- name: bucket
order: 4
title: Bucket
status: 200
sftp:
value:
data:
- name: address
order: 1
title: Host / IP Address
- name: port
order: 2
title: Port
- name: username
order: 3
title: Username
- name: password
order: 4
title: Password
- name: path
order: 5
title: Path Folder
status: 200
tags:
- name: Users
- name: Cloud Account
- name: Cloud Compress
- name: Cloud Services
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment