diff --git a/package-lock.json b/package-lock.json
index 884a805..13cfbc0 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "@mtakla/cronops",
- "version": "0.1.1-rc2.3",
+ "version": "0.1.1-rc2.4",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@mtakla/cronops",
- "version": "0.1.1-rc2.3",
+ "version": "0.1.1-rc2.4",
"license": "ISC",
"dependencies": {
"chalk": "5.6.2",
diff --git a/src/api/openapi.ts b/src/api/openapi.ts
index 1284361..96ec5fe 100644
--- a/src/api/openapi.ts
+++ b/src/api/openapi.ts
@@ -1,6 +1,19 @@
export const openapi = {
openapi: "3.0.3",
- info: { title: "CronOps Web API", version: "1.0.0" },
+ info: {
+ title: "CronOps Web API",
+ version: "1.0.0",
+ description:
+ "REST API for CronOps - A lightweight, cron-based file management and system task scheduler for containerized environments. Automate file operations, execute commands, and manage scheduled jobs.",
+ contact: {
+ name: "CronOps",
+ url: "https://github.com/mtakla/cronops",
+ },
+ license: {
+ name: "ISC",
+ url: "https://github.com/mtakla/cronops/blob/main/LICENSE",
+ },
+ },
components: {
securitySchemes: {
ApiKeyBearer: {
@@ -13,23 +26,15 @@ export const openapi = {
tags: [
{
name: "public",
- description: "Public api",
+ description: "Public endpoints - Health check and API documentation",
},
{
name: "jobs",
- description: "CronOps job related tasks",
+ description: "Job management - Trigger, pause, and resume CronOps scheduled jobs",
},
{
name: "admin",
- description: "CronOps admin tasks",
- },
- {
- name: "user",
- description: "Operations about user",
- externalDocs: {
- description: "Find out more about our store",
- url: "http://swagger.io",
- },
+ description: "Administration endpoints - Manage CronOps service configuration and operations",
},
],
paths: {
diff --git a/src/api/webapi.ts b/src/api/webapi.ts
index 0cc1bdb..977df11 100644
--- a/src/api/webapi.ts
+++ b/src/api/webapi.ts
@@ -30,10 +30,27 @@ app.addHook("preHandler", async (request, reply) => {
app.get("/docs", async (_, reply) => {
reply.type("text/html").send(`
-
+
- CronOps API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CronOps API Documentation