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

721 lines
18 KiB
JSON
Raw Normal View History

2021-01-05 02:03:39 +01:00
{
"paths": {
"/awtis": {
"get": {
"deprecated": false,
"description": "Find all the awtis's records",
"responses": {
"200": {
"description": "Retrieve awtis document(s)",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Awtis"
}
}
}
}
},
"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": [
"Awtis"
],
"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 awtis record",
"responses": {
"200": {
"description": "Retrieve awtis document(s)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Awtis"
}
}
}
},
"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": [
"Awtis"
],
"requestBody": {
"description": "",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewAwtis"
}
}
}
}
}
},
"/awtis/count": {
"get": {
"deprecated": false,
"description": "Retrieve the numver of awtis documents",
"responses": {
"200": {
"description": "Retrieve awtis 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": [
"Awtis"
],
"parameters": []
}
},
"/awtis/{id}": {
"get": {
"deprecated": false,
"description": "Find one awtis record",
"responses": {
"200": {
"description": "Retrieve awtis document(s)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Awtis"
}
}
}
},
"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": [
"Awtis"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"deprecated": false,
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"deprecated": false,
"description": "Update a single awtis record",
"responses": {
"200": {
"description": "Retrieve awtis document(s)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Awtis"
}
}
}
},
"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": [
"Awtis"
],
"requestBody": {
"description": "",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewAwtis"
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"deprecated": false,
"required": true,
"schema": {
"type": "string"
}
}
]
},
"delete": {
"deprecated": false,
"description": "Delete a single awtis record",
"responses": {
"200": {
"description": "deletes a single awtis 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": [
"Awtis"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"deprecated": false,
"required": true,
"schema": {
"type": "string"
}
}
]
}
}
},
"components": {
"schemas": {
"Awtis": {
"required": [
"id",
"alias"
],
"properties": {
"id": {
"type": "string"
},
"alias": {
"type": "string"
},
"prenon": {
"type": "string"
},
"non": {
"type": "string"
},
"biyografi": {
"type": "string"
},
"nesans": {
"type": "string",
"format": "date"
},
"foto": {
"type": "array",
"items": {
"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"
}
}
}
},
"teks": {
"type": "array",
"items": {
"required": [
"id",
"tit",
"transkripsyon"
],
"properties": {
"id": {
"type": "string"
},
"tit": {
"type": "string"
},
"transkripsyon": {
"type": "string"
},
"tradiksyon": {
"type": "component"
},
"lanne": {
"type": "integer"
},
"lyen": {
"type": "component"
},
"awtis": {
"type": "array",
"items": {
"type": "string"
}
},
"kouteyAchtey": {
"type": "component"
},
"slug": {
"type": "string"
},
"kouveti": {
"type": "string"
},
2021-01-10 18:34:31 +01:00
"okiMizik": {
"type": "string"
},
2021-01-05 02:03:39 +01:00
"published_at": {
"type": "string"
},
"created_by": {
"type": "string"
},
"updated_by": {
"type": "string"
}
}
}
},
"published_at": {
"type": "string",
"format": "date-time"
}
}
},
"NewAwtis": {
"required": [
"alias"
],
"properties": {
"alias": {
"type": "string"
},
"prenon": {
"type": "string"
},
"non": {
"type": "string"
},
"biyografi": {
"type": "string"
},
"nesans": {
"type": "string",
"format": "date"
},
"teks": {
"type": "array",
"items": {
"type": "string"
}
},
"published_at": {
"type": "string",
"format": "date-time"
},
"created_by": {
"type": "string"
},
"updated_by": {
"type": "string"
}
}
}
}
},
"tags": [
{
"name": "Awtis"
}
]
}