wilson/language-learning-app
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: remove API docs

Browse source
This commit is contained in:
wilson 2026-03-27 09:50:19 +00:00
parent 73594692e3
commit 5f917f5e6d
15 changed files with 2 additions and 506 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored
View file

@ -1,2 +1,4 @@
todo.md todo.md
.env .env
Language*Learning*API/

31
Language Learning API/Health.yml
View file

@ -1,31 +0,0 @@
info:
name: Health
type: http
seq: 1
http:
method: GET
url: "{{baseUrl}}/health"
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful Response
request:
url: "{{baseUrl}}/health"
method: GET
response:
status: 200
statusText: OK
headers:
- name: Content-Type
value: application/json
body:
type: json
data: "{}"

99
Language Learning API/analysis/Analyze Pos.yml
View file

@ -1,99 +0,0 @@
info:
name: Analyze Pos
type: http
seq: 1
tags:
- analysis
http:
method: POST
url: "{{baseUrl}}/analyze/pos"
body:
type: json
data: |-
{
"text": "This is a test",
"language": "en"
}
auth:
type: bearer
token: "{{token}}"
runtime:
variables:
- name: baseUrl
value: http://localhost:8000
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful Response
request:
url: "{{baseUrl}}/analyze/pos"
method: POST
body:
type: json
data: |-
{
"text": "",
"language": ""
}
response:
status: 200
statusText: OK
headers:
- name: Content-Type
value: application/json
body:
type: json
data: |-
{
"language": "",
"tokens": [
{
"text": "",
"lemma": "",
"pos": "",
"tag": "",
"dep": "",
"is_stop": false
}
]
}
- name: 422 Response
description: Validation Error
request:
url: "{{baseUrl}}/analyze/pos"
method: POST
body:
type: json
data: |-
{
"text": "",
"language": ""
}
response:
status: 422
statusText: Unprocessable Entity
headers:
- name: Content-Type
value: application/json
body:
type: json
data: |-
{
"detail": [
{
"loc": [],
"msg": "",
"type": "",
"input": "",
"ctx": {}
}
]
}

7
Language Learning API/analysis/folder.yml
View file

@ -1,7 +0,0 @@
info:
name: analysis
type: folder
seq: 1
request:
auth: inherit

19
Language Learning API/audio/Get audio.yml
View file

@ -1,19 +0,0 @@
info:
name: Get audio
type: http
seq: 1
http:
method: GET
url: audio/:file_name
params:
- name: file_name
value: ""
type: path
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5

7
Language Learning API/audio/folder.yml
View file

@ -1,7 +0,0 @@
info:
name: audio
type: folder
seq: 6
request:
auth: inherit

22
Language Learning API/auth/Login.yml
View file

@ -1,22 +0,0 @@
info:
name: Login
type: http
seq: 2
http:
method: POST
url: "{{baseUrl}}/auth/register"
body:
type: json
data: |-
{
"email": "wilson@thomaswilson.xyz",
"password": "wilson@thomaswilson.xyz"
}
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5

15
Language Learning API/auth/Register.yml
View file

@ -1,15 +0,0 @@
info:
name: Register
type: http
seq: 1
http:
method: POST
url: ""
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5

7
Language Learning API/auth/folder.yml
View file

@ -1,7 +0,0 @@
info:
name: auth
type: folder
seq: 5
request:
auth: inherit

90
Language Learning API/generation/Create Generation Job.yml
View file

@ -1,90 +0,0 @@
info:
name: Create Generation Job
type: http
seq: 1
tags:
- generation
http:
method: POST
url: "{{baseUrl}}/generate"
body:
type: json
data: |-
{
"target_language": "",
"complexity_level": "",
"input_texts": [],
"topic": ""
}
auth:
type: bearer
token: "{{token}}"
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 202 Response
description: Successful Response
request:
url: "{{baseUrl}}/generate"
method: POST
body:
type: json
data: |-
{
"target_language": "",
"complexity_level": "",
"input_texts": [],
"topic": ""
}
response:
status: 202
statusText: Accepted
headers:
- name: Content-Type
value: application/json
body:
type: json
data: |-
{
"job_id": ""
}
- name: 422 Response
description: Validation Error
request:
url: "{{baseUrl}}/generate"
method: POST
body:
type: json
data: |-
{
"target_language": "",
"complexity_level": "",
"input_texts": [],
"topic": ""
}
response:
status: 422
statusText: Unprocessable Entity
headers:
- name: Content-Type
value: application/json
body:
type: json
data: |-
{
"detail": [
{
"loc": [],
"msg": "",
"type": "",
"input": "",
"ctx": {}
}
]
}

