Skip to content

Commit a8a7f6c

Browse files
Tweaks to swagger YAML
1 parent 6031b2e commit a8a7f6c

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

swagger.yml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@ openapi: 3.0.0
22
info:
33
title: CyberChef API
44
description: A HTTP API that exposes some of CyberChef's functionality.
5-
version: 0.0.10
5+
version: 1.1.0
66

77

88
paths:
99
/health:
1010
get:
1111
summary: Server healthcheck
12+
tags:
13+
- Health
1214
description: >
1315
If the server is up, returns a 200 response and some basic info about uptime
1416
@@ -37,6 +39,8 @@ paths:
3739
/bake:
3840
post:
3941
summary: Bakes a recipe
42+
tags:
43+
- Single Operations
4044
description: >
4145
Bake a recipe defined in JSON. For an example JSON recipe, build a recipe on
4246
[CyberChef](https://gchq.github.io/CyberChef/) and click save. Select "clean JSON".
@@ -78,6 +82,8 @@ paths:
7882
/magic:
7983
post:
8084
summary: Performs magic on some input
85+
tags:
86+
- Single Operations
8187
description: >
8288
Take some input data and optional arguments for the [Magic operation](https://github.com/gchq/CyberChef/wiki/Automatic-detection-of-encoded-data-using-CyberChef-Magic) and return JSON of results of automatic encoding detection of the inputted data.
8389
@@ -125,6 +131,8 @@ paths:
125131
/batch/bake:
126132
post:
127133
summary: Bakes a batch of data with a recipe
134+
tags:
135+
- Batch Operations
128136
description: >
129137
Bake a recipe defined in JSON over an array of input data. To obtain a JSON-formatted recipe, build a recipe on
130138
[CyberChef](https://gchq.github.io/CyberChef/) and click save. Select "clean JSON" and copy the output.
@@ -219,7 +227,8 @@ components:
219227
type: object
220228
properties:
221229
input:
222-
type: string
230+
type: array
231+
items: string
223232
example: "input for recipe"
224233
recipe:
225234
type: array

0 commit comments

Comments
 (0)