@snokam/mcp-api 0.131.3 → 0.133.0

package/specs/test/sanity.json

@@ -3537,8 +3537,7 @@
           "description": {
             "items": {},
             "type": "array",
-            "nullable": true,
-            "description": "Portable Text notes/instructions attached to this task."
+            "nullable": true
           },
           "reminderWeeksBefore": {
             "type": "number",
@@ -3566,7 +3565,6 @@
         "additionalProperties": true
       },
       "SanityCreateTask": {
-        "description": "Shape used to create a new task. `description` is Portable Text — callers\nin the admin typically pass a simple single-block paragraph.",
         "properties": {
           "title": {
             "type": "string"
@@ -3601,7 +3599,6 @@
         "additionalProperties": true
       },
       "SanityPatchTask": {
-        "description": "Partial update. Any field omitted is left unchanged.",
         "properties": {
           "title": {
             "type": "string"
@@ -4115,7 +4112,6 @@
         "type": "array"
       },
       "SanityCreateSystem": {
-        "description": "Shape used to create a new system. Links are plain URL strings;\ndescription is Portable Text (the schema stores it as a block array).",
         "properties": {
           "title": {
             "type": "string"
@@ -4140,7 +4136,6 @@
         "additionalProperties": true
       },
       "SanityPatchSystem": {
-        "description": "Partial update. Any omitted field is left unchanged.",
         "properties": {
           "title": {
             "type": "string"
@@ -4194,7 +4189,6 @@
         "additionalProperties": true
       },
       "SubscriptionListItem": {
-        "description": "Explicit type for the subscriptions API so tsoa can resolve it for OpenAPI.\nShape matches GetAllSubscriptionsQueryResult[number] from generated/sanity.types.",
         "properties": {
           "sanityId": {
             "type": "string"
@@ -34147,12 +34141,10 @@
             "type": "string"
           },
           "recruiter": {
-            "type": "string",
-            "description": "Sanity id of the employee to set as recruiter on the new candidate."
+            "type": "string"
           },
           "jobPositionId": {
-            "type": "string",
-            "description": "Sanity id of the job position the candidate is being created for.\nOptional for admin-created candidates that aren't tied to a posting;\npublic applications go through PostJobApplication where it's required."
+            "type": "string"
           }
         },
         "required": [
@@ -34201,8 +34193,7 @@
       "JobApplicationFormData": {
         "properties": {
           "jobPositionId": {
-            "type": "string",
-            "description": "Sanity id of the job position the candidate applied to. Used to set\nthe `candidate.jobPosition` reference and denormalize the position's\ntrack onto the candidate."
+            "type": "string"
           },
           "other": {
             "type": "string"
@@ -34266,18 +34257,15 @@
           },
           "assetCount": {
             "type": "number",
-            "format": "double",
-            "description": "Number of asset binaries downloaded. 0 when `includeAssets` is false."
+            "format": "double"
           },
           "assetBytes": {
             "type": "number",
-            "format": "double",
-            "description": "Total bytes across asset binaries. 0 when `includeAssets` is false."
+            "format": "double"
           },
           "assetFailures": {
             "type": "number",
-            "format": "double",
-            "description": "Number of asset downloads that failed and were skipped."
+            "format": "double"
           }
         },
         "required": [
@@ -38074,12 +38062,10 @@
         "additionalProperties": true
       },
       "GetArticleWithDraftResult": {
-        "description": "Snapshot combining the published version and any in-progress\ndraft. Used by the editor UI so authors can see both states and\ndecide when to promote.",
         "properties": {
           "publishedId": {
             "type": "string",
-            "nullable": true,
-            "description": "Canonical published id (no `drafts.` prefix). `null` when the\narticle only exists as a draft (freshly created)."
+            "nullable": true
           },
           "published": {
             "allOf": [
@@ -38087,8 +38073,7 @@
                 "$ref": "#/components/schemas/GetArticlesBySlugOrIdResult"
               }
             ],
-            "nullable": true,
-            "description": "Published article, renamed-field form. `null` if never published."
+            "nullable": true
           },
           "draft": {
             "allOf": [
@@ -38096,8 +38081,7 @@
                 "$ref": "#/components/schemas/GetArticlesBySlugOrIdResult"
               }
             ],
-            "nullable": true,
-            "description": "Draft article (from `drafts.<id>`), renamed-field form. `null`\nwhen the article has no pending draft."
+            "nullable": true
           },
           "hasPublished": {
             "type": "boolean"
@@ -47559,7 +47543,6 @@
             }
           }
         },
-        "description": "Returns onboarding tasks that have a reminder configured (remindDaysBefore is set).\nUsed by the notifications function to send reminders ahead of a candidate's start date.",
         "tags": [
           "Tasks"
         ],
@@ -47610,7 +47593,6 @@
             }
           }
         },
-        "description": "Returns every task of the given type (onboarding or offboarding)\nwith its Portable Text description so the admin panel can render\nthe checklist with contextual notes.",
         "tags": [
           "Tasks"
         ],
@@ -47675,7 +47657,6 @@
             }
           }
         },
-        "description": "Fetch a single task by id.",
         "tags": [
           "Tasks"
         ],
@@ -47734,7 +47715,6 @@
             }
           }
         },
