fs-review-tk-6329-update-fs-api-integration-tests.tallykhata.cloud Open in urlscan Pro
103.191.179.148  Public Scan

Form analysis
0 forms found in the DOM

Text Content

ReDoc requires Javascript to function. Please enable it to browse the
documentation.
 * Healthchecks
   * getReadiness probe
   * getLiveness probe
 * postUpload Object
 * getGet Object
 * postUpload Object V2

API docs by Redocly





FILE SERVICE (1.0)

Download OpenAPI specification:Download




API endpoints for uploading and serving files/images efficiently. Supports MinIO
and S3 based object storage and serving capabilities.


HEALTHCHECKS


READINESS PROBE


RESPONSES

200

Successful Response

get/health/readiness
https://fs-review-tk-6329-update-fs-api-integration-tests.tallykhata.cloud/health/readiness


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "healthy": true,
 * "checks": [
    * {
       * "name": "string",
       * "passed": true,
       * "details": "string"
      
      }
   
   ]

}


LIVENESS PROBE


RESPONSES

200

Successful Response

get/health/liveness
https://fs-review-tk-6329-update-fs-api-integration-tests.tallykhata.cloud/health/liveness


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "healthy": true,
 * "checks": [
    * {
       * "name": "string",
       * "passed": true,
       * "details": "string"
      
      }
   
   ]

}


UPLOAD OBJECT

At least one object is needed to upload. You can upload as many objects as you
want under different key names.

AUTHORIZATIONS:

OAuth2PasswordBearer

QUERY PARAMETERS

store_at
required
enum

Valid enum list ['LOCAL', 'CLOUD'].

f1
file

Name 'f1' is user dependent. This has to be a File object.

f1_sub_dir
string

This is an optional field. In this sub directory, this file will be saved. If
you want to use then you must follow this format like '_sub_dir'

f2
file

Name 'f2' is user dependent. This has to be a File object.

f2_sub_dir
string

This is an optional field. In this sub directory, this file will be saved. If
you want to use then you must follow this format like '_sub_dir'


RESPONSES

201
400
post/upload
https://fs-review-tk-6329-update-fs-api-integration-tests.tallykhata.cloud/upload


RESPONSE SAMPLES

 * 201
 * 400

Content type
application/json
Copy
{
 * "f1": "717308ab854846249fd7df26b61b96e6.jpg",
 * "f3": "14877572e0ba477ca05233dd4465076b.webp"

}



GET OBJECT

AUTHORIZATIONS:

OAuth2PasswordBearer

PATH PARAMETERS

object_name
required
string (Object Name)


QUERY PARAMETERS

height
integer (Height)

width
integer (Width)



RESPONSES

200

Successful Response

422

Validation Error

get/{object_name}
https://fs-review-tk-6329-update-fs-api-integration-tests.tallykhata.cloud/{object_name}


RESPONSE SAMPLES

 * 200
 * 422

Content type
application/json
Copy
null



UPLOAD OBJECT V2

At least one object is needed to upload. You can upload as many objects as you
want under different key names.

AUTHORIZATIONS:

OAuth2PasswordBearer

QUERY PARAMETERS

store_at
required
enum

Valid enum list ['LOCAL', 'CLOUD'].

f1
file

Name 'f1' is user dependent. This has to be a File object.

f1_sub_dir
string

This is an optional field. In this sub directory, this file will be saved. If
you want to use then you must follow this format like '_sub_dir'

f1_is_public
bool

This is an optional field. If this is set to true, then the file will be saved
to a specific directiry and will be publicly available via a cdn link.

f2
file

Name 'f2' is user dependent. This has to be a File object.

f2_sub_dir
string

This is an optional field. In this sub directory, this file will be saved. If
you want to use then you must follow this format like '_sub_dir'


RESPONSES

201
400
post/api/v2/upload
https://fs-review-tk-6329-update-fs-api-integration-tests.tallykhata.cloud/api/v2/upload


RESPONSE SAMPLES

 * 201
 * 400

Content type
application/json
Copy
{
 * "f1": "717308ab854846249fd7df26b61b96e6.jpg",
 * "f3": "14877572e0ba477ca05233dd4465076b.webp",
 * "f1_cdn":
   "https://d3phy3nyz9yq10.cloudfront.net/public/717308ab854846249fd7df26b61b96e6.jpg"

}