n8n/packages/nodes-base/nodes/Contentful/EntryDescription.ts

212 lines
4.6 KiB
TypeScript
Raw Normal View History

2020-08-04 12:07:54 -07:00
import {
INodeProperties,
INodePropertyOptions,
} from 'n8n-workflow';
2020-07-09 02:36:28 -07:00
export const resource = {
name: 'Entry',
2020-08-04 12:07:54 -07:00
value: 'entry',
2020-07-09 02:36:28 -07:00
} as INodePropertyOptions;
export const operations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
2020-08-04 12:07:54 -07:00
resource: [
resource.value,
],
},
2020-07-09 02:36:28 -07:00
},
options: [
{
2020-08-04 12:07:54 -07:00
name: 'Get',
value: 'get',
2020-07-09 02:36:28 -07:00
},
{
2020-08-04 12:07:54 -07:00
name: 'Get All',
value: 'getAll',
},
2020-07-09 02:36:28 -07:00
],
2020-08-04 12:07:54 -07:00
default: 'get',
2020-07-09 02:36:28 -07:00
description: 'The operation to perform.'
}
] as INodeProperties[];
export const fields = [
{
2020-08-04 12:07:54 -07:00
displayName: 'Environment ID',
name: 'environmentId',
type: 'string',
displayOptions: {
show: {
resource: [
resource.value,
],
operation: [
'get',
'getAll',
],
},
},
default: 'master',
description: 'The id for the Contentful environment (e.g. master, staging, etc.). Depending on your plan, you might not have environments. In that case use "master".',
2020-08-04 12:07:54 -07:00
},
{
displayName: 'Return All',
name: 'returnAll',
2020-07-09 02:36:28 -07:00
type: 'boolean',
displayOptions: {
show: {
2020-08-04 12:07:54 -07:00
operation: [
'getAll',
],
resource: [
resource.value,
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
2020-07-09 02:36:28 -07:00
},
{
2020-08-04 12:07:54 -07:00
displayName: 'Limit',
name: 'limit',
2020-07-09 02:36:28 -07:00
type: 'number',
2020-08-04 12:07:54 -07:00
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
resource.value,
],
returnAll: [
false,
],
},
},
2020-07-09 02:36:28 -07:00
typeOptions: {
2020-08-04 12:07:54 -07:00
minValue: 1,
maxValue: 500,
2020-07-09 02:36:28 -07:00
},
2020-08-04 12:07:54 -07:00
default: 100,
description: 'How many results to return.',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
2020-07-09 02:36:28 -07:00
displayOptions: {
show: {
2020-08-04 12:07:54 -07:00
resource: [
resource.value,
],
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Content Type ID',
name: 'content_type',
type: 'string',
default: '',
description: 'To search for entries with a specific content type',
},
{
displayName: 'Equal',
name: 'equal',
type: 'string',
default: '',
placeholder: 'fields.title=n8n',
description: 'Search for all data that matches the condition: {attribute}={value}. Attribute can use dot notation.',
},
{
displayName: 'Exclude',
name: 'exclude',
type: 'string',
default: '',
placeholder: 'fields.tags[nin]=accessories,flowers',
description: 'Search for all data that matches the condition: {attribute}[nin]={value}. Attribute can use dot notation.',
},
{
displayName: 'Exist',
name: 'exist',
type: 'string',
default: '',
placeholder: 'fields.tags[exists]=true',
description: 'Search for all data that matches the condition: {attribute}[exists]={value}. Attribute can use dot notation.',
},
{
displayName: 'Fields',
name: 'select',
type: 'string',
placeholder: 'fields.title',
default: '',
description: 'The select operator allows you to choose what fields to return from an entity. You can choose multiple values by combining comma separated operators.',
},
{
displayName: 'Include',
name: 'include',
type: 'string',
default: '',
placeholder: 'fields.tags[in]=accessories,flowers',
description: 'Search for all data that matches the condition: {attribute}[in]={value}. Attribute can use dot notation.',
},
{
displayName: 'Not Equal',
name: 'notEqual',
type: 'string',
default: '',
placeholder: 'fields.title[ne]=n8n',
description: 'Search for all data that matches the condition: {attribute}[ne]={value}. Attribute can use dot notation.',
},
{
displayName: 'Order',
name: 'order',
type: 'string',
default: '',
placeholder: 'sys.createdAt',
description: 'You can order items in the response by specifying the order search parameter. You can use sys properties (such as sys.createdAt) or field values (such as fields.myCustomDateField) for ordering.',
},
{
displayName: 'Query',
name: 'query',
type: 'string',
default: '',
description: ' Full-text search is case insensitive and might return more results than expected. A query will only take values with more than 1 character.',
},
{
displayName: 'RAW Data',
name: 'rawData',
type: 'boolean',
default: false,
description: 'If the data should be returned RAW instead of parsed.',
},
2020-08-04 12:07:54 -07:00
],
2020-07-09 02:36:28 -07:00
},
{
2020-08-04 12:07:54 -07:00
displayName: 'Entry ID',
name: 'entryId',
2020-07-09 02:36:28 -07:00
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
2020-08-04 12:07:54 -07:00
resource: [
resource.value,
],
operation: [
'get',
],
},
},
},
2020-07-09 02:36:28 -07:00
] as INodeProperties[];