-        "description": "Patch a task. Any omitted field is left unchanged. Pass `null`\nto explicitly clear an optional field (e.g. drop a reminder).",
         "tags": [
           "Tasks"
         ],
@@ -47785,7 +47765,6 @@
             }
           }
         },
-        "description": "Delete a task. Returns the deleted document so callers can\nupdate their local cache before the next refetch.",
         "tags": [
           "Tasks"
         ],
@@ -47828,7 +47807,6 @@
             }
           }
         },
-        "description": "Create a new onboarding or offboarding task.",
         "tags": [
           "Tasks"
         ],
@@ -48017,7 +47995,6 @@
             }
           }
         },
-        "description": "Create a new system.",
         "tags": [
           "Systems"
         ],
@@ -48109,7 +48086,6 @@
             }
           }
         },
-        "description": "Patch a system. Any omitted field is left unchanged.",
         "tags": [
           "Systems"
         ],
@@ -48155,7 +48131,6 @@
             }
           }
         },
-        "description": "Delete a system by id. Returns the deleted document so callers\ncan update their local cache before the next refetch.",
         "tags": [
           "Systems"
         ],
@@ -49813,7 +49788,6 @@
             }
           }
         },
-        "description": "Create a page and add it to the specified app's pages array in one operation.",
         "tags": [
           "Pages"
         ],
@@ -50017,7 +49991,6 @@
             }
           }
         },
-        "description": "Pass the Sanity asset reference ID (image-xxxx).",
         "tags": [
           "Pages"
         ],
@@ -55015,6 +54988,46 @@
           }
         ]
       },
+      "delete": {
+        "operationId": "DeleteCandidate",
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "allOf": [
+                    {
+                      "$ref": "#/components/schemas/SanityCandidate"
+                    }
+                  ],
+                  "nullable": true
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Candidates"
+        ],
+        "security": [
+          {
+            "Implicit": [
+              "WILL BE REPLACED"
+            ]
+          }
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ]
+      },
       "patch": {
         "operationId": "PatchCandidate",
         "responses": {
@@ -55079,7 +55092,6 @@
             }
           }
         },
-        "description": "Returns all ONBOARDING candidates with a startDate set,\nincluding their onboarding checklist tasks and systems with remindDaysBefore values.\nUsed by the notifications function to send per-candidate reminders.",
         "tags": [
           "Candidates"
         ],
@@ -55186,7 +55198,6 @@
             }
           }
         },
-        "description": "Stream the Sanity dataset export (NDJSON) into a gzipped blob in\nAzure Blob Storage. With `includeAssets: true` also downloads each\nreferenced image/file binary into `<prefix>/assets/`. Returns\nmetadata about the resulting blobs.",
         "tags": [
           "Backups"
         ],
@@ -55261,7 +55272,6 @@
             }
           }
         },
-        "description": "Returns the published article list.\n\n`includeInactive=true` drops the `active == true` filter so\nadmins can see articles they've taken offline (\"Ikke live\").\nCallers decide whether to request it based on the viewer's\nsession — the public blog route leaves it false, admin routes\npass true.",
         "tags": [
           "Articles"
         ],
@@ -55353,7 +55363,6 @@
             }
           }
         },
-        "description": "Single published article by slug or id.\n\n`includeInactive=true` removes the `active == true` requirement\nfrom the slug-match path so admins can open \"Ikke live\"\narticles by URL. Without it, slug lookups only return live\narticles (public behaviour). Id lookups are unaffected either\nway — if the caller already knows the sanity id, active is\nimmaterial.",
         "tags": [
           "Articles"
         ],
