Fix unauthorized error handling (#6835)
from @BOHEUS comments in #6640 - fix bad 500 error when authentication invalid - remove "id", "createdAt", "updatedAt", etc from creation and update paths schema - improve error message - remove "id" from test body - improve secondaryLink schema description - improve depth parameter description - remove required from response body - improve examples - improve error message formatting - fix filter by position - answered to negative float position @BOHEUS comment Also: - fix secondary field openapi field description - remove schema display in playground Screenshots  
This commit is contained in:
martmull
@ -22,7 +22,10 @@ import {
|
||||
computeManyResultPath,
|
||||
computeSingleResultPath,
|
||||
} from 'src/engine/core-modules/open-api/utils/path.utils';
|
||||
import { getRequestBody } from 'src/engine/core-modules/open-api/utils/request-body.utils';
|
||||
import {
|
||||
getRequestBody,
|
||||
getUpdateRequestBody,
|
||||
} from 'src/engine/core-modules/open-api/utils/request-body.utils';
|
||||
import {
|
||||
getCreateOneResponse201,
|
||||
getDeleteResponse200,
|
||||
@ -165,7 +168,7 @@ export class OpenApiService {
|
||||
summary: `Find One ${item.nameSingular}`,
|
||||
parameters: [{ $ref: '#/components/parameters/idPath' }],
|
||||
responses: {
|
||||
'200': getFindOneResponse200(item, true),
|
||||
'200': getFindOneResponse200(item),
|
||||
'400': { $ref: '#/components/responses/400' },
|
||||
'401': { $ref: '#/components/responses/401' },
|
||||
},
|
||||
@ -187,7 +190,7 @@ export class OpenApiService {
|
||||
summary: `Update One ${item.nameSingular}`,
|
||||
operationId: `updateOne${capitalize(item.nameSingular)}`,
|
||||
parameters: [{ $ref: '#/components/parameters/idPath' }],
|
||||
requestBody: getRequestBody(capitalize(item.nameSingular)),
|
||||
requestBody: getUpdateRequestBody(capitalize(item.nameSingular)),
|
||||
responses: {
|
||||
'200': getUpdateOneResponse200(item, true),
|
||||
'400': { $ref: '#/components/responses/400' },
|
||||
|
||||
@ -22,9 +22,6 @@ describe('computeSchemaComponents', () => {
|
||||
).toEqual({
|
||||
ObjectName: {
|
||||
type: 'object',
|
||||
description: undefined,
|
||||
required: ['fieldNumber'],
|
||||
example: { fieldNumber: '' },
|
||||
properties: {
|
||||
fieldUuid: {
|
||||
type: 'string',
|
||||
@ -40,9 +37,20 @@ describe('computeSchemaComponents', () => {
|
||||
type: 'string',
|
||||
format: 'email',
|
||||
},
|
||||
fieldEmails: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
primaryEmail: {
|
||||
type: 'string',
|
||||
},
|
||||
additionalEmails: {
|
||||
type: 'object',
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldDateTime: {
|
||||
type: 'string',
|
||||
format: 'date',
|
||||
format: 'date-time',
|
||||
},
|
||||
fieldDate: {
|
||||
type: 'string',
|
||||
@ -58,21 +66,44 @@ describe('computeSchemaComponents', () => {
|
||||
type: 'number',
|
||||
},
|
||||
fieldLinks: {
|
||||
properties: {
|
||||
primaryLinkLabel: { type: 'string' },
|
||||
primaryLinkUrl: { type: 'string' },
|
||||
secondaryLinks: { type: 'object' },
|
||||
},
|
||||
type: 'object',
|
||||
properties: {
|
||||
primaryLinkLabel: {
|
||||
type: 'string',
|
||||
},
|
||||
primaryLinkUrl: {
|
||||
type: 'string',
|
||||
},
|
||||
secondaryLinks: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'object',
|
||||
description: 'A secondary link',
|
||||
properties: {
|
||||
url: {
|
||||
type: 'string',
|
||||
},
|
||||
label: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldCurrency: {
|
||||
properties: {
|
||||
amountMicros: { type: 'number' },
|
||||
currencyCode: { type: 'string' },
|
||||
},
|
||||
type: 'object',
|
||||
properties: {
|
||||
amountMicros: {
|
||||
type: 'number',
|
||||
},
|
||||
currencyCode: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldFullName: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
firstName: {
|
||||
type: 'string',
|
||||
@ -81,10 +112,10 @@ describe('computeSchemaComponents', () => {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
type: 'object',
|
||||
},
|
||||
fieldRating: {
|
||||
type: 'number',
|
||||
type: 'string',
|
||||
enum: ['RATING_1', 'RATING_2'],
|
||||
},
|
||||
fieldSelect: {
|
||||
type: 'string',
|
||||
@ -98,10 +129,23 @@ describe('computeSchemaComponents', () => {
|
||||
type: 'number',
|
||||
},
|
||||
fieldAddress: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
addressStreet1: {
|
||||
type: 'string',
|
||||
},
|
||||
addressStreet2: {
|
||||
type: 'string',
|
||||
},
|
||||
addressCity: {
|
||||
type: 'string',
|
||||
},
|
||||
addressPostcode: {
|
||||
type: 'string',
|
||||
},
|
||||
addressState: {
|
||||
type: 'string',
|
||||
},
|
||||
addressCountry: {
|
||||
type: 'string',
|
||||
},
|
||||
@ -111,20 +155,7 @@ describe('computeSchemaComponents', () => {
|
||||
addressLng: {
|
||||
type: 'number',
|
||||
},
|
||||
addressPostcode: {
|
||||
type: 'string',
|
||||
},
|
||||
addressState: {
|
||||
type: 'string',
|
||||
},
|
||||
addressStreet1: {
|
||||
type: 'string',
|
||||
},
|
||||
addressStreet2: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
type: 'object',
|
||||
},
|
||||
fieldRawJson: {
|
||||
type: 'object',
|
||||
@ -133,9 +164,341 @@ describe('computeSchemaComponents', () => {
|
||||
type: 'string',
|
||||
},
|
||||
fieldActor: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
source: {
|
||||
type: 'string',
|
||||
enum: [
|
||||
'EMAIL',
|
||||
'CALENDAR',
|
||||
'WORKFLOW',
|
||||
'API',
|
||||
'IMPORT',
|
||||
'MANUAL',
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
required: ['fieldNumber'],
|
||||
},
|
||||
'ObjectName for Update': {
|
||||
type: 'object',
|
||||
properties: {
|
||||
fieldUuid: {
|
||||
type: 'string',
|
||||
format: 'uuid',
|
||||
},
|
||||
fieldText: {
|
||||
type: 'string',
|
||||
},
|
||||
fieldPhone: {
|
||||
type: 'string',
|
||||
},
|
||||
fieldEmail: {
|
||||
type: 'string',
|
||||
format: 'email',
|
||||
},
|
||||
fieldEmails: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
primaryEmail: {
|
||||
type: 'string',
|
||||
},
|
||||
additionalEmails: {
|
||||
type: 'object',
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldDateTime: {
|
||||
type: 'string',
|
||||
format: 'date-time',
|
||||
},
|
||||
fieldDate: {
|
||||
type: 'string',
|
||||
format: 'date',
|
||||
},
|
||||
fieldBoolean: {
|
||||
type: 'boolean',
|
||||
},
|
||||
fieldNumber: {
|
||||
type: 'integer',
|
||||
},
|
||||
fieldNumeric: {
|
||||
type: 'number',
|
||||
},
|
||||
fieldLinks: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
primaryLinkLabel: {
|
||||
type: 'string',
|
||||
},
|
||||
primaryLinkUrl: {
|
||||
type: 'string',
|
||||
},
|
||||
secondaryLinks: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'object',
|
||||
description: 'A secondary link',
|
||||
properties: {
|
||||
url: {
|
||||
type: 'string',
|
||||
},
|
||||
label: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldCurrency: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
amountMicros: {
|
||||
type: 'number',
|
||||
},
|
||||
currencyCode: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldFullName: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
firstName: {
|
||||
type: 'string',
|
||||
},
|
||||
lastName: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldRating: {
|
||||
type: 'string',
|
||||
enum: ['RATING_1', 'RATING_2'],
|
||||
},
|
||||
fieldSelect: {
|
||||
type: 'string',
|
||||
enum: ['OPTION_1', 'OPTION_2'],
|
||||
},
|
||||
fieldMultiSelect: {
|
||||
type: 'string',
|
||||
enum: ['OPTION_1', 'OPTION_2'],
|
||||
},
|
||||
fieldPosition: {
|
||||
type: 'number',
|
||||
},
|
||||
fieldAddress: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
addressStreet1: {
|
||||
type: 'string',
|
||||
},
|
||||
addressStreet2: {
|
||||
type: 'string',
|
||||
},
|
||||
addressCity: {
|
||||
type: 'string',
|
||||
},
|
||||
addressPostcode: {
|
||||
type: 'string',
|
||||
},
|
||||
addressState: {
|
||||
type: 'string',
|
||||
},
|
||||
addressCountry: {
|
||||
type: 'string',
|
||||
},
|
||||
addressLat: {
|
||||
type: 'number',
|
||||
},
|
||||
addressLng: {
|
||||
type: 'number',
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldRawJson: {
|
||||
type: 'object',
|
||||
},
|
||||
fieldRichText: {
|
||||
type: 'string',
|
||||
},
|
||||
fieldActor: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
source: {
|
||||
type: 'string',
|
||||
enum: [
|
||||
'EMAIL',
|
||||
'CALENDAR',
|
||||
'WORKFLOW',
|
||||
'API',
|
||||
'IMPORT',
|
||||
'MANUAL',
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
'ObjectName for Response': {
|
||||
type: 'object',
|
||||
properties: {
|
||||
fieldUuid: {
|
||||
type: 'string',
|
||||
format: 'uuid',
|
||||
},
|
||||
fieldText: {
|
||||
type: 'string',
|
||||
},
|
||||
fieldPhone: {
|
||||
type: 'string',
|
||||
},
|
||||
fieldEmail: {
|
||||
type: 'string',
|
||||
format: 'email',
|
||||
},
|
||||
fieldEmails: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
primaryEmail: {
|
||||
type: 'string',
|
||||
},
|
||||
additionalEmails: {
|
||||
type: 'object',
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldDateTime: {
|
||||
type: 'string',
|
||||
format: 'date-time',
|
||||
},
|
||||
fieldDate: {
|
||||
type: 'string',
|
||||
format: 'date',
|
||||
},
|
||||
fieldBoolean: {
|
||||
type: 'boolean',
|
||||
},
|
||||
fieldNumber: {
|
||||
type: 'integer',
|
||||
},
|
||||
fieldNumeric: {
|
||||
type: 'number',
|
||||
},
|
||||
fieldLinks: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
primaryLinkLabel: {
|
||||
type: 'string',
|
||||
},
|
||||
primaryLinkUrl: {
|
||||
type: 'string',
|
||||
},
|
||||
secondaryLinks: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'object',
|
||||
description: 'A secondary link',
|
||||
properties: {
|
||||
url: {
|
||||
type: 'string',
|
||||
},
|
||||
label: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldCurrency: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
amountMicros: {
|
||||
type: 'number',
|
||||
},
|
||||
currencyCode: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldFullName: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
firstName: {
|
||||
type: 'string',
|
||||
},
|
||||
lastName: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldRating: {
|
||||
type: 'string',
|
||||
enum: ['RATING_1', 'RATING_2'],
|
||||
},
|
||||
fieldSelect: {
|
||||
type: 'string',
|
||||
enum: ['OPTION_1', 'OPTION_2'],
|
||||
},
|
||||
fieldMultiSelect: {
|
||||
type: 'string',
|
||||
enum: ['OPTION_1', 'OPTION_2'],
|
||||
},
|
||||
fieldPosition: {
|
||||
type: 'number',
|
||||
},
|
||||
fieldAddress: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
addressStreet1: {
|
||||
type: 'string',
|
||||
},
|
||||
addressStreet2: {
|
||||
type: 'string',
|
||||
},
|
||||
addressCity: {
|
||||
type: 'string',
|
||||
},
|
||||
addressPostcode: {
|
||||
type: 'string',
|
||||
},
|
||||
addressState: {
|
||||
type: 'string',
|
||||
},
|
||||
addressCountry: {
|
||||
type: 'string',
|
||||
},
|
||||
addressLat: {
|
||||
type: 'number',
|
||||
},
|
||||
addressLng: {
|
||||
type: 'number',
|
||||
},
|
||||
},
|
||||
},
|
||||
fieldRawJson: {
|
||||
type: 'object',
|
||||
},
|
||||
fieldRichText: {
|
||||
type: 'string',
|
||||
},
|
||||
fieldActor: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
source: {
|
||||
type: 'string',
|
||||
enum: [
|
||||
'EMAIL',
|
||||
'CALENDAR',
|
||||
'WORKFLOW',
|
||||
'API',
|
||||
'IMPORT',
|
||||
'MANUAL',
|
||||
],
|
||||
},
|
||||
workspaceMemberId: {
|
||||
type: 'string',
|
||||
@ -145,44 +508,15 @@ describe('computeSchemaComponents', () => {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
type: 'object',
|
||||
},
|
||||
fieldEmails: {
|
||||
properties: {
|
||||
primaryEmail: {
|
||||
type: 'string',
|
||||
},
|
||||
additionalEmails: {
|
||||
type: 'object',
|
||||
},
|
||||
fieldRelation: {
|
||||
type: 'array',
|
||||
items: {
|
||||
$ref: '#/components/schemas/ToObjectMetadataName for Response',
|
||||
},
|
||||
type: 'object',
|
||||
},
|
||||
},
|
||||
},
|
||||
'ObjectName with Relations': {
|
||||
allOf: [
|
||||
{
|
||||
$ref: '#/components/schemas/ObjectName',
|
||||
},
|
||||
{
|
||||
properties: {
|
||||
fieldRelation: {
|
||||
type: 'array',
|
||||
items: {
|
||||
$ref: '#/components/schemas/ToObjectMetadataName',
|
||||
},
|
||||
},
|
||||
},
|
||||
type: 'object',
|
||||
},
|
||||
],
|
||||
description: undefined,
|
||||
example: {
|
||||
fieldNumber: '',
|
||||
},
|
||||
required: ['fieldNumber'],
|
||||
},
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@ -64,7 +64,10 @@ describe('computeParameters', () => {
|
||||
expect(computeDepthParameters()).toEqual({
|
||||
name: 'depth',
|
||||
in: 'query',
|
||||
description: 'Limits the depth objects returned.',
|
||||
description: `Determines the level of nested related objects to include in the response.
|
||||
- 0: Returns only the primary object's information.
|
||||
- 1: Returns the primary object along with its directly related objects (with no additional nesting for related objects).
|
||||
- 2: Returns the primary object, its directly related objects, and the related objects of those related objects.`,
|
||||
required: false,
|
||||
schema: {
|
||||
type: 'integer',
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
import { OpenAPIV3_1 } from 'openapi-types';
|
||||
|
||||
import { FieldMetadataOptions } from 'src/engine/metadata-modules/field-metadata/interfaces/field-metadata-options.interface';
|
||||
|
||||
import {
|
||||
computeDepthParameters,
|
||||
computeEndingBeforeParameters,
|
||||
@ -10,9 +12,13 @@ import {
|
||||
computeStartingAfterParameters,
|
||||
} from 'src/engine/core-modules/open-api/utils/parameters.utils';
|
||||
import { compositeTypeDefinitions } from 'src/engine/metadata-modules/field-metadata/composite-types';
|
||||
import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
|
||||
import {
|
||||
FieldMetadataEntity,
|
||||
FieldMetadataType,
|
||||
} from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
|
||||
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
|
||||
import { capitalize } from 'src/utils/capitalize';
|
||||
import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
|
||||
|
||||
type Property = OpenAPIV3_1.SchemaObject;
|
||||
|
||||
@ -20,8 +26,33 @@ type Properties = {
|
||||
[name: string]: Property;
|
||||
};
|
||||
|
||||
const getFieldProperties = (type: FieldMetadataType): Property => {
|
||||
const isFieldAvailable = (field: FieldMetadataEntity, forResponse: boolean) => {
|
||||
if (forResponse) {
|
||||
return true;
|
||||
}
|
||||
switch (field.name) {
|
||||
case 'id':
|
||||
case 'createdAt':
|
||||
case 'updatedAt':
|
||||
case 'deletedAt':
|
||||
return false;
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
};
|
||||
|
||||
const getFieldProperties = (
|
||||
type: FieldMetadataType,
|
||||
propertyName?: string,
|
||||
options?: FieldMetadataOptions,
|
||||
): Property => {
|
||||
switch (type) {
|
||||
case FieldMetadataType.SELECT:
|
||||
case FieldMetadataType.MULTI_SELECT:
|
||||
return {
|
||||
type: 'string',
|
||||
enum: options?.map((option: { value: string }) => option.value),
|
||||
};
|
||||
case FieldMetadataType.UUID:
|
||||
return { type: 'string', format: 'uuid' };
|
||||
case FieldMetadataType.TEXT:
|
||||
@ -31,28 +62,55 @@ const getFieldProperties = (type: FieldMetadataType): Property => {
|
||||
case FieldMetadataType.EMAIL:
|
||||
return { type: 'string', format: 'email' };
|
||||
case FieldMetadataType.DATE_TIME:
|
||||
return { type: 'string', format: 'date-time' };
|
||||
case FieldMetadataType.DATE:
|
||||
return { type: 'string', format: 'date' };
|
||||
case FieldMetadataType.NUMBER:
|
||||
return { type: 'integer' };
|
||||
case FieldMetadataType.NUMERIC:
|
||||
case FieldMetadataType.RATING:
|
||||
return {
|
||||
type: 'string',
|
||||
enum: options?.map((option: { value: string }) => option.value),
|
||||
};
|
||||
case FieldMetadataType.NUMERIC:
|
||||
case FieldMetadataType.POSITION:
|
||||
return { type: 'number' };
|
||||
case FieldMetadataType.BOOLEAN:
|
||||
return { type: 'boolean' };
|
||||
case FieldMetadataType.RAW_JSON:
|
||||
if (propertyName === 'secondaryLinks') {
|
||||
return {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'object',
|
||||
description: `A secondary link`,
|
||||
properties: {
|
||||
url: { type: 'string' },
|
||||
label: { type: 'string' },
|
||||
},
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
return { type: 'object' };
|
||||
|
||||
default:
|
||||
return { type: 'string' };
|
||||
}
|
||||
};
|
||||
|
||||
const getSchemaComponentsProperties = (
|
||||
item: ObjectMetadataEntity,
|
||||
): Properties => {
|
||||
const getSchemaComponentsProperties = ({
|
||||
item,
|
||||
forResponse,
|
||||
}: {
|
||||
item: ObjectMetadataEntity;
|
||||
forResponse: boolean;
|
||||
}): Properties => {
|
||||
return item.fields.reduce((node, field) => {
|
||||
if (field.type == FieldMetadataType.RELATION) {
|
||||
if (
|
||||
!isFieldAvailable(field, forResponse) ||
|
||||
field.type === FieldMetadataType.RELATION
|
||||
) {
|
||||
return node;
|
||||
}
|
||||
|
||||
@ -66,6 +124,12 @@ const getSchemaComponentsProperties = (
|
||||
enum: field.options.map((option: { value: string }) => option.value),
|
||||
};
|
||||
break;
|
||||
case FieldMetadataType.RATING:
|
||||
itemProperty = {
|
||||
type: 'string',
|
||||
enum: field.options.map((option: { value: string }) => option.value),
|
||||
};
|
||||
break;
|
||||
case FieldMetadataType.LINK:
|
||||
case FieldMetadataType.LINKS:
|
||||
case FieldMetadataType.CURRENCY:
|
||||
@ -78,7 +142,18 @@ const getSchemaComponentsProperties = (
|
||||
properties: compositeTypeDefinitions
|
||||
.get(field.type)
|
||||
?.properties?.reduce((properties, property) => {
|
||||
properties[property.name] = getFieldProperties(property.type);
|
||||
if (
|
||||
property.hidden === true ||
|
||||
(property.hidden === 'input' && !forResponse) ||
|
||||
(property.hidden === 'output' && forResponse)
|
||||
) {
|
||||
return properties;
|
||||
}
|
||||
properties[property.name] = getFieldProperties(
|
||||
property.type,
|
||||
property.name,
|
||||
property.options,
|
||||
);
|
||||
|
||||
return properties;
|
||||
}, {} as Properties),
|
||||
@ -105,19 +180,21 @@ const getSchemaComponentsRelationProperties = (
|
||||
item: ObjectMetadataEntity,
|
||||
): Properties => {
|
||||
return item.fields.reduce((node, field) => {
|
||||
if (field.type !== FieldMetadataType.RELATION) {
|
||||
return node;
|
||||
}
|
||||
|
||||
let itemProperty = {} as Property;
|
||||
|
||||
if (field.type == FieldMetadataType.RELATION) {
|
||||
if (field.fromRelationMetadata?.toObjectMetadata.nameSingular) {
|
||||
itemProperty = {
|
||||
type: 'array',
|
||||
items: {
|
||||
$ref: `#/components/schemas/${capitalize(
|
||||
field.fromRelationMetadata?.toObjectMetadata.nameSingular || '',
|
||||
)}`,
|
||||
},
|
||||
};
|
||||
}
|
||||
if (field.fromRelationMetadata?.toObjectMetadata.nameSingular) {
|
||||
itemProperty = {
|
||||
type: 'array',
|
||||
items: {
|
||||
$ref: `#/components/schemas/${capitalize(
|
||||
field.fromRelationMetadata?.toObjectMetadata.nameSingular,
|
||||
)} for Response`,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
if (field.description) {
|
||||
@ -144,62 +221,38 @@ const getRequiredFields = (item: ObjectMetadataEntity): string[] => {
|
||||
}, [] as string[]);
|
||||
};
|
||||
|
||||
const computeSchemaComponent = (
|
||||
item: ObjectMetadataEntity,
|
||||
): OpenAPIV3_1.SchemaObject => {
|
||||
const computeSchemaComponent = ({
|
||||
item,
|
||||
withRequiredFields,
|
||||
forResponse,
|
||||
withRelations,
|
||||
}: {
|
||||
item: ObjectMetadataEntity;
|
||||
withRequiredFields: boolean;
|
||||
forResponse: boolean;
|
||||
withRelations: boolean;
|
||||
}): OpenAPIV3_1.SchemaObject => {
|
||||
const result = {
|
||||
type: 'object',
|
||||
description: item.description,
|
||||
properties: getSchemaComponentsProperties(item),
|
||||
example: {},
|
||||
properties: getSchemaComponentsProperties({ item, forResponse }),
|
||||
} as OpenAPIV3_1.SchemaObject;
|
||||
|
||||
const requiredFields = getRequiredFields(item);
|
||||
|
||||
if (requiredFields?.length) {
|
||||
result.required = requiredFields;
|
||||
result.example = requiredFields.reduce(
|
||||
(example, requiredField) => {
|
||||
example[requiredField] = '';
|
||||
|
||||
return example;
|
||||
},
|
||||
{} as Record<string, string>,
|
||||
);
|
||||
if (withRelations) {
|
||||
result.properties = {
|
||||
...result.properties,
|
||||
...getSchemaComponentsRelationProperties(item),
|
||||
};
|
||||
}
|
||||
|
||||
return result;
|
||||
};
|
||||
|
||||
const computeRelationSchemaComponent = (
|
||||
item: ObjectMetadataEntity,
|
||||
): OpenAPIV3_1.SchemaObject => {
|
||||
const result = {
|
||||
description: item.description,
|
||||
allOf: [
|
||||
{
|
||||
$ref: `#/components/schemas/${capitalize(item.nameSingular)}`,
|
||||
},
|
||||
{
|
||||
type: 'object',
|
||||
properties: getSchemaComponentsRelationProperties(item),
|
||||
},
|
||||
],
|
||||
example: {},
|
||||
} as OpenAPIV3_1.SchemaObject;
|
||||
if (!withRequiredFields) {
|
||||
return result;
|
||||
}
|
||||
|
||||
const requiredFields = getRequiredFields(item);
|
||||
|
||||
if (requiredFields?.length) {
|
||||
result.required = requiredFields;
|
||||
result.example = requiredFields.reduce(
|
||||
(example, requiredField) => {
|
||||
example[requiredField] = '';
|
||||
|
||||
return example;
|
||||
},
|
||||
{} as Record<string, string>,
|
||||
);
|
||||
}
|
||||
|
||||
return result;
|
||||
@ -210,9 +263,26 @@ export const computeSchemaComponents = (
|
||||
): Record<string, OpenAPIV3_1.SchemaObject> => {
|
||||
return objectMetadataItems.reduce(
|
||||
(schemas, item) => {
|
||||
schemas[capitalize(item.nameSingular)] = computeSchemaComponent(item);
|
||||
schemas[capitalize(item.nameSingular) + ' with Relations'] =
|
||||
computeRelationSchemaComponent(item);
|
||||
schemas[capitalize(item.nameSingular)] = computeSchemaComponent({
|
||||
item,
|
||||
withRequiredFields: true,
|
||||
forResponse: false,
|
||||
withRelations: false,
|
||||
});
|
||||
schemas[capitalize(item.nameSingular) + ' for Update'] =
|
||||
computeSchemaComponent({
|
||||
item,
|
||||
withRequiredFields: false,
|
||||
forResponse: false,
|
||||
withRelations: false,
|
||||
});
|
||||
schemas[capitalize(item.nameSingular) + ' for Response'] =
|
||||
computeSchemaComponent({
|
||||
item,
|
||||
withRequiredFields: false,
|
||||
forResponse: true,
|
||||
withRelations: true,
|
||||
});
|
||||
|
||||
return schemas;
|
||||
},
|
||||
@ -245,21 +315,47 @@ export const computeMetadataSchemaComponents = (
|
||||
type: 'object',
|
||||
description: `An object`,
|
||||
properties: {
|
||||
dataSourceId: { type: 'string' },
|
||||
nameSingular: { type: 'string' },
|
||||
namePlural: { type: 'string' },
|
||||
labelSingular: { type: 'string' },
|
||||
labelPlural: { type: 'string' },
|
||||
description: { type: 'string' },
|
||||
icon: { type: 'string' },
|
||||
labelIdentifierFieldMetadataId: {
|
||||
type: 'string',
|
||||
format: 'uuid',
|
||||
},
|
||||
imageIdentifierFieldMetadataId: {
|
||||
type: 'string',
|
||||
format: 'uuid',
|
||||
},
|
||||
},
|
||||
};
|
||||
schemas[`${capitalize(item.namePlural)}`] = {
|
||||
type: 'array',
|
||||
description: `A list of ${item.namePlural}`,
|
||||
items: {
|
||||
$ref: `#/components/schemas/${capitalize(item.nameSingular)}`,
|
||||
},
|
||||
};
|
||||
schemas[`${capitalize(item.nameSingular)} for Update`] = {
|
||||
type: 'object',
|
||||
description: `An object`,
|
||||
properties: {
|
||||
isActive: { type: 'boolean' },
|
||||
},
|
||||
};
|
||||
schemas[`${capitalize(item.nameSingular)} for Response`] = {
|
||||
...schemas[`${capitalize(item.nameSingular)}`],
|
||||
properties: {
|
||||
...schemas[`${capitalize(item.nameSingular)}`].properties,
|
||||
id: { type: 'string', format: 'uuid' },
|
||||
dataSourceId: { type: 'string', format: 'uuid' },
|
||||
isCustom: { type: 'boolean' },
|
||||
isRemote: { type: 'boolean' },
|
||||
isActive: { type: 'boolean' },
|
||||
isSystem: { type: 'boolean' },
|
||||
createdAt: { type: 'string' },
|
||||
updatedAt: { type: 'string' },
|
||||
labelIdentifierFieldMetadataId: { type: 'string' },
|
||||
imageIdentifierFieldMetadataId: { type: 'string' },
|
||||
createdAt: { type: 'string', format: 'date-time' },
|
||||
updatedAt: { type: 'string', format: 'date-time' },
|
||||
fields: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
@ -269,7 +365,7 @@ export const computeMetadataSchemaComponents = (
|
||||
node: {
|
||||
type: 'array',
|
||||
items: {
|
||||
$ref: '#/components/schemas/Field',
|
||||
$ref: '#/components/schemas/Field for Response',
|
||||
},
|
||||
},
|
||||
},
|
||||
@ -277,15 +373,13 @@ export const computeMetadataSchemaComponents = (
|
||||
},
|
||||
},
|
||||
},
|
||||
example: {},
|
||||
};
|
||||
schemas[`${capitalize(item.namePlural)}`] = {
|
||||
schemas[`${capitalize(item.namePlural)} for Response`] = {
|
||||
type: 'array',
|
||||
description: `A list of ${item.namePlural}`,
|
||||
items: {
|
||||
$ref: `#/components/schemas/${capitalize(item.nameSingular)}`,
|
||||
$ref: `#/components/schemas/${capitalize(item.nameSingular)} for Response`,
|
||||
},
|
||||
example: [{}],
|
||||
};
|
||||
|
||||
return schemas;
|
||||
@ -295,57 +389,17 @@ export const computeMetadataSchemaComponents = (
|
||||
type: 'object',
|
||||
description: `A field`,
|
||||
properties: {
|
||||
type: { type: 'string' },
|
||||
type: {
|
||||
type: 'string',
|
||||
enum: Object.keys(FieldMetadataType),
|
||||
},
|
||||
name: { type: 'string' },
|
||||
label: { type: 'string' },
|
||||
description: { type: 'string' },
|
||||
icon: { type: 'string' },
|
||||
isCustom: { type: 'boolean' },
|
||||
isActive: { type: 'boolean' },
|
||||
isSystem: { type: 'boolean' },
|
||||
isNullable: { type: 'boolean' },
|
||||
createdAt: { type: 'string' },
|
||||
updatedAt: { type: 'string' },
|
||||
fromRelationMetadata: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'string' },
|
||||
relationType: { type: 'string' },
|
||||
toObjectMetadata: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'string' },
|
||||
dataSourceId: { type: 'string' },
|
||||
nameSingular: { type: 'string' },
|
||||
namePlural: { type: 'string' },
|
||||
isSystem: { type: 'boolean' },
|
||||
},
|
||||
},
|
||||
toFieldMetadataId: { type: 'string' },
|
||||
},
|
||||
},
|
||||
toRelationMetadata: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'string' },
|
||||
relationType: { type: 'string' },
|
||||
fromObjectMetadata: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'string' },
|
||||
dataSourceId: { type: 'string' },
|
||||
nameSingular: { type: 'string' },
|
||||
namePlural: { type: 'string' },
|
||||
isSystem: { type: 'boolean' },
|
||||
},
|
||||
},
|
||||
fromFieldMetadataId: { type: 'string' },
|
||||
},
|
||||
},
|
||||
defaultValue: { type: 'object' },
|
||||
options: { type: 'object' },
|
||||
objectMetadataId: { type: 'string', format: 'uuid' },
|
||||
},
|
||||
example: {},
|
||||
};
|
||||
schemas[`${capitalize(item.namePlural)}`] = {
|
||||
type: 'array',
|
||||
@ -353,7 +407,93 @@ export const computeMetadataSchemaComponents = (
|
||||
items: {
|
||||
$ref: `#/components/schemas/${capitalize(item.nameSingular)}`,
|
||||
},
|
||||
example: [{}],
|
||||
};
|
||||
schemas[`${capitalize(item.nameSingular)} for Update`] = {
|
||||
type: 'object',
|
||||
description: `An object`,
|
||||
properties: {
|
||||
description: { type: 'string' },
|
||||
icon: { type: 'string' },
|
||||
isActive: { type: 'boolean' },
|
||||
isCustom: { type: 'boolean' },
|
||||
isNullable: { type: 'boolean' },
|
||||
isSystem: { type: 'boolean' },
|
||||
label: { type: 'string' },
|
||||
name: { type: 'string' },
|
||||
},
|
||||
};
|
||||
schemas[`${capitalize(item.nameSingular)} for Response`] = {
|
||||
...schemas[`${capitalize(item.nameSingular)}`],
|
||||
properties: {
|
||||
type: {
|
||||
type: 'string',
|
||||
enum: Object.keys(FieldMetadataType),
|
||||
},
|
||||
name: { type: 'string' },
|
||||
label: { type: 'string' },
|
||||
description: { type: 'string' },
|
||||
icon: { type: 'string' },
|
||||
isNullable: { type: 'boolean' },
|
||||
id: { type: 'string', format: 'uuid' },
|
||||
isCustom: { type: 'boolean' },
|
||||
isActive: { type: 'boolean' },
|
||||
isSystem: { type: 'boolean' },
|
||||
defaultValue: { type: 'object' },
|
||||
options: { type: 'object' },
|
||||
createdAt: { type: 'string', format: 'date-time' },
|
||||
updatedAt: { type: 'string', format: 'date-time' },
|
||||
fromRelationMetadata: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'string', format: 'uuid' },
|
||||
relationType: {
|
||||
type: 'string',
|
||||
enum: Object.keys(RelationMetadataType),
|
||||
},
|
||||
toObjectMetadata: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'string', format: 'uuid' },
|
||||
dataSourceId: { type: 'string', format: 'uuid' },
|
||||
nameSingular: { type: 'string' },
|
||||
namePlural: { type: 'string' },
|
||||
isSystem: { type: 'boolean' },
|
||||
isRemote: { type: 'boolean' },
|
||||
},
|
||||
},
|
||||
toFieldMetadataId: { type: 'string', format: 'uuid' },
|
||||
},
|
||||
},
|
||||
toRelationMetadata: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'string', format: 'uuid' },
|
||||
relationType: {
|
||||
type: 'string',
|
||||
enum: Object.keys(RelationMetadataType),
|
||||
},
|
||||
fromObjectMetadata: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'string', format: 'uuid' },
|
||||
dataSourceId: { type: 'string', format: 'uuid' },
|
||||
nameSingular: { type: 'string' },
|
||||
namePlural: { type: 'string' },
|
||||
isSystem: { type: 'boolean' },
|
||||
isRemote: { type: 'boolean' },
|
||||
},
|
||||
},
|
||||
fromFieldMetadataId: { type: 'string', format: 'uuid' },
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
schemas[`${capitalize(item.namePlural)} for Response`] = {
|
||||
type: 'array',
|
||||
description: `A list of ${item.namePlural}`,
|
||||
items: {
|
||||
$ref: `#/components/schemas/${capitalize(item.nameSingular)} for Response`,
|
||||
},
|
||||
};
|
||||
|
||||
return schemas;
|
||||
@ -363,33 +503,17 @@ export const computeMetadataSchemaComponents = (
|
||||
type: 'object',
|
||||
description: 'A relation',
|
||||
properties: {
|
||||
relationType: { type: 'string' },
|
||||
fromObjectMetadata: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'string' },
|
||||
dataSourceId: { type: 'string' },
|
||||
nameSingular: { type: 'string' },
|
||||
namePlural: { type: 'string' },
|
||||
isSystem: { type: 'boolean' },
|
||||
},
|
||||
relationType: {
|
||||
type: 'string',
|
||||
enum: Object.keys(RelationMetadataType),
|
||||
},
|
||||
fromObjectMetadataId: { type: 'string' },
|
||||
toObjectMetadata: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'string' },
|
||||
dataSourceId: { type: 'string' },
|
||||
nameSingular: { type: 'string' },
|
||||
namePlural: { type: 'string' },
|
||||
isSystem: { type: 'boolean' },
|
||||
},
|
||||
},
|
||||
toObjectMetadataId: { type: 'string' },
|
||||
fromFieldMetadataId: { type: 'string' },
|
||||
toFieldMetadataId: { type: 'string' },
|
||||
fromObjectMetadataId: { type: 'string', format: 'uuid' },
|
||||
toObjectMetadataId: { type: 'string', format: 'uuid' },
|
||||
fromName: { type: 'string' },
|
||||
fromLabel: { type: 'string' },
|
||||
toName: { type: 'string' },
|
||||
toLabel: { type: 'string' },
|
||||
},
|
||||
example: {},
|
||||
};
|
||||
schemas[`${capitalize(item.namePlural)}`] = {
|
||||
type: 'array',
|
||||
@ -397,7 +521,47 @@ export const computeMetadataSchemaComponents = (
|
||||
items: {
|
||||
$ref: `#/components/schemas/${capitalize(item.nameSingular)}`,
|
||||
},
|
||||
example: [{}],
|
||||
};
|
||||
schemas[`${capitalize(item.nameSingular)} for Response`] = {
|
||||
...schemas[`${capitalize(item.nameSingular)}`],
|
||||
properties: {
|
||||
relationType: {
|
||||
type: 'string',
|
||||
enum: Object.keys(RelationMetadataType),
|
||||
},
|
||||
id: { type: 'string', format: 'uuid' },
|
||||
fromFieldMetadataId: { type: 'string', format: 'uuid' },
|
||||
toFieldMetadataId: { type: 'string', format: 'uuid' },
|
||||
fromObjectMetadata: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'string', format: 'uuid' },
|
||||
dataSourceId: { type: 'string', format: 'uuid' },
|
||||
nameSingular: { type: 'string' },
|
||||
namePlural: { type: 'string' },
|
||||
isSystem: { type: 'boolean' },
|
||||
isRemote: { type: 'boolean' },
|
||||
},
|
||||
},
|
||||
toObjectMetadata: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'string', format: 'uuid' },
|
||||
dataSourceId: { type: 'string', format: 'uuid' },
|
||||
nameSingular: { type: 'string' },
|
||||
namePlural: { type: 'string' },
|
||||
isSystem: { type: 'boolean' },
|
||||
isRemote: { type: 'boolean' },
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
schemas[`${capitalize(item.namePlural)} for Response`] = {
|
||||
type: 'array',
|
||||
description: `A list of ${item.namePlural}`,
|
||||
items: {
|
||||
$ref: `#/components/schemas/${capitalize(item.nameSingular)} for Response`,
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@ -9,7 +9,7 @@ export const get400ErrorResponses = (): OpenAPIV3_1.ResponseObject => {
|
||||
type: 'object',
|
||||
properties: {
|
||||
statusCode: { type: 'number' },
|
||||
message: { type: 'string' },
|
||||
messages: { type: 'array', items: { type: 'string' } },
|
||||
error: { type: 'string' },
|
||||
},
|
||||
example: {
|
||||
|
||||
@ -55,7 +55,10 @@ export const computeDepthParameters = (): OpenAPIV3_1.ParameterObject => {
|
||||
return {
|
||||
name: 'depth',
|
||||
in: 'query',
|
||||
description: 'Limits the depth objects returned.',
|
||||
description: `Determines the level of nested related objects to include in the response.
|
||||
- 0: Returns only the primary object's information.
|
||||
- 1: Returns the primary object along with its directly related objects (with no additional nesting for related objects).
|
||||
- 2: Returns the primary object, its directly related objects, and the related objects of those related objects.`,
|
||||
required: false,
|
||||
schema: {
|
||||
type: 'integer',
|
||||
|
||||
@ -4,6 +4,7 @@ import {
|
||||
getArrayRequestBody,
|
||||
getFindDuplicatesRequestBody,
|
||||
getRequestBody,
|
||||
getUpdateRequestBody,
|
||||
} from 'src/engine/core-modules/open-api/utils/request-body.utils';
|
||||
import {
|
||||
getCreateManyResponse201,
|
||||
@ -113,7 +114,7 @@ export const computeSingleResultPath = (
|
||||
{ $ref: '#/components/parameters/idPath' },
|
||||
{ $ref: '#/components/parameters/depth' },
|
||||
],
|
||||
requestBody: getRequestBody(capitalize(item.nameSingular)),
|
||||
requestBody: getUpdateRequestBody(capitalize(item.nameSingular)),
|
||||
responses: {
|
||||
'200': getUpdateOneResponse200(item),
|
||||
'400': { $ref: '#/components/responses/400' },
|
||||
|
||||
@ -12,6 +12,20 @@ export const getRequestBody = (name: string) => {
|
||||
};
|
||||
};
|
||||
|
||||
export const getUpdateRequestBody = (name: string) => {
|
||||
return {
|
||||
description: 'body',
|
||||
required: true,
|
||||
content: {
|
||||
'application/json': {
|
||||
schema: {
|
||||
$ref: `#/components/schemas/${name} for Update`,
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
export const getArrayRequestBody = (name: string) => {
|
||||
return {
|
||||
required: true,
|
||||
@ -45,10 +59,6 @@ export const getFindDuplicatesRequestBody = (name: string) => {
|
||||
},
|
||||
ids: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'string',
|
||||
format: 'uuid',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
@ -5,6 +5,10 @@ export const getFindManyResponse200 = (
|
||||
item: Pick<ObjectMetadataEntity, 'nameSingular' | 'namePlural'>,
|
||||
fromMetadata = false,
|
||||
) => {
|
||||
const schemaRef = `#/components/schemas/${capitalize(
|
||||
item.nameSingular,
|
||||
)} for Response`;
|
||||
|
||||
return {
|
||||
description: 'Successful operation',
|
||||
content: {
|
||||
@ -18,9 +22,7 @@ export const getFindManyResponse200 = (
|
||||
[item.namePlural]: {
|
||||
type: 'array',
|
||||
items: {
|
||||
$ref: `#/components/schemas/${capitalize(
|
||||
item.nameSingular,
|
||||
)}${!fromMetadata ? ' with Relations' : ''}`,
|
||||
$ref: schemaRef,
|
||||
},
|
||||
},
|
||||
},
|
||||
@ -29,8 +31,14 @@ export const getFindManyResponse200 = (
|
||||
type: 'object',
|
||||
properties: {
|
||||
hasNextPage: { type: 'boolean' },
|
||||
startCursor: { type: 'string' },
|
||||
endCursor: { type: 'string' },
|
||||
startCursor: {
|
||||
type: 'string',
|
||||
format: 'uuid',
|
||||
},
|
||||
endCursor: {
|
||||
type: 'string',
|
||||
format: 'uuid',
|
||||
},
|
||||
},
|
||||
},
|
||||
...(!fromMetadata && {
|
||||
@ -39,21 +47,6 @@ export const getFindManyResponse200 = (
|
||||
},
|
||||
}),
|
||||
},
|
||||
example: {
|
||||
data: {
|
||||
[item.namePlural]: [
|
||||
`${capitalize(item.nameSingular)}Object1`,
|
||||
`${capitalize(item.nameSingular)}Object2`,
|
||||
'...',
|
||||
],
|
||||
},
|
||||
pageInfo: {
|
||||
hasNextPage: true,
|
||||
startCursor: '56f411fb-0900-4ffb-b942-d7e8d6709eff',
|
||||
endCursor: '93adf3c6-6cf7-4a86-adcd-75f77857ba67',
|
||||
},
|
||||
totalCount: 132,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
@ -62,8 +55,9 @@ export const getFindManyResponse200 = (
|
||||
|
||||
export const getFindOneResponse200 = (
|
||||
item: Pick<ObjectMetadataEntity, 'nameSingular'>,
|
||||
fromMetadata = false,
|
||||
) => {
|
||||
const schemaRef = `#/components/schemas/${capitalize(item.nameSingular)} for Response`;
|
||||
|
||||
return {
|
||||
description: 'Successful operation',
|
||||
content: {
|
||||
@ -75,18 +69,11 @@ export const getFindOneResponse200 = (
|
||||
type: 'object',
|
||||
properties: {
|
||||
[item.nameSingular]: {
|
||||
$ref: `#/components/schemas/${capitalize(item.nameSingular)}${
|
||||
!fromMetadata ? ' with Relations' : ''
|
||||
}`,
|
||||
$ref: schemaRef,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
example: {
|
||||
data: {
|
||||
[item.nameSingular]: `${capitalize(item.nameSingular)}Object`,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
@ -98,6 +85,7 @@ export const getCreateOneResponse201 = (
|
||||
fromMetadata = false,
|
||||
) => {
|
||||
const one = fromMetadata ? 'One' : '';
|
||||
const schemaRef = `#/components/schemas/${capitalize(item.nameSingular)} for Response`;
|
||||
|
||||
return {
|
||||
description: 'Successful operation',
|
||||
@ -110,18 +98,11 @@ export const getCreateOneResponse201 = (
|
||||
type: 'object',
|
||||
properties: {
|
||||
[`create${one}${capitalize(item.nameSingular)}`]: {
|
||||
$ref: `#/components/schemas/${capitalize(item.nameSingular)}`,
|
||||
$ref: schemaRef,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
example: {
|
||||
data: {
|
||||
[`create${one}${capitalize(item.nameSingular)}`]: `${capitalize(
|
||||
item.nameSingular,
|
||||
)}Object`,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
@ -131,6 +112,10 @@ export const getCreateOneResponse201 = (
|
||||
export const getCreateManyResponse201 = (
|
||||
item: Pick<ObjectMetadataEntity, 'nameSingular' | 'namePlural'>,
|
||||
) => {
|
||||
const schemaRef = `#/components/schemas/${capitalize(
|
||||
item.nameSingular,
|
||||
)} for Response`;
|
||||
|
||||
return {
|
||||
description: 'Successful operation',
|
||||
content: {
|
||||
@ -144,23 +129,12 @@ export const getCreateManyResponse201 = (
|
||||
[`create${capitalize(item.namePlural)}`]: {
|
||||
type: 'array',
|
||||
items: {
|
||||
$ref: `#/components/schemas/${capitalize(
|
||||
item.nameSingular,
|
||||
)}`,
|
||||
$ref: schemaRef,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
example: {
|
||||
data: {
|
||||
[`create${capitalize(item.namePlural)}`]: [
|
||||
`${capitalize(item.nameSingular)}Object1`,
|
||||
`${capitalize(item.nameSingular)}Object2`,
|
||||
'...',
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
@ -172,6 +146,7 @@ export const getUpdateOneResponse200 = (
|
||||
fromMetadata = false,
|
||||
) => {
|
||||
const one = fromMetadata ? 'One' : '';
|
||||
const schemaRef = `#/components/schemas/${capitalize(item.nameSingular)} for Response`;
|
||||
|
||||
return {
|
||||
description: 'Successful operation',
|
||||
@ -184,18 +159,11 @@ export const getUpdateOneResponse200 = (
|
||||
type: 'object',
|
||||
properties: {
|
||||
[`update${one}${capitalize(item.nameSingular)}`]: {
|
||||
$ref: `#/components/schemas/${capitalize(item.nameSingular)}`,
|
||||
$ref: schemaRef,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
example: {
|
||||
data: {
|
||||
[`update${one}${capitalize(item.nameSingular)}`]: `${capitalize(
|
||||
item.nameSingular,
|
||||
)}Object`,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
@ -230,13 +198,6 @@ export const getDeleteResponse200 = (
|
||||
},
|
||||
},
|
||||
},
|
||||
example: {
|
||||
data: {
|
||||
[`delete${one}${capitalize(item.nameSingular)}`]: {
|
||||
id: 'ffe75ac3-9786-4846-b56f-640685c3631e',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
@ -302,6 +263,10 @@ export const getJsonResponse = () => {
|
||||
export const getFindDuplicatesResponse200 = (
|
||||
item: Pick<ObjectMetadataEntity, 'nameSingular'>,
|
||||
) => {
|
||||
const schemaRef = `#/components/schemas/${capitalize(
|
||||
item.nameSingular,
|
||||
)} for Response`;
|
||||
|
||||
return {
|
||||
description: 'Successful operation',
|
||||
content: {
|
||||
@ -319,16 +284,20 @@ export const getFindDuplicatesResponse200 = (
|
||||
type: 'object',
|
||||
properties: {
|
||||
hasNextPage: { type: 'boolean' },
|
||||
startCursor: { type: 'string' },
|
||||
endCursor: { type: 'string' },
|
||||
startCursor: {
|
||||
type: 'string',
|
||||
format: 'uuid',
|
||||
},
|
||||
endCursor: {
|
||||
type: 'string',
|
||||
format: 'uuid',
|
||||
},
|
||||
},
|
||||
},
|
||||
companyDuplicates: {
|
||||
type: 'array',
|
||||
items: {
|
||||
$ref: `#/components/schemas/${capitalize(
|
||||
item.nameSingular,
|
||||
)}`,
|
||||
$ref: schemaRef,
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user