7
Language Learning API/generation/folder.yml
View file

@ -1,7 +0,0 @@
info:
name: generation
type: folder
seq: 1
request:
auth: inherit

82
Language Learning API/jobs/Get Job.yml
View file

@ -1,82 +0,0 @@
info:
name: Get Job
type: http
seq: 1
tags:
- jobs
http:
method: GET
url: "{{baseUrl}}/jobs/:job_id"
params:
- name: job_id
value: ""
type: path
auth:
type: bearer
token: "{{token}}"
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful Response
request:
url: "{{baseUrl}}/jobs/:job_id"
method: GET
params:
- name: job_id
value: ""
type: path
response:
status: 200
statusText: OK
headers:
- name: Content-Type
value: application/json
body:
type: json
data: |-
{
"id": "",
"status": "",
"target_language": "",
"complexity_level": "",
"created_at": "",
"generated_text": "",
"input_summary": "",
"error_message": ""
}
- name: 422 Response
description: Validation Error
request:
url: "{{baseUrl}}/jobs/:job_id"
method: GET
params:
- name: job_id
value: ""
type: path
response:
status: 422
statusText: Unprocessable Entity
headers:
- name: Content-Type
value: application/json
body:
type: json
data: |-
{
"detail": [
{
"loc": [],
"msg": "",
"type": "",
"input": "",
"ctx": {}
}
]
}

82
Language Learning API/jobs/Get jobs.yml
View file

@ -1,82 +0,0 @@
info:
name: Get jobs
type: http
seq: 2
tags:
- jobs
http:
method: GET
url: "{{baseUrl}}/jobs/:job_id"
params:
- name: job_id
value: d2130df6-cab2-4407-b35b-45e90dca8555
type: path
auth:
type: bearer
token: "{{token}}"
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
examples:
- name: 200 Response
description: Successful Response
request:
url: "{{baseUrl}}/jobs/:job_id"
method: GET
params:
- name: job_id
value: ""
type: path
response:
status: 200
statusText: OK
headers:
- name: Content-Type
value: application/json
body:
type: json
data: |-
{
"id": "",
"status": "",
"target_language": "",
"complexity_level": "",
"created_at": "",
"generated_text": "",
"input_summary": "",
"error_message": ""
}
- name: 422 Response
description: Validation Error
request:
url: "{{baseUrl}}/jobs/:job_id"
method: GET
params:
- name: job_id
value: ""
type: path
response:
status: 422
statusText: Unprocessable Entity
headers:
- name: Content-Type
value: application/json
body:
type: json
data: |-
{
"detail": [
{
"loc": [],
"msg": "",
"type": "",
"input": "",
"ctx": {}
}
]
}

7
Language Learning API/jobs/folder.yml
View file

@ -1,7 +0,0 @@
info:
name: jobs
type: folder
seq: 1
request:
auth: inherit

31
Language Learning API/opencollection.yml
View file

@ -1,31 +0,0 @@
opencollection: 1.0.0
info:
name: Language Learning API
config:
proxy:
inherit: true
config:
protocol: http
hostname: ""
port: ""
auth:
username: ""
password: ""
bypassProxy: ""
request:
auth:
type: bearer
token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkNDIzODc1NC05ZDljLTRkOWMtYTM1OS1lMGQ4MDZhOGQ1Y2QiLCJlbWFpbCI6IndpbHNvbkB0aG9tYXN3aWxzb24ueHl6IiwiZXhwIjoxNzczOTkzNDcxfQ.J5SH93js-YrJThxGliOKIOV8kbdfP1qUu0rx3iBNX0A
variables:
- name: baseUrl
value: http://localhost:8000
- name: token
value: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkNDIzODc1NC05ZDljLTRkOWMtYTM1OS1lMGQ4MDZhOGQ1Y2QiLCJlbWFpbCI6IndpbHNvbkB0aG9tYXN3aWxzb24ueHl6IiwiZXhwIjoxNzczOTkzNDcxfQ.J5SH93js-YrJThxGliOKIOV8kbdfP1qUu0rx3iBNX0A
bundled: false
extensions:
bruno:
ignore:
- node_modules
- .git