Files
api.pawol.nu/api/teks/documentation/1.0.0/teks.json
T

1012 lines
25 KiB
JSON
Raw Normal View History

2021-01-05 02:03:39 +01:00
{
"paths": {
"/teks": {
"get": {
"deprecated": false,
"description": "Find all the teks's records",
"responses": {
"200": {
"description": "Retrieve teks document(s)",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Teks"
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"summary": "",
"tags": [
"Teks"
],
"parameters": [
{
"name": "_limit",
"in": "query",
"required": false,
"description": "Maximum number of results possible",
"schema": {
"type": "integer"
},
"deprecated": false
},
{
"name": "_sort",
"in": "query",
"required": false,
"description": "Sort according to a specific field.",
"schema": {
"type": "string"
},
"deprecated": false
},
{
"name": "_start",
"in": "query",
"required": false,
"description": "Skip a specific number of entries (especially useful for pagination)",
"schema": {
"type": "integer"
},
"deprecated": false
},
{
"name": "=",
"in": "query",
"required": false,
"description": "Get entries that matches exactly your input",
"schema": {
"type": "string"
},
"deprecated": false
},
{
"name": "_ne",
"in": "query",
"required": false,
"description": "Get records that are not equals to something",
"schema": {
"type": "string"
},
"deprecated": false
},
{
"name": "_lt",
"in": "query",
"required": false,
"description": "Get record that are lower than a value",
"schema": {
"type": "string"
},
"deprecated": false
},
{
"name": "_lte",
"in": "query",
"required": false,
"description": "Get records that are lower than or equal to a value",
"schema": {
"type": "string"
},
"deprecated": false
},
{
"name": "_gt",
"in": "query",
"required": false,
"description": "Get records that are greater than a value",
"schema": {
"type": "string"
},
"deprecated": false
},
{
"name": "_gte",
"in": "query",
"required": false,
"description": "Get records that are greater than or equal a value",
"schema": {
"type": "string"
},
"deprecated": false
},
{
"name": "_contains",
"in": "query",
"required": false,
"description": "Get records that contains a value",
"schema": {
"type": "string"
},
"deprecated": false
},
{
"name": "_containss",
"in": "query",
"required": false,
"description": "Get records that contains (case sensitive) a value",
"schema": {
"type": "string"
},
"deprecated": false
},
{
"name": "_in",
"in": "query",
"required": false,
"description": "Get records that matches any value in the array of values",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"deprecated": false
},
{
"name": "_nin",
"in": "query",
"required": false,
"description": "Get records that doesn't match any value in the array of values",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"deprecated": false
}
]
},
"post": {
"deprecated": false,
"description": "Create a new teks record",
"responses": {
"200": {
"description": "Retrieve teks document(s)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Teks"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"summary": "",
"tags": [
"Teks"
],
"requestBody": {
"description": "",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewTeks"
}
}
}
}
}
},
"/teks/count": {
"get": {
"deprecated": false,
2021-08-19 20:48:19 +02:00
"description": "Retrieve the number of teks documents",
2021-01-05 02:03:39 +01:00
"responses": {
"200": {
"description": "Retrieve teks document(s)",
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"summary": "",
"tags": [
"Teks"
],
"parameters": []
}
},
"/teks/{id}": {
"get": {
"deprecated": false,
"description": "Find one teks record",
"responses": {
"200": {
"description": "Retrieve teks document(s)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Teks"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"summary": "",
"tags": [
"Teks"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"deprecated": false,
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"deprecated": false,
"description": "Update a single teks record",
"responses": {
"200": {
"description": "Retrieve teks document(s)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Teks"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"summary": "",
"tags": [
"Teks"
],
"requestBody": {
"description": "",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewTeks"
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"deprecated": false,
"required": true,
"schema": {
"type": "string"
}
}
]
},
"delete": {
"deprecated": false,
"description": "Delete a single teks record",
"responses": {
"200": {
"description": "deletes a single teks based on the ID supplied",
"content": {
"application/json": {
"schema": {
"type": "integer",
"format": "int64"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"summary": "",
"tags": [
"Teks"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"deprecated": false,
"required": true,
"schema": {
"type": "string"
}
}
]
}
}
},
"components": {
"schemas": {
"Teks": {
"required": [
"id",
"tit",
"transkripsyon"
],
"properties": {
"id": {
"type": "string"
},
"tit": {
"type": "string"
},
"transkripsyon": {
"type": "string"
},
"tradiksyon": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"francais": {
"type": "string"
},
"english": {
"type": "string"
2021-05-26 23:38:45 +02:00
},
"espagnol": {
"type": "string"
2022-03-22 07:12:13 +04:00
},
"deutsch": {
"type": "string"
},
"italiano": {
"type": "string"
2021-01-05 02:03:39 +01:00
}
}
},
"lanne": {
"type": "integer"
},
"lyen": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"url",
"sit"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"sit": {
"type": "string",
"enum": [
"Youtube",
"Peertube",
"Dailymotion",
"Vimeo",
2021-02-22 22:29:56 +01:00
"File",
2021-04-29 20:09:58 +02:00
"Lbry",
"Rumble"
2021-01-05 02:03:39 +01:00
]
}
}
}
},
"awtis": {
"type": "array",
"items": {
"required": [
"id",
"alias"
],
"properties": {
"id": {
"type": "string"
},
"alias": {
"type": "string"
},
"prenon": {
"type": "string"
},
"non": {
"type": "string"
},
"biyografi": {
"type": "string"
},
"nesans": {
"type": "string"
},
"foto": {
"type": "array",
"items": {
"type": "string"
}
},
"teks": {
"type": "array",
"items": {
"type": "string"
}
},
2021-05-22 23:28:30 +02:00
"user": {
"type": "string"
},
2022-05-10 22:01:40 +04:00
"slug": {
"type": "string"
},
2021-01-05 02:03:39 +01:00
"published_at": {
"type": "string"
},
"created_by": {
"type": "string"
},
"updated_by": {
"type": "string"
}
}
}
},
"kouteyAchtey": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"url",
"boutik"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"boutik": {
"type": "string",
"enum": [
"Tidal",
"Spotify",
"Deezer",
"Qobuz",
"Youtubemusic",
"Applemusic",
2021-06-17 23:09:06 +02:00
"Amazon",
"Soundcloud"
2021-01-05 02:03:39 +01:00
]
}
}
}
},
"slug": {
"type": "string"
},
"kouveti": {
"required": [
"id",
"name",
"hash",
"mime",
"size",
"url",
"provider"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"alternativeText": {
"type": "string"
},
"caption": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"formats": {
"type": "object"
},
"hash": {
"type": "string"
},
"ext": {
"type": "string"
},
"mime": {
"type": "string"
},
"size": {
"type": "number"
},
"url": {
"type": "string"
},
"previewUrl": {
"type": "string"
},
"provider": {
"type": "string"
},
"provider_metadata": {
"type": "object"
},
"related": {
"type": "string"
},
"created_by": {
"type": "string"
},
"updated_by": {
"type": "string"
}
}
},
2021-01-10 21:47:17 +01:00
"okiMizikID": {
"type": "integer"
2021-01-10 18:34:31 +01:00
},
2021-05-22 23:28:30 +02:00
"user": {
"required": [
"id",
"username",
"email"
],
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"password": {
"type": "string"
},
"resetPasswordToken": {
"type": "string"
},
"confirmationToken": {
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"blocked": {
"type": "boolean"
},
"role": {
"type": "string"
},
2022-03-27 02:14:58 +04:00
"canAutoTranslate": {
"type": "boolean"
},
2021-05-22 23:28:30 +02:00
"created_by": {
"type": "string"
},
"updated_by": {
"type": "string"
}
}
},
2021-05-28 16:38:54 +02:00
"eksplisit": {
"type": "boolean"
},
2021-06-22 21:45:40 +02:00
"komante": {
"type": "array",
"items": {
"required": [
"id",
"kontni",
"sentAt"
],
"properties": {
"id": {
"type": "string"
},
"kontni": {
"type": "string"
},
"user": {
"type": "string"
},
"teks": {
"type": "string"
},
"sentAt": {
"type": "string"
},
"published_at": {
"type": "string"
},
"created_by": {
"type": "string"
},
"updated_by": {
"type": "string"
}
}
}
},
2022-03-23 09:08:25 +04:00
"forceSlug": {
"type": "boolean"
},
2022-03-27 02:14:58 +04:00
"tradiksyonOtomatik": {
"type": "boolean"
},
2022-05-08 05:23:09 +04:00
"userAdmin": {
"type": "string"
},
2021-01-05 02:03:39 +01:00
"published_at": {
"type": "string",
"format": "date-time"
}
}
},
"NewTeks": {
"required": [
"tit",
"transkripsyon"
],
"properties": {
"tit": {
"type": "string"
},
"transkripsyon": {
"type": "string"
},
"tradiksyon": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"francais": {
"type": "string"
},
"english": {
"type": "string"
2021-05-26 23:38:45 +02:00
},
"espagnol": {
"type": "string"
2022-03-22 07:12:13 +04:00
},
"deutsch": {
"type": "string"
},
"italiano": {
"type": "string"
2021-01-05 02:03:39 +01:00
}
}
},
"lanne": {
"type": "integer"
},
"lyen": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"url",
"sit"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"sit": {
"type": "string",
"enum": [
"Youtube",
"Peertube",
"Dailymotion",
"Vimeo",
2021-02-22 22:29:56 +01:00
"File",
2021-04-29 20:09:58 +02:00
"Lbry",
"Rumble"
2021-01-05 02:03:39 +01:00
]
}
}
}
},
"awtis": {
"type": "array",
"items": {
"type": "string"
}
},
"kouteyAchtey": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"url",
"boutik"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"boutik": {
"type": "string",
"enum": [
"Tidal",
"Spotify",
"Deezer",
"Qobuz",
"Youtubemusic",
"Applemusic",
2021-06-17 23:09:06 +02:00
"Amazon",
"Soundcloud"
2021-01-05 02:03:39 +01:00
]
}
}
}
},
"slug": {
"type": "string"
},
2021-01-10 21:47:17 +01:00
"okiMizikID": {
"type": "integer"
2021-01-10 18:34:31 +01:00
},
2021-05-22 23:28:30 +02:00
"user": {
"type": "string"
},
2021-05-28 16:38:54 +02:00
"eksplisit": {
"type": "boolean"
},
2021-06-22 21:45:40 +02:00
"komante": {
"type": "array",
"items": {
"type": "string"
}
},
2022-03-23 09:08:25 +04:00
"forceSlug": {
"type": "boolean"
},
2022-03-27 02:14:58 +04:00
"tradiksyonOtomatik": {
"type": "boolean"
},
2022-05-08 05:23:09 +04:00
"userAdmin": {
"type": "string"
},
2021-01-05 02:03:39 +01:00
"published_at": {
"type": "string",
"format": "date-time"
},
"created_by": {
"type": "string"
},
"updated_by": {
"type": "string"
}
}
}
}
},
"tags": [
{
"name": "Teks"
}
]
}