{ "openapi": "3.0.0", "info": { "title": "Arabhardware", "description": "A short description of the API", "contact": { "name": "Support Team", "email": "sbilal@arabhardware.net" }, "version": "1.0.0" }, "paths": { "/{key}/api/v1/authors": { "post": { "tags": [ "Authors" ], "summary": "Get a list of Authors", "operationId": "42b5ab95c2c1bc3b8afb64f3e2eb46be", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } }, { "name": "p", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/author/{slug}": { "post": { "tags": [ "Authors" ], "summary": "Get the details of an author", "operationId": "e77c9d594b71b6386c22ca321e960d79", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "path", "description": "The slug of the author", "required": true, "schema": { "type": "string" } }, { "name": "post_type", "in": "query", "description": "The type of the posts", "required": false, "schema": { "type": "string" } }, { "name": "s", "in": "query", "description": "text for searching posts of this author", "required": false, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/companies": { "post": { "tags": [ "Companies" ], "summary": "Get a list of Companies", "operationId": "c1b47cd9542217408a4aef5c105324d2", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "number for paginations", "required": false, "schema": { "type": "integer" } }, { "name": "s", "in": "query", "description": "text for searching posts of this author", "required": false, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/companies/{slug}": { "post": { "tags": [ "Companies" ], "summary": "Get the details of a company", "operationId": "b35fe671af957a7d31b11bdf9a5bd561", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "path", "description": "The slug of the company", "required": true, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } }, { "name": "post_type", "in": "query", "description": "The type of the posts", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "number for paginations", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/games": { "post": { "tags": [ "Games" ], "summary": "Get a list of Games", "operationId": "9d0ff3b7d4573005ae231ad6330d7b37", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "number for paginations", "required": false, "schema": { "type": "integer" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/games/{slug}": { "post": { "tags": [ "Games" ], "summary": "Get the details of a Game", "operationId": "24953f45d785ecf4723d25da239c684a", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "path", "description": "The slug of the Game", "required": true, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } }, { "name": "post_type", "in": "query", "description": "The type of the posts", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "number for paginations", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/mobiles": { "post": { "tags": [ "Mobiles" ], "summary": "Get a list of Mobiles", "operationId": "b2c9bf5fdb40af8121cd68416b442db2", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "number for paginations", "required": false, "schema": { "type": "integer" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/mobiles-companies": { "post": { "tags": [ "Mobiles" ], "summary": "Get a list of Mobile companies", "operationId": "d1afe320154738a0d82b520d3bb822a5", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "number for paginations", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/mobiles-{company}": { "post": { "tags": [ "Mobiles" ], "summary": "Get the details of a mobiles in a company", "operationId": "ff70d969223bd353dc8a1734d7e70067", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "number for paginations", "required": false, "schema": { "type": "integer" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } }, { "name": "company", "in": "path", "description": "The slug of the company", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/mobiles/{slug}": { "post": { "tags": [ "Mobiles" ], "summary": "Get the details of a Mobile", "operationId": "eb15e6cd1006203374c15126a263c8e5", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "path", "description": "The slug of the Mobile", "required": true, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } }, { "name": "post_type", "in": "query", "description": "The type of the posts", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "number for paginations", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/hardware": { "post": { "tags": [ "Hardware" ], "summary": "Get a list of Hardware", "operationId": "ab4e31b8efa61b13c02d9a7c9b6381be", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "number for paginations", "required": false, "schema": { "type": "integer" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/hardware/{slug}": { "post": { "tags": [ "Hardware" ], "summary": "Get the details of a Hardware", "operationId": "e1cc4e8831b23482edde3eba4187cc90", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "path", "description": "The slug of the Hardware", "required": true, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } }, { "name": "post_type", "in": "query", "description": "The type of the posts", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "number for paginations", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/posts": { "post": { "tags": [ "Posts" ], "summary": "Retrieve a list of posts", "operationId": "166926887bb2b6f2e90ed1d494f32e98", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "example": 10 } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "type", "in": "query", "description": "Comma-separated list of post types to filter", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Category to filter posts", "required": false, "schema": { "type": "string" } }, { "name": "tag", "in": "query", "description": "Tag to filter posts", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A paginated list of posts", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string" }, "thumbanil_id": { "type": "integer" }, "published_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "meta": { "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid parameters" } }, "type": "object" } } } }, "500": { "description": "Server error" } } } }, "/{key}/api/v1/home": { "post": { "tags": [ "Home" ], "summary": "Retrieve homepage content", "operationId": "55aecc6809ce6fbe25ae262e6ade1eac", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "example": 10 } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Homepage content including latest posts", "content": { "application/json": { "schema": { "properties": { "pins": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string" }, "published_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "latest": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string" }, "published_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "latest_news": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string" }, "published_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "latest_reviews": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string" }, "published_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "latest_articles": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string" }, "published_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "latest_how": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string" }, "published_at": { "type": "string", "format": "date-time" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invalid parameters" } }, "type": "object" } } } }, "500": { "description": "Server error" } } } }, "/{key}/api/v1/posts/{post_single}/{slug}": { "post": { "tags": [ "Posts" ], "summary": "Retrieve a single post", "operationId": "e28e458611c79ae2d888dd9db9aff7dc", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "post_single", "in": "path", "description": "Type of post (e.g., news, articles)", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "path", "description": "Slug of the post to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "feed", "in": "query", "description": "Feed type (optional)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful retrieval of the post", "content": { "application/json": { "schema": { "properties": { "results": { "properties": { "post": { "type": "object" }, "supports": { "type": "array", "items": { "type": "string" } }, "comments": { "type": "array", "items": { "type": "object" } }, "noindex": { "type": "boolean" }, "popular": { "type": "array", "items": { "type": "object" } }, "related_posts": { "type": "array", "items": { "type": "object" } }, "template": { "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Post not found or no access", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Post not found" } }, "type": "object" } } } }, "500": { "description": "Server error" } } } }, "/{key}/api/v1/posts/{year}/{month}/{day}/{slug}": { "post": { "tags": [ "Posts" ], "summary": "Retrieve a single post by date and slug", "operationId": "81a247dfcbd8cd08ceda592085cc356c", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "year", "in": "path", "description": "Year of the post", "required": true, "schema": { "type": "integer" } }, { "name": "month", "in": "path", "description": "Month of the post", "required": true, "schema": { "type": "integer" } }, { "name": "day", "in": "path", "description": "Day of the post", "required": true, "schema": { "type": "integer" } }, { "name": "slug", "in": "path", "description": "Slug of the post", "required": true, "schema": { "type": "string" } } ], "responses": { "301": { "description": "Redirect to the post's URL", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Redirecting to post URL" } }, "type": "object" } } } }, "404": { "description": "Post not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Post not found" } }, "type": "object" } } } }, "500": { "description": "Server error" } } } }, "/{key}/api/v1/posts/post-{id}": { "post": { "tags": [ "Posts" ], "summary": "Retrieve a single post by ID", "operationId": "75eed27d1f776ba9485be788778bf262", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "ID of the post to retrieve", "required": true, "schema": { "type": "integer" } } ], "responses": { "301": { "description": "Redirect to the post's URL", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Redirecting to post URL" } }, "type": "object" } } } }, "404": { "description": "Post not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Post not found" } }, "type": "object" } } } }, "500": { "description": "Server error" } } } }, "/{key}/api/v1/posts/{post_type}": { "post": { "tags": [ "Posts" ], "summary": "Retrieve posts by type", "operationId": "c90d237e2ebe71cadd16b4f0d5356f02", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "post_type", "in": "path", "description": "Type of posts to retrieve (e.g., news, articles)", "required": true, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Number of items per page for pagination", "required": false, "schema": { "type": "integer", "example": 10 } }, { "name": "fresh", "in": "query", "description": "If set to true, forces a fresh data retrieval", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful retrieval of posts by type", "content": { "application/json": { "schema": { "properties": { "posts": { "type": "array", "items": { "type": "object" } }, "popular": { "type": "array", "items": { "type": "object" } }, "pins": { "type": "array", "items": { "type": "object" } }, "categories": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "No posts found for the specified type", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "No posts found" } }, "type": "object" } } } }, "500": { "description": "Server error" } } } }, "/{key}/api/v1/category/{slug}": { "post": { "tags": [ "Posts" ], "summary": "Retrieve posts by category", "operationId": "0a84d43c5094763dedf75318e7c08cc3", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "path", "description": "Slug of the category to filter posts", "required": true, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Number of items per page for pagination", "required": false, "schema": { "type": "integer", "example": 10 } }, { "name": "post_type", "in": "query", "description": "Type of posts to filter (e.g., news, articles)", "required": false, "schema": { "type": "string" } }, { "name": "fresh", "in": "query", "description": "If set to true, forces a fresh data retrieval", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful retrieval of posts by category", "content": { "application/json": { "schema": { "properties": { "category": { "type": "string", "example": "category_slug" }, "posts": { "type": "array", "items": { "type": "object" } }, "popular": { "type": "array", "items": { "type": "object" } }, "pins": { "type": "array", "items": { "type": "object" } }, "categories": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Category not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Category not found" } }, "type": "object" } } } }, "500": { "description": "Server error" } } } }, "/{key}/api/v1/tag/{slug}": { "post": { "tags": [ "Posts" ], "summary": "Get the details of a tag", "operationId": "a4aa9aad1c0019d59032b1062a7ceca8", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "path", "description": "The slug of the tag", "required": true, "schema": { "type": "string" } }, { "name": "post_type", "in": "query", "description": "The type of the posts", "required": false, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/timelines": { "post": { "tags": [ "Posts" ], "summary": "Get a list of timelines with posts", "operationId": "e7885346a71562ea825e2077d188fde8", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "number for paginations", "required": false, "schema": { "type": "integer" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/timelines/{slug}": { "post": { "tags": [ "Posts" ], "summary": "Get the details of a timeline", "operationId": "50dc8174e066a18ee273cd310d2233a2", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "path", "description": "The slug of the timeline", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/posts-feeds": { "post": { "tags": [ "Posts" ], "summary": "Retrieve posts feeds based on types, categories, and tags", "operationId": "198da695a953ea8099ea18f96463755d", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "types", "in": "query", "description": "Comma-separated list of post types to filter (e.g., news, articles)", "required": false, "schema": { "type": "string" } }, { "name": "cats", "in": "query", "description": "Comma-separated list of categories to filter posts", "required": false, "schema": { "type": "string" } }, { "name": "tags", "in": "query", "description": "Comma-separated list of tags to filter posts", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } }, { "name": "fresh", "in": "query", "description": "If set to true, forces a fresh data retrieval", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful retrieval of posts feeds", "content": { "application/json": { "schema": { "properties": { "posts": { "type": "array", "items": { "type": "object" } }, "last_feed": { "type": "string", "example": "2023-10-01T12:00:00Z" }, "ver": { "type": "string", "example": "" } }, "type": "object" } } } }, "500": { "description": "Server error" } } } }, "/{key}/api/v1/search": { "post": { "tags": [ "Search" ], "summary": "Search the ecosystem", "operationId": "31051f4cd8075de3961829b279ae5ef8", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "s", "in": "query", "description": "Text for searching posts", "required": true, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Items per page", "required": true, "schema": { "type": "integer" } }, { "name": "for", "in": "query", "description": "Categories for the search (Options: all, store, articles, news, how, reviews, videos)", "required": false, "schema": { "type": "string", "enum": [ "all", "store", "articles", "news", "how", "reviews", "videos" ] } }, { "name": "p", "in": "query", "description": "Page number", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "s", "i", "p" ], "properties": { "s": { "description": "Text for searching posts", "type": "string", "example": "latest tech news" }, "i": { "description": "Items per page", "type": "integer", "example": 10 }, "for": { "description": "Categories for the search", "type": "string", "example": "all" }, "p": { "description": "Page number", "type": "integer", "example": 1 } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "description": "Search results", "type": "object" }, "tags": { "description": "Search tags", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Search failed" } } } }, "/{key}/api/v1/user-interests": { "post": { "tags": [ "User" ], "summary": "Add user interests", "operationId": "ed2e85329d13467d6ce1850603a8e68c", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "tags" ], "properties": { "tags": { "description": "Array of tag IDs", "type": "array", "items": { "description": "IDs of tags that the user is interested in", "type": "integer", "example": 1 } } }, "type": "object" } } } }, "responses": { "200": { "description": "Tags added successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Tags added successfully" } }, "type": "object" } } } }, "500": { "description": "Server error" } } } }, "/{key}/api/v1/user-widgets": { "post": { "tags": [ "User" ], "summary": "Add user widgets", "operationId": "cc8b1a1b6a7d170ad8ca1b899cea22cc", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "widgets" ], "properties": { "widgets": { "description": "Array of widget names", "type": "array", "items": { "description": "Names of widgets that the user wants to add", "type": "string", "example": "widget_name_1" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Widgets added successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Widgets added successfully" } }, "type": "object" } } } }, "500": { "description": "Server error" } } } }, "/{key}/api/v1/weather": { "post": { "tags": [ "Widgets" ], "summary": "get the weather", "operationId": "1eb2c2c4f6017a6719bd4b7f34a74b9b", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "lat", "in": "query", "description": "latitude of the location", "required": false, "schema": { "type": "string" } }, { "name": "long", "in": "query", "description": "longitude of the location", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/exchange-rates": { "post": { "tags": [ "Widgets" ], "summary": "get the exchange rates of today", "operationId": "0da13e726c31c059ce114e7d74635ebf", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "c", "in": "query", "description": "The currency to get (Options: EGP, SAR, AED)", "required": false, "schema": { "type": "string", "enum": [ "EGP", "SAR", "AED" ] } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/daily-news": { "post": { "tags": [ "Widgets" ], "summary": "get the exchange rates of today", "operationId": "2eb4a64f694064fbce9ec86d6a561f69", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/trends": { "post": { "tags": [ "Widgets" ], "summary": "get the trends of today", "operationId": "d070be0cc0f16fdafbd3ae9123330d36", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/shorts": { "post": { "tags": [ "Videos" ], "summary": "get a list of the shorts", "operationId": "3f175dcba22a4bb2e80b8271f4375914", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } }, { "name": "i", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer" } }, { "name": "p", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/editors-choice": { "post": { "tags": [ "Widgets" ], "summary": "get the editor's choices of today", "operationId": "2063bc15664ad7776bcf021ce44f5bf6", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } }, "/{key}/api/v1/delete-all-videos": { "delete": { "tags": [ "Videos" ], "summary": "Delete all videos", "operationId": "ab4c9da21a4dcddf157b58a81ce4eb22", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Videos deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Videos deleted successfully." } }, "type": "object" } } } }, "400": { "description": "Invalid request" }, "404": { "description": "Videos not found" } } } }, "/{key}/api/v1/videos": { "post": { "tags": [ "Videos" ], "summary": "Add bulk videos", "operationId": "0cda0c9bb41e0bd884cc8df6ad8d3b81", "parameters": [ { "name": "key", "in": "path", "description": "Key of the API", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request" } } } } }, "tags": [ { "name": "Authors", "description": "Authors" }, { "name": "Companies", "description": "Companies" }, { "name": "Games", "description": "Games" }, { "name": "Mobiles", "description": "Mobiles" }, { "name": "Hardware", "description": "Hardware" }, { "name": "Posts", "description": "Posts" }, { "name": "Home", "description": "Home" }, { "name": "Search", "description": "Search" }, { "name": "User", "description": "User" }, { "name": "Widgets", "description": "Widgets" }, { "name": "Videos", "description": "Videos" } ] }