From 2c2b5f6232a4a8bbfa3e642a3da3f0a44c1b7a97 Mon Sep 17 00:00:00 2001 From: kodumbeats Date: Mon, 27 Sep 2021 20:26:33 -0400 Subject: [PATCH] Create docs for api/sdk description --- app/controllers/api/database.php | 14 +++++++------- .../database/create-boolean-attribute.md | 1 + docs/references/database/create-email-attribute.md | 1 + docs/references/database/create-float-attribute.md | 1 + .../database/create-integer-attribute.md | 1 + docs/references/database/create-ip-attribute.md | 1 + .../references/database/create-string-attribute.md | 1 + docs/references/database/create-url-attribute.md | 1 + 8 files changed, 14 insertions(+), 7 deletions(-) create mode 100644 docs/references/database/create-boolean-attribute.md create mode 100644 docs/references/database/create-email-attribute.md create mode 100644 docs/references/database/create-float-attribute.md create mode 100644 docs/references/database/create-integer-attribute.md create mode 100644 docs/references/database/create-ip-attribute.md create mode 100644 docs/references/database/create-string-attribute.md create mode 100644 docs/references/database/create-url-attribute.md diff --git a/app/controllers/api/database.php b/app/controllers/api/database.php index 90a745eb0..9e75c0ae1 100644 --- a/app/controllers/api/database.php +++ b/app/controllers/api/database.php @@ -666,7 +666,7 @@ App::post('/v1/database/collections/:collectionId/attributes/string') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.namespace', 'database') ->label('sdk.method', 'createStringAttribute') - ->label('sdk.description', '/docs/references/database/create-attribute-string.md') + ->label('sdk.description', '/docs/references/database/create-string-attribute.md') ->label('sdk.response.code', Response::STATUS_CODE_CREATED) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_ATTRIBUTE) @@ -714,7 +714,7 @@ App::post('/v1/database/collections/:collectionId/attributes/email') ->label('sdk.namespace', 'database') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.method', 'createEmailAttribute') - ->label('sdk.description', '/docs/references/database/create-attribute-email.md') + ->label('sdk.description', '/docs/references/database/create-email-attribute.md') ->label('sdk.response.code', Response::STATUS_CODE_CREATED) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_ATTRIBUTE) @@ -756,7 +756,7 @@ App::post('/v1/database/collections/:collectionId/attributes/ip') ->label('sdk.namespace', 'database') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.method', 'createIpAttribute') - ->label('sdk.description', '/docs/references/database/create-attribute-ip.md') + ->label('sdk.description', '/docs/references/database/create-ip-attribute.md') ->label('sdk.response.code', Response::STATUS_CODE_CREATED) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_ATTRIBUTE) @@ -798,7 +798,7 @@ App::post('/v1/database/collections/:collectionId/attributes/url') ->label('sdk.namespace', 'database') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.method', 'createUrlAttribute') - ->label('sdk.description', '/docs/references/database/create-attribute-url.md') + ->label('sdk.description', '/docs/references/database/create-url-attribute.md') ->label('sdk.response.code', Response::STATUS_CODE_CREATED) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_ATTRIBUTE) @@ -840,7 +840,7 @@ App::post('/v1/database/collections/:collectionId/attributes/integer') ->label('sdk.namespace', 'database') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.method', 'createIntegerAttribute') - ->label('sdk.description', '/docs/references/database/create-attribute-integer.md') + ->label('sdk.description', '/docs/references/database/create-integer-attribute.md') ->label('sdk.response.code', Response::STATUS_CODE_CREATED) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_ATTRIBUTE) @@ -904,7 +904,7 @@ App::post('/v1/database/collections/:collectionId/attributes/float') ->label('sdk.namespace', 'database') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.method', 'createFloatAttribute') - ->label('sdk.description', '/docs/references/database/create-attribute-float.md') + ->label('sdk.description', '/docs/references/database/create-float-attribute.md') ->label('sdk.response.code', Response::STATUS_CODE_CREATED) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_ATTRIBUTE) @@ -968,7 +968,7 @@ App::post('/v1/database/collections/:collectionId/attributes/boolean') ->label('sdk.namespace', 'database') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.method', 'createBooleanAttribute') - ->label('sdk.description', '/docs/references/database/create-attribute-boolean.md') + ->label('sdk.description', '/docs/references/database/create-boolean-attribute.md') ->label('sdk.response.code', Response::STATUS_CODE_CREATED) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_ATTRIBUTE) diff --git a/docs/references/database/create-boolean-attribute.md b/docs/references/database/create-boolean-attribute.md new file mode 100644 index 000000000..91c5449de --- /dev/null +++ b/docs/references/database/create-boolean-attribute.md @@ -0,0 +1 @@ +Create a boolean attribute. diff --git a/docs/references/database/create-email-attribute.md b/docs/references/database/create-email-attribute.md new file mode 100644 index 000000000..7dd93d5a8 --- /dev/null +++ b/docs/references/database/create-email-attribute.md @@ -0,0 +1 @@ +Create an email attribute. diff --git a/docs/references/database/create-float-attribute.md b/docs/references/database/create-float-attribute.md new file mode 100644 index 000000000..00ad538d8 --- /dev/null +++ b/docs/references/database/create-float-attribute.md @@ -0,0 +1 @@ +Create a float attribute. Optionally, minimum and maximum values can be provided. diff --git a/docs/references/database/create-integer-attribute.md b/docs/references/database/create-integer-attribute.md new file mode 100644 index 000000000..d5455ff5f --- /dev/null +++ b/docs/references/database/create-integer-attribute.md @@ -0,0 +1 @@ +Create an integer attribute. Optionally, minimum and maximum values can be provided. diff --git a/docs/references/database/create-ip-attribute.md b/docs/references/database/create-ip-attribute.md new file mode 100644 index 000000000..b0fa02ef7 --- /dev/null +++ b/docs/references/database/create-ip-attribute.md @@ -0,0 +1 @@ +Create IP address attribute. diff --git a/docs/references/database/create-string-attribute.md b/docs/references/database/create-string-attribute.md new file mode 100644 index 000000000..b17fb1ce5 --- /dev/null +++ b/docs/references/database/create-string-attribute.md @@ -0,0 +1 @@ +Create a new string attribute. diff --git a/docs/references/database/create-url-attribute.md b/docs/references/database/create-url-attribute.md new file mode 100644 index 000000000..1b9c55dd4 --- /dev/null +++ b/docs/references/database/create-url-attribute.md @@ -0,0 +1 @@ +Create a URL attribute.