Skip to content

Commit d75140d

Browse files
NeikiDevNeikiDev
committed
Update search documentation and submission policy; add threat label and clarify prohibited submissions
1 parent 7797633 commit d75140d

27 files changed

Lines changed: 98 additions & 45 deletions

File tree

‎tip-v2-build/docs/search.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Here you can find the Extended Search Documentation!
4141
| `CONTENT` | Search within extracted file content |
4242
| `VTSCORE` | VirusTotal detection score |
4343
| `FILESIZE` | File size in bytes |
44+
| `THREAT` | The threat label of the report |
4445

4546
## Operators
4647

‎tip-v2-build/docs/submission-policy.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ The following types of files are strictly prohibited:
1818

1919
- Files containing personal data or confidential information.
2020
- Junk files, such as images, videos, sound files, or other files intended to spam or abuse the system (e.g., large files uploaded to disrupt operations).
21-
- Illegal files or materials.
22-
- Files containing or displaying NSFW (Not Safe For Work) content.
21+
- Files designed as zip or archive bombs (e.g., files intended to consume excessive resources or disrupt system operations).
22+
- Files that contain or distrube illegal materials (videos, images, etc).
2323
- Files that actively leak personal information.
2424
- Submitting always the same or bulk uploads of XMRIG or other cryptocurrency mining malware is strictly prohibited.
2525

@@ -40,6 +40,7 @@ The following types of files may not be allowed, depending on context:
4040
- JAR files, such as Minecraft mods, that are widely recognized and trusted.
4141
- Uploading / Fetching or reanalyzing apk files in mass / to fast
4242
- Uploading / Fetching or reanalyzing big files in mass / to fast
43+
- Mass uploading Files containing or displaying NSFW (Not Safe For Work) content.
4344

4445
## Permitted Submissions
4546

@@ -50,6 +51,7 @@ You are allowed to upload any file that you suspect to be malicious or harmful.
5051
Violating the submission policy may result in penalties, depending on the severity and frequency of the violation:
5152

5253
- Severe violations may lead to a permanent ban of your account on "tip.neiki.dev," with no option to create a new account.
54+
- If you submit files as a "guest" user without an account, your IP address may be temporarily (24 hours) or permanently blocked via Cloudflare.
5355
- Repeated minor violations may result in a reduced trust level and loss of certain permissions.
5456

5557
## Ban Appeal

‎tip-v2-build/static/api-docs-v1.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,28 @@
55
<link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist/swagger-ui.css" />
66
</head>
77
<body>
8+
<div class="api-alert" style="
9+
background-color: #fff0e0;
10+
color: #7a3e00;
11+
padding: 1rem 1.5rem;
12+
border: 1px solid #ffd6b3;
13+
border-radius: 6px;
14+
font-size: 1rem;
15+
font-weight: 500;
16+
margin-bottom: 1.5rem;
17+
box-shadow: 0 2px 6px rgba(0, 0, 0, 0.05);
18+
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
19+
">
20+
🔶 <strong>Note:</strong> The <code>"Try it out"</code> button is disabled due to CORS restrictions.
21+
Please use a tool like
22+
<a href="https://www.postman.com/" target="_blank" rel="noopener" style="color: #d36f00; text-decoration: underline;">Postman</a>
23+
or
24+
<a href="https://insomnia.rest/" target="_blank" rel="noopener" style="color: #d36f00; text-decoration: underline;">Insomnia</a>
25+
to test the API.
26+
</div>
27+
28+
29+
830
<div id="swagger-ui"></div>
931
<script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"></script>
1032
<script>

‎tip-v2-build/static/openapi.yaml‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
openapi: 3.0.1
1+
openapi: "3.1.0"
22
info:
33
title: Threat Insights Portal - API DOCS
44
version: v1
@@ -115,29 +115,31 @@ paths:
115115
'*/*':
116116
schema:
117117
type: object
118-
/api/reports/file/{reportId}/config:
118+
/api/reports/file/{report_id}/classification:
119119
get:
120120
tags:
121121
- Report
122-
operationId: getConfig
122+
operationId: getClassification
123123
parameters:
124-
- name: reportId
124+
- name: report_id
125125
in: path
126126
required: true
127127
schema:
128128
type: string
129-
- name: Referer
130-
in: header
131-
required: false
132-
schema:
133-
type: string
134129
responses:
130+
"404":
131+
description: NOT FOUND
132+
content:
133+
'*/*':
134+
schema:
135+
type: object
135136
"200":
136137
description: OK
137138
content:
138139
'*/*':
139140
schema:
140-
type: object
141+
type: object
142+
141143
components:
142144
schemas:
143145
FileUploadDTO:

‎tip-v2/404.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta name="generator" content="Docusaurus v3.8.0">
66
<title data-rh="true">Page Not Found | Threat Insights Portal V2</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://neikidev.github.io/tip-v2/img/docusaurus-social-card.jpg"><meta data-rh="true" name="twitter:image" content="https://neikidev.github.io/tip-v2/img/docusaurus-social-card.jpg"><meta data-rh="true" property="og:url" content="https://neikidev.github.io/tip-v2/404.html"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Page Not Found | Threat Insights Portal V2"><link data-rh="true" rel="icon" href="https://tip.neiki.dev/Neiki.png"><link data-rh="true" rel="canonical" href="https://neikidev.github.io/tip-v2/404.html"><link data-rh="true" rel="alternate" href="https://neikidev.github.io/tip-v2/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://neikidev.github.io/tip-v2/404.html" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/tip-v2/blog/rss.xml" title="Threat Insights Portal V2 RSS Feed">
77
<link rel="alternate" type="application/atom+xml" href="/tip-v2/blog/atom.xml" title="Threat Insights Portal V2 Atom Feed"><link rel="stylesheet" href="/tip-v2/assets/css/styles.e1b0a7d0.css">
8-
<script src="/tip-v2/assets/js/runtime~main.367f0c54.js" defer="defer"></script>
8+
<script src="/tip-v2/assets/js/runtime~main.4b65af58.js" defer="defer"></script>
99
<script src="/tip-v2/assets/js/main.da672960.js" defer="defer"></script>
1010
</head>
1111
<body class="navigation-with-keyboard">

‎tip-v2/api-docs-v1.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,28 @@
55
<link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist/swagger-ui.css" />
66
</head>
77
<body>
8+
<div class="api-alert" style="
9+
background-color: #fff0e0;
10+
color: #7a3e00;
11+
padding: 1rem 1.5rem;
12+
border: 1px solid #ffd6b3;
13+
border-radius: 6px;
14+
font-size: 1rem;
15+
font-weight: 500;
16+
margin-bottom: 1.5rem;
17+
box-shadow: 0 2px 6px rgba(0, 0, 0, 0.05);
18+
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
19+
">
20+
🔶 <strong>Note:</strong> The <code>"Try it out"</code> button is disabled due to CORS restrictions.
21+
Please use a tool like
22+
<a href="https://www.postman.com/" target="_blank" rel="noopener" style="color: #d36f00; text-decoration: underline;">Postman</a>
23+
or
24+
<a href="https://insomnia.rest/" target="_blank" rel="noopener" style="color: #d36f00; text-decoration: underline;">Insomnia</a>
25+
to test the API.
26+
</div>
27+
28+
29+
830
<div id="swagger-ui"></div>
931
<script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"></script>
1032
<script>

‎tip-v2/assets/js/7fb5ddcd.4ee2a5f7.js‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)