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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

215 lines
4.9 KiB
TypeScript
Raw Normal View History

import type { 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: INodeProperties[] = [
2020-07-09 02:36:28 -07:00
{
displayName: 'Operation',
name: 'operation',
type: 'options',
refactor: Apply more nodelinting rules (#3324) * :pencil2: Alphabetize lint rules * :fire: Remove duplicates * :zap: Update `lintfix` script * :shirt: Apply `node-param-operation-without-no-data-expression` (#3329) * :shirt: Apply `node-param-operation-without-no-data-expression` * :shirt: Add exceptions * :shirt: Apply `node-param-description-weak` (#3328) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-value-duplicate` (#3331) * :shirt: Apply `node-param-description-miscased-json` (#3337) * :shirt: Apply `node-param-display-name-excess-inner-whitespace` (#3335) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-type-options-missing-from-limit` (#3336) * Rule workig as intended * :pencil2: Uncomment rules Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-duplicate` (#3338) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-simplify` (#3334) * :zap: fix * :zap: exceptions * :zap: changed rule ignoring from file to line * :shirt: Apply `node-param-resource-without-no-data-expression` (#3339) * :shirt: Apply `node-param-display-name-untrimmed` (#3341) * :shirt: Apply `node-param-display-name-miscased-id` (#3340) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-resource-with-plural-option` (#3342) * :shirt: Apply `node-param-description-wrong-for-upsert` (#3333) * :zap: fix * :zap: replaced record with contact in description * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-description-identical-to-name` (#3343) * :shirt: Apply `node-param-option-name-containing-star` (#3347) * :shirt: Apply `node-param-display-name-wrong-for-update-fields` (#3348) * :shirt: Apply `node-param-option-name-wrong-for-get-all` (#3345) * :zap: fix * :zap: exceptions * :shirt: Apply node-param-display-name-wrong-for-simplify (#3344) * Rule working as intended * Uncomented other rules * :shirt: Undo and add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Alphabetize lint rules * :zap: Restore `lintfix` script Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
2022-05-20 14:47:24 -07:00
noDataExpression: true,
2020-07-09 02:36:28 -07:00
displayOptions: {
show: {
resource: [resource.value],
2020-08-04 12:07:54 -07:00
},
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
},
{
name: 'Get Many',
2020-08-04 12:07:54 -07:00
value: 'getAll',
},
2020-07-09 02:36:28 -07:00
],
2020-08-04 12:07:54 -07:00
default: 'get',
2020-10-22 06:46:03 -07:00
},
];
2020-07-09 02:36:28 -07:00
export const fields: INodeProperties[] = [
2020-07-09 02:36:28 -07:00
{
2020-08-04 12:07:54 -07:00
displayName: 'Environment ID',
name: 'environmentId',
type: 'string',
displayOptions: {
show: {
resource: [resource.value],
operation: ['get', 'getAll'],
2020-08-04 12:07:54 -07:00
},
},
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: {
operation: ['getAll'],
resource: [resource.value],
2020-08-04 12:07:54 -07:00
},
},
default: false,
description: 'Whether to return all results 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-08-04 12:07:54 -07:00
},
},
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: 'Max number of results to return',
2020-08-04 12:07:54 -07:00
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
2020-07-09 02:36:28 -07:00
displayOptions: {
show: {
resource: [resource.value],
operation: ['getAll'],
2020-08-04 12:07:54 -07:00
},
},
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.',
2020-08-04 12:07:54 -07:00
},
{
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.',
2020-08-04 12:07:54 -07:00
},
{
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.',
2020-08-04 12:07:54 -07:00
},
{
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.',
2020-08-04 12:07:54 -07:00
},
{
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.',
2020-08-04 12:07:54 -07:00
},
{
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.',
2020-08-04 12:07:54 -07:00
},
{
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.',
2020-08-04 12:07:54 -07:00
},
{
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.',
2020-08-04 12:07:54 -07:00
},
{
displayName: 'RAW Data',
name: 'rawData',
type: 'boolean',
default: false,
refactor: Apply more `eslint-plugin-n8n-nodes-base` rules (#3534) * :zap: Update `lintfix` script * :zap: Run baseline `lintfix` * :fire: Remove unneeded exceptions (#3538) * :fire: Remove exceptions for `node-param-default-wrong-for-simplify` * :fire: Remove exceptions for `node-param-placeholder-miscased-id` * :zap: Update version * :shirt: Apply `node-param-placeholder-missing` (#3542) * :shirt: Apply `filesystem-wrong-cred-filename` (#3543) * :shirt: Apply `node-param-description-missing-from-dynamic-options` (#3545) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-class-description-empty-string` (#3546) * :shirt: Apply `node-class-description-icon-not-svg` (#3548) * :shirt: Apply `filesystem-wrong-node-filename` (#3549) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Expand lintings to credentials (#3550) * :shirt: Apply `node-param-multi-options-type-unsorted-items` (#3552) * :zap: fix * :zap: Minor fixes Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-multi-options` (#3541) * :zap: Add new lint rule, node-param-description-wrong-for-dynamic-multi-options * :zap: Fix with updated linting rules * :zap: Minor fixes Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-boolean-without-whether` (#3553) * :zap: fix * Update packages/nodes-base/nodes/Clockify/ProjectDescription.ts Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply node-param-display-name-wrong-for-dynamic-multi-options (#3537) * :shirt: Add exceptions * :shirt: Add exception * :pencil2: Alphabetize rules * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
2022-06-20 07:54:01 -07:00
description: 'Whether 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: {
resource: [resource.value],
operation: ['get'],
2020-08-04 12:07:54 -07:00
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [resource.value],
operation: ['get'],
},
},
options: [
{
displayName: 'RAW Data',
name: 'rawData',
type: 'boolean',
default: false,
description: 'Whether the data should be returned RAW instead of parsed',
},
],
},
];