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

355 lines
7.1 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
export const entryOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
noDataExpression: true,
type: 'options',
displayOptions: {
show: {
resource: [
'entry',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create an entry',
action: 'Create an entry',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete an entry',
action: 'Delete an entry',
},
{
name: 'Get',
value: 'get',
description: 'Get an entry',
action: 'Get an entry',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all entries',
action: 'Get all entries',
},
{
name: 'Update',
value: 'update',
description: 'Update an entry',
action: 'Update an entry',
},
],
default: 'get',
},
];
export const entryFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* entry:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Content Type',
name: 'contentType',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'create',
],
},
},
description: 'Name of the content type',
},
{
displayName: 'Columns',
name: 'columns',
type: 'string',
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'create',
],
},
},
default: '',
placeholder: 'id,name,description',
refactor: Apply `eslint-plugin-n8n-nodes-base` autofixable rules (#3174) * :zap: Initial setup * :shirt: Update `.eslintignore` * :shirt: Autofix node-param-default-missing (#3173) * :fire: Remove duplicate key * :shirt: Add exceptions * :package: Update package-lock.json * :shirt: Apply `node-class-description-inputs-wrong-trigger-node` (#3176) * :shirt: Apply `node-class-description-inputs-wrong-regular-node` (#3177) * :shirt: Apply `node-class-description-outputs-wrong` (#3178) * :shirt: Apply `node-execute-block-double-assertion-for-items` (#3179) * :shirt: Apply `node-param-default-wrong-for-collection` (#3180) * :shirt: Apply node-param-default-wrong-for-boolean (#3181) * Autofixed default missing * Autofixed booleans, worked well * :zap: Fix params * :rewind: Undo exempted autofixes * :package: Update package-lock.json * :shirt: Apply node-class-description-missing-subtitle (#3182) * :zap: Fix missing comma * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3184) * :shirt: Add exception for `node-class-description-missing-subtitle` * :shirt: Apply `node-param-default-wrong-for-multi-options` (#3185) * :shirt: Apply `node-param-collection-type-unsorted-items` (#3186) * Missing coma * :shirt: Apply `node-param-default-wrong-for-simplify` (#3187) * :shirt: Apply `node-param-description-comma-separated-hyphen` (#3190) * :shirt: Apply `node-param-description-empty-string` (#3189) * :shirt: Apply `node-param-description-excess-inner-whitespace` (#3191) * Rule looks good * Add whitespace rule in eslint config * :zao: fix * :shirt: Apply `node-param-description-identical-to-display-name` (#3193) * :shirt: Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195) * :rewind: Revert ":zao: fix" This reverts commit ef8a76f3dfedffd1bdccf3178af8a8d90cf5a55c. * :shirt: Apply `node-param-description-missing-for-simplify` (#3196) * :shirt: Apply `node-param-description-missing-final-period` (#3194) * Rule working as intended * Add rule to eslint * :shirt: Apply node-param-description-missing-for-return-all (#3197) * :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: agobrech <ael.gobrecht@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 09:29:51 -07:00
description: 'Comma-separated list of the properties which should used as columns for the new rows',
},
/* -------------------------------------------------------------------------- */
/* entry:delete */
/* -------------------------------------------------------------------------- */
{
displayName: 'Content Type',
name: 'contentType',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'delete',
],
},
},
description: 'Name of the content type',
},
{
displayName: 'Entry ID',
name: 'entryId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'delete',
],
},
},
description: 'The ID of the entry to delete',
},
/* -------------------------------------------------------------------------- */
/* entry:get */
/* -------------------------------------------------------------------------- */
{
displayName: 'Content Type',
name: 'contentType',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'get',
],
},
},
description: 'Name of the content type',
},
{
displayName: 'Entry ID',
name: 'entryId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'get',
],
},
},
description: 'The ID of the entry to get',
},
/* -------------------------------------------------------------------------- */
/* entry:getAll */
/* -------------------------------------------------------------------------- */
{
displayName: 'Content Type',
name: 'contentType',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'getAll',
],
},
},
description: 'Name of the content type',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'getAll',
],
},
},
default: false,
description: 'Whether to return all results or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 50,
description: 'Max number of results to return',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Publication State',
name: 'publicationState',
type: 'options',
options: [
{
name: 'Live',
value: 'live',
},
{
name: 'Preview',
value: 'preview',
},
],
default: '',
description: 'Only select entries matching the publication state provided',
},
{
displayName: 'Sort Fields',
name: 'sort',
type: 'string',
typeOptions: {
multipleValues: true,
multipleValueButtonText: 'Add Sort Field',
},
default: '',
placeholder: 'name:asc',
description: 'Name of the fields to sort the data by. By default will be sorted ascendingly. To modify that behavior, you have to add the sort direction after the name of sort field preceded by a colon. For example: <code>name:asc</code>.',
},
{
displayName: 'Where (JSON)',
name: 'where',
type: 'string',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
description: 'JSON query to filter the data. <a href="https://strapi.io/documentation/developer-docs/latest/developer-resources/content-api/content-api.html#filters">More info</a>.',
},
],
},
/* -------------------------------------------------------------------------- */
/* entry:update */
/* -------------------------------------------------------------------------- */
{
displayName: 'Content Type',
name: 'contentType',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'update',
],
},
},
description: 'Name of the content type',
},
{
displayName: 'Update Key',
name: 'updateKey',
type: 'string',
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'update',
],
},
},
default: 'id',
required: true,
// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-id
description: 'Name of the property which decides which rows in the database should be updated. Normally that would be "id".',
},
{
displayName: 'Columns',
name: 'columns',
type: 'string',
displayOptions: {
show: {
resource: [
'entry',
],
operation: [
'update',
],
},
},
default: '',
placeholder: 'id,name,description',
refactor: Apply `eslint-plugin-n8n-nodes-base` autofixable rules (#3174) * :zap: Initial setup * :shirt: Update `.eslintignore` * :shirt: Autofix node-param-default-missing (#3173) * :fire: Remove duplicate key * :shirt: Add exceptions * :package: Update package-lock.json * :shirt: Apply `node-class-description-inputs-wrong-trigger-node` (#3176) * :shirt: Apply `node-class-description-inputs-wrong-regular-node` (#3177) * :shirt: Apply `node-class-description-outputs-wrong` (#3178) * :shirt: Apply `node-execute-block-double-assertion-for-items` (#3179) * :shirt: Apply `node-param-default-wrong-for-collection` (#3180) * :shirt: Apply node-param-default-wrong-for-boolean (#3181) * Autofixed default missing * Autofixed booleans, worked well * :zap: Fix params * :rewind: Undo exempted autofixes * :package: Update package-lock.json * :shirt: Apply node-class-description-missing-subtitle (#3182) * :zap: Fix missing comma * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3184) * :shirt: Add exception for `node-class-description-missing-subtitle` * :shirt: Apply `node-param-default-wrong-for-multi-options` (#3185) * :shirt: Apply `node-param-collection-type-unsorted-items` (#3186) * Missing coma * :shirt: Apply `node-param-default-wrong-for-simplify` (#3187) * :shirt: Apply `node-param-description-comma-separated-hyphen` (#3190) * :shirt: Apply `node-param-description-empty-string` (#3189) * :shirt: Apply `node-param-description-excess-inner-whitespace` (#3191) * Rule looks good * Add whitespace rule in eslint config * :zao: fix * :shirt: Apply `node-param-description-identical-to-display-name` (#3193) * :shirt: Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195) * :rewind: Revert ":zao: fix" This reverts commit ef8a76f3dfedffd1bdccf3178af8a8d90cf5a55c. * :shirt: Apply `node-param-description-missing-for-simplify` (#3196) * :shirt: Apply `node-param-description-missing-final-period` (#3194) * Rule working as intended * Add rule to eslint * :shirt: Apply node-param-description-missing-for-return-all (#3197) * :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: agobrech <ael.gobrecht@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 09:29:51 -07:00
description: 'Comma-separated list of the properties which should used as columns for the new rows',
},
];