CodeMirror/appwrite
1
0
Fork 0
mirror of synced 2024-06-14 00:34:51 +12:00
Code Issues Projects Releases Wiki Activity

Add doc refs

Browse source
This commit is contained in:
Jake Barnby 2024-02-21 22:04:27 +13:00
parent bc517ed69b
commit 9498d680fb
No known key found for this signature in database
GPG key ID: C437A8CC85B96E9C
47 changed files with 79 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
app/controllers/api/messaging.php
View file

@ -219,14 +219,14 @@ App::post('/v1/messaging/providers/smtp')
->label('scope', 'providers.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'createSMTPProvider')
->label('sdk.method', 'createSmtpProvider')
->label('sdk.description', '/docs/references/messaging/create-smtp-provider.md')
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_PROVIDER)
->param('providerId', '', new CustomId(), 'Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars.')
->param('name', '', new Text(128), 'Provider name.')
->param('host', '', new Text(0), 'SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host by using this format: [hostname:port] (e.g. "smtp1.example.com:25;smtp2.example.com"). You can also specify encryption type, for example: (e.g. "tls://smtp1.example.com:587;ssl://smtp2.example.com:465"). Hosts will be tried in order.')
->param('host', '', new Text(0), 'SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.')
->param('port', 587, new Range(1, 65535), 'The default SMTP server port.', true)
->param('username', '', new Text(0), 'Authentication username.', true)
->param('password', '', new Text(0), 'Authentication password.', true)
@ -692,7 +692,7 @@ App::post('/v1/messaging/providers/fcm')
->label('scope', 'providers.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'createFCMProvider')
->label('sdk.method', 'createFcmProvider')
->label('sdk.description', '/docs/references/messaging/create-fcm-provider.md')
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
@ -755,7 +755,7 @@ App::post('/v1/messaging/providers/apns')
->label('scope', 'providers.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'createAPNSProvider')
->label('sdk.method', 'createApnsProvider')
->label('sdk.description', '/docs/references/messaging/create-apns-provider.md')
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
@ -884,7 +884,7 @@ App::get('/v1/messaging/providers/:providerId/logs')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'listProviderLogs')
->label('sdk.description', '/docs/references/messaging/providers/get-logs.md')
->label('sdk.description', '/docs/references/messaging/list-provider-logs.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_LOG_LIST)
@ -1195,14 +1195,14 @@ App::patch('/v1/messaging/providers/smtp/:providerId')
->label('scope', 'providers.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'updateSMTPProvider')
->label('sdk.method', 'updateSmtpProvider')
->label('sdk.description', '/docs/references/messaging/update-smtp-provider.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_PROVIDER)
->param('providerId', '', new UID(), 'Provider ID.')
->param('name', '', new Text(128), 'Provider name.', true)
->param('host', '', new Text(0), 'SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host by using this format: [hostname:port] (e.g. "smtp1.example.com:25;smtp2.example.com"). You can also specify encryption type, for example: (e.g. "tls://smtp1.example.com:587;ssl://smtp2.example.com:465"). Hosts will be tried in order.', true)
->param('host', '', new Text(0), 'SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465"`. Hosts will be tried in order.', true)
->param('port', null, new Range(1, 65535), 'SMTP port.', true)
->param('username', '', new Text(0), 'Authentication username.', true)
->param('password', '', new Text(0), 'Authentication password.', true)
@ -1909,7 +1909,7 @@ App::delete('/v1/messaging/providers/:providerId')
});
App::post('/v1/messaging/topics')
->desc('Create a topic.')
->desc('Create a topic')
->groups(['api', 'messaging'])
->label('audits.event', 'topic.create')
->label('audits.resource', 'topic/{response.$id}')
@ -1952,7 +1952,7 @@ App::post('/v1/messaging/topics')
});
App::get('/v1/messaging/topics')
->desc('List topics.')
->desc('List topics')
->groups(['api', 'messaging'])
->label('scope', 'topics.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
@ -2009,7 +2009,7 @@ App::get('/v1/messaging/topics/:topicId/logs')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'listTopicLogs')
->label('sdk.description', '/docs/references/messaging/topics/get-logs.md')
->label('sdk.description', '/docs/references/messaging/list-topic-logs.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_LOG_LIST)
@ -2092,7 +2092,7 @@ App::get('/v1/messaging/topics/:topicId/logs')
});
App::get('/v1/messaging/topics/:topicId')
->desc('Get a topic.')
->desc('Get a topic')
->groups(['api', 'messaging'])
->label('scope', 'topics.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
@ -2119,7 +2119,7 @@ App::get('/v1/messaging/topics/:topicId')
});
App::patch('/v1/messaging/topics/:topicId')
->desc('Update a topic.')
->desc('Update a topic')
->groups(['api', 'messaging'])
->label('audits.event', 'topic.update')
->label('audits.resource', 'topic/{response.$id}')
@ -2158,7 +2158,7 @@ App::patch('/v1/messaging/topics/:topicId')
});
App::delete('/v1/messaging/topics/:topicId')
->desc('Delete a topic.')
->desc('Delete a topic')
->groups(['api', 'messaging'])
->label('audits.event', 'topic.delete')
->label('audits.resource', 'topic/{request.$topicId}')
@ -2198,7 +2198,7 @@ App::delete('/v1/messaging/topics/:topicId')
});
App::post('/v1/messaging/topics/:topicId/subscribers')
->desc('Create a subscriber.')
->desc('Create a subscriber')
->groups(['api', 'messaging'])
->label('audits.event', 'subscriber.create')
->label('audits.resource', 'subscriber/{response.$id}')
@ -2294,7 +2294,7 @@ App::post('/v1/messaging/topics/:topicId/subscribers')
});
App::get('/v1/messaging/topics/:topicId/subscribers')
->desc('List subscribers.')
->desc('List subscribers')
->groups(['api', 'messaging'])
->label('scope', 'subscribers.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
@ -2374,7 +2374,7 @@ App::get('/v1/messaging/subscribers/:subscriberId/logs')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'listSubscriberLogs')
->label('sdk.description', '/docs/references/messaging/subscribers/get-logs.md')
->label('sdk.description', '/docs/references/messaging/list-subscriber-logs.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_LOG_LIST)
@ -2457,7 +2457,7 @@ App::get('/v1/messaging/subscribers/:subscriberId/logs')
});
App::get('/v1/messaging/topics/:topicId/subscribers/:subscriberId')
->desc('Get a subscriber.')
->desc('Get a subscriber')
->groups(['api', 'messaging'])
->label('scope', 'subscribers.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
@ -2496,7 +2496,7 @@ App::get('/v1/messaging/topics/:topicId/subscribers/:subscriberId')
});
App::delete('/v1/messaging/topics/:topicId/subscribers/:subscriberId')
->desc('Delete a subscriber.')
->desc('Delete a subscriber')
->groups(['api', 'messaging'])
->label('audits.event', 'subscriber.delete')
->label('audits.resource', 'subscriber/{request.$subscriberId}')
@ -2555,7 +2555,7 @@ App::delete('/v1/messaging/topics/:topicId/subscribers/:subscriberId')
});
App::post('/v1/messaging/messages/email')
->desc('Create an email.')
->desc('Create an email')
->groups(['api', 'messaging'])
->label('audits.event', 'message.create')
->label('audits.resource', 'message/{response.$id}')
@ -2699,7 +2699,7 @@ App::post('/v1/messaging/messages/email')
});
App::post('/v1/messaging/messages/sms')
->desc('Create an SMS.')
->desc('Create an SMS')
->groups(['api', 'messaging'])
->label('audits.event', 'message.create')
->label('audits.resource', 'message/{response.$id}')
@ -2707,7 +2707,7 @@ App::post('/v1/messaging/messages/sms')
->label('scope', 'messages.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'createSMS')
->label('sdk.method', 'createSms')
->label('sdk.description', '/docs/references/messaging/create-sms.md')
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
@ -2807,7 +2807,7 @@ App::post('/v1/messaging/messages/sms')
});
App::post('/v1/messaging/messages/push')
->desc('Create a push notification.')
->desc('Create a push notification')
->groups(['api', 'messaging'])
->label('audits.event', 'message.create')
->label('audits.resource', 'message/{response.$id}')
@ -2816,7 +2816,7 @@ App::post('/v1/messaging/messages/push')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'createPush')
->label('sdk.description', '/docs/references/messaging/create-push-notification.md')
->label('sdk.description', '/docs/references/messaging/create-push.md')
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_MESSAGE)
@ -3022,7 +3022,7 @@ App::get('/v1/messaging/messages/:messageId/logs')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'listMessageLogs')
->label('sdk.description', '/docs/references/messaging/messages/get-logs.md')
->label('sdk.description', '/docs/references/messaging/list-message-logs.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_LOG_LIST)
@ -3194,7 +3194,7 @@ App::get('/v1/messaging/messages/:messageId')
});
App::patch('/v1/messaging/messages/email/:messageId')
->desc('Update an email.')
->desc('Update an email')
->groups(['api', 'messaging'])
->label('audits.event', 'message.update')
->label('audits.resource', 'message/{response.$id}')
@ -3332,7 +3332,7 @@ App::patch('/v1/messaging/messages/email/:messageId')
});
App::patch('/v1/messaging/messages/sms/:messageId')
->desc('Update an SMS.')
->desc('Update an SMS')
->groups(['api', 'messaging'])
->label('audits.event', 'message.update')
->label('audits.resource', 'message/{response.$id}')
@ -3340,7 +3340,7 @@ App::patch('/v1/messaging/messages/sms/:messageId')
->label('scope', 'messages.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'updateSMS')
->label('sdk.method', 'updateSms')
->label('sdk.description', '/docs/references/messaging/update-email.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
@ -3450,7 +3450,7 @@ App::patch('/v1/messaging/messages/sms/:messageId')
});
App::patch('/v1/messaging/messages/push/:messageId')
->desc('Update a push notification.')
->desc('Update a push notification')
->groups(['api', 'messaging'])
->label('audits.event', 'message.update')
->label('audits.resource', 'message/{response.$id}')
@ -3459,7 +3459,7 @@ App::patch('/v1/messaging/messages/push/:messageId')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'updatePush')
->label('sdk.description', '/docs/references/messaging/update-push-notification.md')
->label('sdk.description', '/docs/references/messaging/update-push.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_MESSAGE)

1
docs/references/messaging/create-apns-provider.md Normal file
View file

@ -0,0 +1 @@
Create a new Apple Push Notification service provider.

1
docs/references/messaging/create-email.md Normal file
View file

@ -0,0 +1 @@
Create a new email message.

1
docs/references/messaging/create-fcm-provider.md Normal file
View file

@ -0,0 +1 @@
Create a new Firebase Cloud Messaging provider.

1
docs/references/messaging/create-mailgun-provider.md Normal file
View file

@ -0,0 +1 @@
Create a new Mailgun provider.

1
docs/references/messaging/create-msg91-provider.md Normal file
View file

@ -0,0 +1 @@
Create a new MSG91 provider.

1
docs/references/messaging/create-push.md Normal file
View file

@ -0,0 +1 @@
Create a new push notification.

1
docs/references/messaging/create-sendgrid-provider.md Normal file
View file

@ -0,0 +1 @@
Create a new Sendgrid provider.

1
docs/references/messaging/create-sms.md Normal file
View file

@ -0,0 +1 @@
Create a new SMS message.

1
docs/references/messaging/create-smtp-provider.md Normal file
View file

@ -0,0 +1 @@
Create a new SMTP provider.

1
docs/references/messaging/create-subscriber.md Normal file
View file

@ -0,0 +1 @@
Create a new subscriber.

1
docs/references/messaging/create-telesign-provider.md Normal file
View file

@ -0,0 +1 @@
Create a new Telesign provider.

1
docs/references/messaging/create-textmagic-provider.md Normal file
View file

@ -0,0 +1 @@
Create a new Textmagic provider.

1
docs/references/messaging/create-topic.md Normal file
View file

@ -0,0 +1 @@
Create a new topic.

1
docs/references/messaging/create-twilio-provider.md Normal file
View file

@ -0,0 +1 @@
Create a new Twilio provider.

1
docs/references/messaging/create-vonage-provider.md Normal file
View file

@ -0,0 +1 @@
Create a new Vonage provider.

1
docs/references/messaging/delete-provider.md Normal file
View file

@ -0,0 +1 @@
Delete a provider by its unique ID.

1
docs/references/messaging/delete-subscriber.md Normal file
View file

@ -0,0 +1 @@
Delete a subscriber by its unique ID.

1
docs/references/messaging/delete-topic.md Normal file
View file

@ -0,0 +1 @@
Delete a topic by its unique ID.

1
docs/references/messaging/get-message.md Normal file
View file

@ -0,0 +1 @@
Get a message by its unique ID.

1
docs/references/messaging/get-provider.md Normal file
View file

@ -0,0 +1 @@
Get a provider by its unique ID.

1
docs/references/messaging/get-subscriber.md Normal file
View file

@ -0,0 +1 @@
Get a subscriber by its unique ID.

1
docs/references/messaging/get-topic.md Normal file
View file

@ -0,0 +1 @@
Get a topic by its unique ID.

1
docs/references/messaging/list-message-logs.md Normal file
View file

@ -0,0 +1 @@
Get the message activity logs listed by its unique ID.

2
docs/references/messaging/list-message-targets.md
View file

@ -1 +1 @@
List the targets associated with a message as set via the targets attribute.
Get a list of the targets associated with a message.

1
docs/references/messaging/list-messages.md Normal file
View file

@ -0,0 +1 @@
Get a list of all messages from the current Appwrite project.

1
docs/references/messaging/list-provider-logs.md Normal file
View file

@ -0,0 +1 @@
Get the provider activity logs listed by its unique ID.

1
docs/references/messaging/list-providers.md Normal file
View file

@ -0,0 +1 @@
Get a list of all providers from the current Appwrite project.

1
docs/references/messaging/list-subscriber-logs.md Normal file
View file

@ -0,0 +1 @@
Get the subscriber activity logs listed by its unique ID.

1
docs/references/messaging/list-subscribers.md Normal file
View file

@ -0,0 +1 @@
Get a list of all subscribers from the current Appwrite project.

1
docs/references/messaging/list-topic-logs.md Normal file
View file

@ -0,0 +1 @@
Get the topic activity logs listed by its unique ID.

1
docs/references/messaging/list-topics.md Normal file
View file

@ -0,0 +1 @@
Get a list of all topics from the current Appwrite project.

1
docs/references/messaging/update-apns-provider.md Normal file
View file

@ -0,0 +1 @@
Update a Apple Push Notification service provider by its unique ID.

1
docs/references/messaging/update-email.md Normal file
View file

@ -0,0 +1 @@
Update an email message by its unique ID.

1
docs/references/messaging/update-fcm-provider.md Normal file
View file

@ -0,0 +1 @@
Update a Firebase Cloud Messaging provider by its unique ID.

1
docs/references/messaging/update-mailgun-provider.md Normal file
View file

@ -0,0 +1 @@
Update a Mailgun provider by its unique ID.

1
docs/references/messaging/update-msg91-provider.md Normal file
View file

@ -0,0 +1 @@
Update a MSG91 provider by its unique ID.

1
docs/references/messaging/update-push.md Normal file
View file

@ -0,0 +1 @@
Update a push notification by its unique ID.

1
docs/references/messaging/update-sendgrid-provider.md Normal file
View file

@ -0,0 +1 @@
Update a Sendgrid provider by its unique ID.

1
docs/references/messaging/update-sms.md Normal file
View file

@ -0,0 +1 @@
Update an SMS message by its unique ID.

1
docs/references/messaging/update-smtp-provider.md Normal file
View file

@ -0,0 +1 @@
Update a SMTP provider by its unique ID.

1
docs/references/messaging/update-telesign-provider.md Normal file
View file

@ -0,0 +1 @@
Update a Telesign provider by its unique ID.

1
docs/references/messaging/update-textmagic-provider.md Normal file
View file

@ -0,0 +1 @@
Update a Textmagic provider by its unique ID.

1
docs/references/messaging/update-topic.md Normal file
View file

@ -0,0 +1 @@
Update a topic by its unique ID.

1
docs/references/messaging/update-twilio-provider.md Normal file
View file

@ -0,0 +1 @@
Update a Twilio provider by its unique ID.

1
docs/references/messaging/update-vonage-provider.md Normal file
View file

@ -0,0 +1 @@
Update a Vonage provider by its unique ID.

10
src/Appwrite/Specification/Format.php
View file

@ -208,10 +208,10 @@ abstract class Format
return 'MessagingUsageRange';
}
break;
case 'createSMS':
case 'createSms':
case 'createPush':
case 'createEmail':
case 'updateSMS':
case 'updateSms':
case 'updatePush':
case 'updateEmail':
switch ($param) {
@ -255,9 +255,9 @@ abstract class Format
case 'deleteSmsTemplate':
switch ($param) {
case 'type':
return 'SMSTemplateType';
return 'SmsTemplateType';
case 'locale':
return 'SMSTemplateLocale';
return 'SmsTemplateLocale';
}
break;
case 'createPlatform':
@ -288,7 +288,7 @@ abstract class Format
case 'updateServiceStatus':
switch ($param) {
case 'service':
return 'APIService';
return 'ApiService';
}
break;
}