@@ -55463,7 +55472,6 @@
             }
           }
         },
-        "description": "Every published article regardless of the `active` flag. Used by\nthe admin list so editors can see articles they've taken offline\n(\"Ikke live\"). Public callers should stay on `GetArticles`,\nwhich filters to `active == true`.",
         "tags": [
           "Articles"
         ],
@@ -55511,7 +55519,6 @@
             }
           }
         },
-        "description": "Drafts with no published counterpart. Used by the admin list so\nauthors can resume unfinished articles. Same projection as\n`GetArticles`, so the list UI can render both uniformly and only\ntag the draft rows with an \"Utkast\" badge.\n\nDedup is done here (not in GROQ): strip the 7-char `drafts.`\nprefix from each draft's _id and filter out any that have a\nmatching document in the published set.",
         "tags": [
           "Articles"
         ],
@@ -55557,7 +55564,6 @@
             }
           }
         },
-        "description": "Create a brand-new article as a draft. Returns the created\ndraft document (its `sanityId` carries the `drafts.` prefix).\nAuthors use this from the \"New article\" flow so nothing goes\nlive until they press publish.",
         "tags": [
           "Articles"
         ],
@@ -55651,7 +55657,6 @@
             }
           }
         },
-        "description": "Read both states at once. Returns all `null`s if neither exists.\nAccepts a published id or a slug; draft lookup is by id, so we\nresolve slug→id via the published GROQ query first. Brand-new\ndrafts (no published counterpart) can be fetched by passing the\nbare `drafts.<id>` form or the plain `<id>` half — the handler\ntries both.",
         "tags": [
           "Articles"
         ],
@@ -55689,7 +55694,6 @@
             }
           }
         },
-        "description": "Write an edit to the draft for `slugOrId`. If no draft exists\nwe clone the published document first, so partial patches\npreserve existing content. `slugOrId` must resolve to a document\nid — callers coming in via slug should go through blog-function\n(which resolves with GetArticleWithDraft before calling this)\nso the authZ check and slug→id resolution happen together.",
         "tags": [
           "Articles"
         ],
@@ -55740,7 +55744,6 @@
             }
           }
         },
-        "description": "Delete the draft for `slugOrId` without touching the published\ndocument. Returns the now-current published document (the draft\nhaving been thrown away) or `null` if there was no published\ncopy either.",
         "tags": [
           "Articles"
         ],
@@ -55778,7 +55781,6 @@
             }
           }
         },
-        "description": "Promote the draft for `slugOrId` to published. Overwrites the\npublished document with the draft's content and deletes the\ndraft. Returns the newly-published document.",
         "tags": [
           "Articles"
         ],
@@ -56002,7 +56004,6 @@
             }
           }
         },
-        "description": "Add an existing page (by its Sanity ID) to this app's pages array.",
         "tags": [
           "Apps"
         ],
@@ -56046,7 +56047,6 @@
             }
           }
         },
-        "description": "Remove a page reference from this app's pages array.",
         "tags": [
           "Apps"
         ],
@@ -56257,7 +56257,6 @@
             }
           }
         },
-        "description": "Pass the Sanity asset reference ID (image-xxxx).",
         "tags": [
           "Apps"
         ],
@@ -56626,7 +56625,6 @@
             }
           }
         },
-        "description": "Create a new Annual Wheel document.",
         "tags": [
           "Annual wheels"
         ],
@@ -56718,7 +56716,6 @@
             }
           }
         },
-        "description": "Update top-level fields on an Annual Wheel. Any omitted field is left unchanged.",
         "tags": [
           "Annual wheels"
         ],
@@ -56774,7 +56771,6 @@
             }
           }
         },
-        "description": "Add a new event to an Annual Wheel's `events` array.\nReturns the `_key` of the newly created event.\nEvent `time` format: `<day>.<month>`, e.g. `\"1.8\"` for August 1.",
         "tags": [
           "Annual wheels"
         ],
@@ -56822,7 +56818,6 @@
             }
           }
         },
-        "description": "Update an existing event inside an Annual Wheel.\n`eventKey` is the `_key` of the event (returned when it was created).\nAny omitted field is left unchanged.",
         "tags": [
           "Annual wheels"
         ],
@@ -56876,7 +56871,6 @@
             }
           }
         },
-        "description": "Remove an event from an Annual Wheel.\n`eventKey` is the `_key` of the event to remove.",
         "tags": [
           "Annual wheels"
         ],