Add punctuation to property descriptions

This commit is contained in:
Iván Ovejero 2021-01-29 11:44:02 -03:00
parent f712b5214e
commit 7b5dccb05d
5 changed files with 391 additions and 391 deletions

View file

@ -1,68 +1,68 @@
import {
INodeProperties,
} from 'n8n-workflow';
export const commentOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
default: 'create',
description: 'Operation to perform',
options: [
{
name: 'Create',
value: 'create',
},
],
displayOptions: {
show: {
resource: [
'comment',
],
},
},
},
] as INodeProperties[];
export const commentFields = [
// ----------------------------------
// comment: create
// ----------------------------------
{
displayName: 'Target',
name: 'target',
type: 'string',
default: '',
description: 'ID of the comment target',
placeholder: 't3_15bfi0',
displayOptions: {
show: {
resource: [
'comment',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Text',
name: 'text',
type: 'string',
required: true,
default: '',
description: 'Text of the comment (Markdown supported)',
displayOptions: {
show: {
resource: [
'comment',
],
operation: [
'create',
],
},
},
},
] as INodeProperties[];
import {
INodeProperties,
} from 'n8n-workflow';
export const commentOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
default: 'create',
description: 'Operation to perform',
options: [
{
name: 'Create',
value: 'create',
},
],
displayOptions: {
show: {
resource: [
'comment',
],
},
},
},
] as INodeProperties[];
export const commentFields = [
// ----------------------------------
// comment: create
// ----------------------------------
{
displayName: 'Target',
name: 'target',
type: 'string',
default: '',
description: 'ID of the comment target.',
placeholder: 't3_15bfi0',
displayOptions: {
show: {
resource: [
'comment',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Text',
name: 'text',
type: 'string',
required: true,
default: '',
description: 'Text of the comment. Markdown supported.',
displayOptions: {
show: {
resource: [
'comment',
],
operation: [
'create',
],
},
},
},
] as INodeProperties[];

View file

@ -1,306 +1,306 @@
import {
INodeProperties,
} from 'n8n-workflow';
export const postOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
default: 'create',
description: 'Operation to perform',
options: [
{
name: 'Create',
value: 'create',
},
{
name: 'Get All',
value: 'getAll',
},
],
displayOptions: {
show: {
resource: [
'post',
],
},
},
},
] as INodeProperties[];
export const postFields = [
// ----------------------------------
// post: create
// ----------------------------------
{
displayName: 'Subreddit',
name: 'subreddit',
type: 'string',
required: true,
default: '',
description: 'Subreddit to create the post in',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Kind',
name: 'kind',
type: 'options',
options: [
{
name: 'Text Post',
value: 'self',
},
{
name: 'Link Post',
value: 'link',
},
{
name: 'Image Post',
value: 'image',
},
{
name: 'Video Post',
value: 'video',
},
{
name: 'Video GIF Post',
value: 'videogif',
},
],
default: 'self',
description: 'The kind of the post to create',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Title',
name: 'title',
type: 'string',
required: true,
default: '',
description: 'Title of the post, up to 300 characters long',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'create',
],
},
},
},
{
displayName: 'URL',
name: 'url',
type: 'string',
required: true,
default: '',
description: 'URL of the post',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'create',
],
kind: [
'link',
'image',
'video',
'videogif',
],
},
},
},
{
displayName: 'Text',
name: 'text',
type: 'string',
required: true,
default: '',
description: 'Text of the post (Markdown supported)',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'create',
],
kind: [
'self',
],
},
},
},
{
displayName: 'Resubmit',
name: 'resubmit',
type: 'boolean',
default: false,
description: 'If toggled on, the URL will be posted even if<br>it was already posted to the subreddit before.<br>Otherwise, the re-posting will trigger an error.',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'create',
],
kind: [
'link',
'image',
'video',
'videogif',
],
},
},
},
// ----------------------------------
// post: getAll
// ----------------------------------
{
displayName: 'Best',
name: 'best',
type: 'boolean',
default: false,
description: 'Best posts in all of Reddit',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Subreddit',
name: 'subreddit',
type: 'string',
required: true,
default: '',
description: 'The name of subreddit to retrieve the posts from',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'getAll',
],
best: [
false,
],
},
},
},
{
displayName: 'Content',
name: 'content',
type: 'options',
required: true,
default: 'top',
description: 'Content of posts to retrieve',
options: [
{
name: 'Top Posts',
value: 'top',
},
{
name: 'Hot Posts',
value: 'hot',
},
{
name: 'New Posts',
value: 'new',
},
{
name: 'Rising Posts',
value: 'rising',
},
],
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'getAll',
],
best: [
false,
],
},
},
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Return all results',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'getAll',
],
best: [
false,
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 5,
description: 'The number of results to return',
typeOptions: {
minValue: 1,
maxValue: 100,
},
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'getAll',
],
returnAll: [
false,
],
best: [
false,
],
},
},
},
] as INodeProperties[];
import {
INodeProperties,
} from 'n8n-workflow';
export const postOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
default: 'create',
description: 'Operation to perform',
options: [
{
name: 'Create',
value: 'create',
},
{
name: 'Get All',
value: 'getAll',
},
],
displayOptions: {
show: {
resource: [
'post',
],
},
},
},
] as INodeProperties[];
export const postFields = [
// ----------------------------------
// post: create
// ----------------------------------
{
displayName: 'Subreddit',
name: 'subreddit',
type: 'string',
required: true,
default: '',
description: 'Subreddit to create the post in.',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Kind',
name: 'kind',
type: 'options',
options: [
{
name: 'Text Post',
value: 'self',
},
{
name: 'Link Post',
value: 'link',
},
{
name: 'Image Post',
value: 'image',
},
{
name: 'Video Post',
value: 'video',
},
{
name: 'Video GIF Post',
value: 'videogif',
},
],
default: 'self',
description: 'The kind of the post to create',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Title',
name: 'title',
type: 'string',
required: true,
default: '',
description: 'Title of the post, up to 300 characters long.',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'create',
],
},
},
},
{
displayName: 'URL',
name: 'url',
type: 'string',
required: true,
default: '',
description: 'URL of the post.',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'create',
],
kind: [
'link',
'image',
'video',
'videogif',
],
},
},
},
{
displayName: 'Text',
name: 'text',
type: 'string',
required: true,
default: '',
description: 'Text of the post. Markdown supported.',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'create',
],
kind: [
'self',
],
},
},
},
{
displayName: 'Resubmit',
name: 'resubmit',
type: 'boolean',
default: false,
description: 'If toggled on, the URL will be posted even if<br>it was already posted to the subreddit before.<br>Otherwise, the re-posting will trigger an error.',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'create',
],
kind: [
'link',
'image',
'video',
'videogif',
],
},
},
},
// ----------------------------------
// post: getAll
// ----------------------------------
{
displayName: 'Best',
name: 'best',
type: 'boolean',
default: false,
description: 'Best posts in all of Reddit.',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Subreddit',
name: 'subreddit',
type: 'string',
required: true,
default: '',
description: 'The name of subreddit to retrieve the posts from.',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'getAll',
],
best: [
false,
],
},
},
},
{
displayName: 'Content',
name: 'content',
type: 'options',
required: true,
default: 'top',
description: 'Content of the posts to retrieve.',
options: [
{
name: 'Top Posts',
value: 'top',
},
{
name: 'Hot Posts',
value: 'hot',
},
{
name: 'New Posts',
value: 'new',
},
{
name: 'Rising Posts',
value: 'rising',
},
],
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'getAll',
],
best: [
false,
],
},
},
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Return all results.',
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'getAll',
],
best: [
false,
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 5,
description: 'The number of results to return.',
typeOptions: {
minValue: 1,
maxValue: 100,
},
displayOptions: {
show: {
resource: [
'post',
],
operation: [
'getAll',
],
returnAll: [
false,
],
best: [
false,
],
},
},
},
] as INodeProperties[];

