diff --git a/api/awtis/documentation/1.0.0/awtis.json b/api/awtis/documentation/1.0.0/awtis.json new file mode 100644 index 0000000..0ec28e2 --- /dev/null +++ b/api/awtis/documentation/1.0.0/awtis.json @@ -0,0 +1,718 @@ +{ + "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" + }, + "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" + } + ] +} \ No newline at end of file diff --git a/api/awtis/documentation/1.0.0/overrides/awtis.json b/api/awtis/documentation/1.0.0/overrides/awtis.json new file mode 100644 index 0000000..9414bc7 --- /dev/null +++ b/api/awtis/documentation/1.0.0/overrides/awtis.json @@ -0,0 +1,20 @@ +{ + "paths": { + "/awtis": { + "get": { + "parameters": [] + }, + "post": { + "deprecated": true + } + }, + "/awtis/{id}" : { + "put": { + "deprecated": true + }, + "delete": { + "deprecated": true + } + } + } +} diff --git a/api/slugs/documentation/1.0.0/slugs.json b/api/slugs/documentation/1.0.0/slugs.json new file mode 100644 index 0000000..17959f1 --- /dev/null +++ b/api/slugs/documentation/1.0.0/slugs.json @@ -0,0 +1,66 @@ +{ + "paths": { + "/slugs": { + "get": { + "deprecated": false, + "description": "", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "foo": { + "type": "string" + } + } + } + } + } + }, + "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": [ + "Slugs" + ], + "parameters": [] + } + } + }, + "tags": [ + { + "name": "Slugs" + } + ] +} \ No newline at end of file diff --git a/api/teks/documentation/1.0.0/overrides/teks.json b/api/teks/documentation/1.0.0/overrides/teks.json new file mode 100644 index 0000000..743af6d --- /dev/null +++ b/api/teks/documentation/1.0.0/overrides/teks.json @@ -0,0 +1,20 @@ +{ + "paths": { + "/teks": { + "get": { + "parameters": [] + }, + "post": { + "deprecated": true + } + }, + "/teks/{id}" : { + "put": { + "deprecated": true + }, + "delete": { + "deprecated": true + } + } + } +} \ No newline at end of file diff --git a/api/teks/documentation/1.0.0/teks.json b/api/teks/documentation/1.0.0/teks.json new file mode 100644 index 0000000..4c12b34 --- /dev/null +++ b/api/teks/documentation/1.0.0/teks.json @@ -0,0 +1,861 @@ +{ + "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, + "description": "Retrieve the numver of teks documents", + "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" + } + } + }, + "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", + "Soundcloud", + "File" + ] + } + } + } + }, + "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" + } + }, + "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", + "Amazon" + ] + } + } + } + }, + "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" + } + } + }, + "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" + } + } + }, + "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", + "Soundcloud", + "File" + ] + } + } + } + }, + "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", + "Amazon" + ] + } + } + } + }, + "slug": { + "type": "string" + }, + "published_at": { + "type": "string", + "format": "date-time" + }, + "created_by": { + "type": "string" + }, + "updated_by": { + "type": "string" + } + } + } + } + }, + "tags": [ + { + "name": "Teks" + } + ] +} \ No newline at end of file diff --git a/extensions/documentation/config/settings.json b/extensions/documentation/config/settings.json new file mode 100644 index 0000000..0429639 --- /dev/null +++ b/extensions/documentation/config/settings.json @@ -0,0 +1,43 @@ +{ + "openapi": "3.0.0", + "info": { + "version": "1.0.0", + "title": "#OKi API Dokiman", + "description": "", + "termsOfService": null, + "contact": { + "name": "#OKi", + "email": "kontak@o-k-i.net", + "url": "https://o-k-i.net" + }, + "license": null + }, + "x-strapi-config": { + "path": "/dokiman", + "showGeneratedFiles": true, + "pluginsForWhichToGenerateDoc": [] + }, + "servers": [ + { + "url": "https://api.o-k-i.net", + "description": "Production server" + }, + { + "url": "http://localhost:1337", + "description": "Development server" + }, + { + "url": "http://localhost:1337", + "description": "Staging server" + } + ], + "externalDocs": null, + "security": [ + { + "bearerAuth": [] + } + ], + "paths": {}, + "tags": [], + "components": {} +} diff --git a/extensions/documentation/documentation/1.0.0/full_documentation.json b/extensions/documentation/documentation/1.0.0/full_documentation.json new file mode 100644 index 0000000..52d7264 --- /dev/null +++ b/extensions/documentation/documentation/1.0.0/full_documentation.json @@ -0,0 +1,1417 @@ +{ + "openapi": "3.0.0", + "info": { + "version": "1.0.0", + "title": "#OKi API Dokiman", + "description": "", + "termsOfService": null, + "contact": { + "name": "#OKi", + "email": "kontak@o-k-i.net", + "url": "https://o-k-i.net" + }, + "license": null, + "x-generation-date": "01/05/2021 2:09:59 AM" + }, + "x-strapi-config": { + "path": "/dokiman", + "showGeneratedFiles": true, + "generateDefaultResponse": true, + "pluginsForWhichToGenerateDoc": [] + }, + "servers": [ + { + "url": "https://api.o-k-i.net", + "description": "Production server" + }, + { + "url": "http://localhost:1337", + "description": "Development server" + }, + { + "url": "http://localhost:1337", + "description": "Staging server" + } + ], + "externalDocs": null, + "security": [ + { + "bearerAuth": [] + } + ], + "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": [] + }, + "post": { + "deprecated": true, + "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": true, + "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": true, + "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" + } + } + ] + } + }, + "/slugs": { + "get": { + "deprecated": false, + "description": "", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "foo": { + "type": "string" + } + } + } + } + } + }, + "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": [ + "Slugs" + ], + "parameters": [] + } + }, + "/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": [] + }, + "post": { + "deprecated": true, + "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, + "description": "Retrieve the numver of teks documents", + "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": true, + "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": true, + "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": { + "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" + }, + "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" + } + } + }, + "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" + } + } + }, + "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", + "Soundcloud", + "File" + ] + } + } + } + }, + "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" + } + }, + "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", + "Amazon" + ] + } + } + } + }, + "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" + } + } + }, + "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" + } + } + }, + "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", + "Soundcloud", + "File" + ] + } + } + } + }, + "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", + "Amazon" + ] + } + } + } + }, + "slug": { + "type": "string" + }, + "published_at": { + "type": "string", + "format": "date-time" + }, + "created_by": { + "type": "string" + }, + "updated_by": { + "type": "string" + } + } + }, + "Error": { + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + } + } + } + }, + "securitySchemes": { + "bearerAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + } + } + }, + "tags": [ + { + "name": "Awtis" + }, + { + "name": "Slugs" + }, + { + "name": "Teks" + } + ] +} \ No newline at end of file diff --git a/extensions/documentation/public/index.html b/extensions/documentation/public/index.html new file mode 100644 index 0000000..1ab0f04 --- /dev/null +++ b/extensions/documentation/public/index.html @@ -0,0 +1,57 @@ + + + Swagger UI + + + + + + + +
+ + + + + +