Skip to content

Commit 3e86b72

Browse files
rishikanthcrishikanthc
committed
docs: fix api docs generation, navigation, and content inaccuracies
1 parent 77ddb29 commit 3e86b72

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+1490
-342
lines changed

‎api-docs/docs.go‎

Lines changed: 125 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1932,22 +1932,56 @@ const docTemplate = `{
19321932
"/api/v1/transcription/list": {
19331933
"get": {
19341934
"security": [
1935+
{
1936+
"ApiKeyAuth": []
1937+
},
1938+
{
1939+
"BearerAuth": []
1940+
},
19351941
{
19361942
"ApiKeyAuth": []
19371943
},
19381944
{
19391945
"BearerAuth": []
19401946
}
19411947
],
1942-
"description": "Get a list of all transcription jobs with optional search and filtering",
1948+
"description": "Get a list of all transcription jobs with optional search and filtering\nGet a list of all transcription jobs with optional search and filtering",
19431949
"produces": [
1950+
"application/json",
19441951
"application/json"
19451952
],
19461953
"tags": [
1954+
"transcription",
19471955
"transcription"
19481956
],
19491957
"summary": "List all transcription records",
19501958
"parameters": [
1959+
{
1960+
"type": "integer",
1961+
"default": 1,
1962+
"description": "Page number",
1963+
"name": "page",
1964+
"in": "query"
1965+
},
1966+
{
1967+
"type": "integer",
1968+
"default": 10,
1969+
"description": "Items per page",
1970+
"name": "limit",
1971+
"in": "query"
1972+
},
1973+
{
1974+
"type": "string",
1975+
"description": "Filter by status",
1976+
"name": "status",
1977+
"in": "query"
1978+
},
1979+
{
1980+
"type": "string",
1981+
"description": "Search in title and audio filename",
1982+
"name": "q",
1983+
"in": "query"
1984+
},
19511985
{
19521986
"type": "integer",
19531987
"default": 1,
@@ -2341,7 +2375,7 @@ const docTemplate = `{
23412375
"BearerAuth": []
23422376
}
23432377
],
2344-
"description": "Upload multiple audio files with an .aup file for multi-track transcription",
2378+
"description": "Upload multiple audio files for multi-track transcription",
23452379
"consumes": [
23462380
"multipart/form-data"
23472381
],
@@ -2355,22 +2389,14 @@ const docTemplate = `{
23552389
"parameters": [
23562390
{
23572391
"type": "string",
2358-
"description": "Job title (required)",
2392+
"description": "Job title",
23592393
"name": "title",
2360-
"in": "formData",
2361-
"required": true
2362-
},
2363-
{
2364-
"type": "file",
2365-
"description": ".aup Audacity project file",
2366-
"name": "aup",
2367-
"in": "formData",
2368-
"required": true
2394+
"in": "formData"
23692395
},
23702396
{
23712397
"type": "file",
23722398
"description": "Audio track files",
2373-
"name": "tracks",
2399+
"name": "files",
23742400
"in": "formData",
23752401
"required": true
23762402
}
@@ -2533,21 +2559,18 @@ const docTemplate = `{
25332559
{
25342560
"ApiKeyAuth": []
25352561
},
2536-
{
2537-
"BearerAuth": []
2538-
},
25392562
{
25402563
"BearerAuth": []
25412564
}
25422565
],
2543-
"description": "Get a specific transcription record by its ID",
2566+
"description": "Get details of a specific transcription job",
25442567
"produces": [
25452568
"application/json"
25462569
],
25472570
"tags": [
25482571
"transcription"
25492572
],
2550-
"summary": "Get transcription record by ID",
2573+
"summary": "Get transcription job details",
25512574
"parameters": [
25522575
{
25532576
"type": "string",
@@ -2577,22 +2600,37 @@ const docTemplate = `{
25772600
},
25782601
"delete": {
25792602
"security": [
2603+
{
2604+
"ApiKeyAuth": []
2605+
},
2606+
{
2607+
"BearerAuth": []
2608+
},
25802609
{
25812610
"ApiKeyAuth": []
25822611
},
25832612
{
25842613
"BearerAuth": []
25852614
}
25862615
],
2587-
"description": "Delete a transcription job and its associated files",
2616+
"description": "Delete a transcription job and its associated files\nDelete a transcription job and its associated files",
25882617
"produces": [
2618+
"application/json",
25892619
"application/json"
25902620
],
25912621
"tags": [
2622+
"transcription",
25922623
"transcription"
25932624
],
25942625
"summary": "Delete transcription job",
25952626
"parameters": [
2627+
{
2628+
"type": "string",
2629+
"description": "Job ID",
2630+
"name": "id",
2631+
"in": "path",
2632+
"required": true
2633+
},
25962634
{
25972635
"type": "string",
25982636
"description": "Job ID",
@@ -2962,9 +3000,6 @@ const docTemplate = `{
29623000
}
29633001
],
29643002
"description": "Retrieves all custom speaker names for a transcription job",
2965-
"consumes": [
2966-
"application/json"
2967-
],
29683003
"produces": [
29693004
"application/json"
29703005
],
@@ -3281,6 +3316,9 @@ const docTemplate = `{
32813316
{
32823317
"ApiKeyAuth": []
32833318
},
3319+
{
3320+
"BearerAuth": []
3321+
},
32843322
{
32853323
"BearerAuth": []
32863324
}
@@ -3670,6 +3708,47 @@ const docTemplate = `{
36703708
}
36713709
}
36723710
}
3711+
},
3712+
"/transcription/{id}/logs": {
3713+
"get": {
3714+
"description": "Get the raw transcription logs for a job",
3715+
"produces": [
3716+
"text/plain"
3717+
],
3718+
"tags": [
3719+
"transcription"
3720+
],
3721+
"summary": "Get transcription logs",
3722+
"parameters": [
3723+
{
3724+
"type": "string",
3725+
"description": "Job ID",
3726+
"name": "id",
3727+
"in": "path",
3728+
"required": true
3729+
}
3730+
],
3731+
"responses": {
3732+
"200": {
3733+
"description": "Log content",
3734+
"schema": {
3735+
"type": "string"
3736+
}
3737+
},
3738+
"404": {
3739+
"description": "Not Found",
3740+
"schema": {
3741+
"$ref": "#/definitions/api.ErrorResponse"
3742+
}
3743+
},
3744+
"500": {
3745+
"description": "Internal Server Error",
3746+
"schema": {
3747+
"$ref": "#/definitions/api.ErrorResponse"
3748+
}
3749+
}
3750+
}
3751+
}
36733752
}
36743753
},
36753754
"definitions": {
@@ -3922,6 +4001,14 @@ const docTemplate = `{
39224001
}
39234002
}
39244003
},
4004+
"api.ErrorResponse": {
4005+
"type": "object",
4006+
"properties": {
4007+
"error": {
4008+
"type": "string"
4009+
}
4010+
}
4011+
},
39254012
"api.LLMConfigRequest": {
39264013
"type": "object",
39274014
"required": [
@@ -4347,6 +4434,14 @@ const docTemplate = `{
43474434
"description": "Indexed selection into transcript by word positions",
43484435
"type": "integer"
43494436
},
4437+
"transcription": {
4438+
"description": "Relationships",
4439+
"allOf": [
4440+
{
4441+
"$ref": "#/definitions/models.TranscriptionJob"
4442+
}
4443+
]
4444+
},
43504445
"transcription_id": {
43514446
"type": "string"
43524447
},
@@ -4373,6 +4468,14 @@ const docTemplate = `{
43734468
"template_id": {
43744469
"type": "string"
43754470
},
4471+
"transcription": {
4472+
"description": "Relationships",
4473+
"allOf": [
4474+
{
4475+
"$ref": "#/definitions/models.TranscriptionJob"
4476+
}
4477+
]
4478+
},
43764479
"transcription_id": {
43774480
"type": "string"
43784481
},

0 commit comments

Comments
 (0)