View file

@ -33,27 +33,27 @@ export const profileFields = [
type: 'options',
required: true,
default: 'identity',
description: 'Details of my account to retrieve',
description: 'Details of my account to retrieve.',
options: [
{
name: 'Identity',
value: 'identity',
description: 'Return the identity of the logged-in user',
description: 'Return the identity of the logged-in user.',
},
{
name: 'Blocked Users',
value: 'blockedUsers',
description: 'Return the blocked users of the logged-in user',
description: 'Return the blocked users of the logged-in user.',
},
{
name: 'Friends',
value: 'friends',
description: 'Return the friends of the logged-in user',
description: 'Return the friends of the logged-in user.',
},
{
name: 'Karma',
value: 'karma',
description: 'Return the subreddit karma for the logged-in user',
description: 'Return the subreddit karma for the logged-in user.',
},
{
name: 'Preferences',
@ -63,7 +63,7 @@ export const profileFields = [
{
name: 'Trophies',
value: 'trophies',
description: 'Return the trophies of the logged-in user',
description: 'Return the trophies of the logged-in user.',
},
],
displayOptions: {

View file

@ -39,7 +39,7 @@ export const subredditFields = [
type: 'options',
required: true,
default: 'about',
description: 'Subreddit content to retrieve',
description: 'Subreddit content to retrieve.',
options: [
{
name: 'About',
@ -75,7 +75,7 @@ export const subredditFields = [
type: 'string',
required: true,
default: '',
description: 'The name of subreddit to retrieve the content from',
description: 'The name of subreddit to retrieve the content from.',
displayOptions: {
show: {
resource: [
@ -92,7 +92,7 @@ export const subredditFields = [
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Return all results',
description: 'Return all results.',
displayOptions: {
show: {
resource: [
@ -109,7 +109,7 @@ export const subredditFields = [
name: 'limit',
type: 'number',
default: 5,
description: 'The number of results to return',
description: 'The number of results to return.',
typeOptions: {
minValue: 1,
maxValue: 100,
@ -136,7 +136,7 @@ export const subredditFields = [
name: 'trending',
type: 'boolean',
default: false,
description: 'Currently trending subreddits in all of Reddit',
description: 'Currently trending subreddits in all of Reddit.',
displayOptions: {
show: {
resource: [
@ -153,7 +153,7 @@ export const subredditFields = [
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Return all results',
description: 'Return all results.',
displayOptions: {
show: {
resource: [
@ -173,7 +173,7 @@ export const subredditFields = [
name: 'limit',
type: 'number',
default: 5,
description: 'The number of results to return',
description: 'The number of results to return.',
typeOptions: {
minValue: 1,
maxValue: 100,

View file

@ -32,7 +32,7 @@ export const userFields = [
type: 'string',
required: true,
default: '',
description: 'Reddit ID of the user to retrieve',
description: 'Reddit ID of the user to retrieve.',
displayOptions: {
show: {
resource: [
@ -50,7 +50,7 @@ export const userFields = [
type: 'options',
required: true,
default: 'about',
description: 'Details of the user to retrieve',
description: 'Details of the user to retrieve.',
options: [
{
name: 'About',
@ -89,7 +89,7 @@ export const userFields = [
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Return all results',
description: 'Return all results.',
displayOptions: {
show: {
resource: [
@ -112,7 +112,7 @@ export const userFields = [
name: 'limit',
type: 'number',
default: 5,
description: 'The number of results to return',
description: 'The number of results to return.',
typeOptions: {
minValue: 1,
maxValue: 100,