Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
"author": "",
"license": "MIT",
"devDependencies": {
"@changesets/cli": "^2.26.0"
"@changesets/cli": "^2.26.0",
"concurrently": "^7.4.0",
"tsup": "^7.1.0"
}
}
21 changes: 15 additions & 6 deletions packages/plugins/openapi/src/rest-generator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -536,12 +536,16 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
required: ['version'],
properties: {
version: { type: 'string' },
meta: this.ref('_meta'),
},
},
_meta: {
type: 'object',
description: 'Meta information about the response',
description: 'Meta information about the request or response',
properties: {
serialization: {
description: 'Superjson serialization metadata',
},
},
additionalProperties: true,
},
_resourceIdentifier: {
Expand Down Expand Up @@ -759,14 +763,15 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
required: ['data'],
properties: {
data: this.generateModelEntity(model, 'create'),
meta: this.ref('_meta'),
},
};

result[`${model.name}UpdateRequest`] = {
type: 'object',
description: `Input for updating a "${model.name}"`,
required: ['data'],
properties: { data: this.generateModelEntity(model, 'update') },
properties: { data: this.generateModelEntity(model, 'update'), meta: this.ref('_meta') },
};

const relationships: Record<string, OAPI.ReferenceObject> = {};
Expand All @@ -790,7 +795,7 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
type: 'object',
properties: { relationships: { type: 'object', properties: relationships } },
}),

meta: this.ref('_meta'),
included: {
type: 'array',
items: this.ref('_resource'),
Expand All @@ -811,6 +816,7 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
properties: { relationships: { type: 'object', properties: relationships } },
})
),
meta: this.ref('_meta'),
included: {
type: 'array',
items: this.ref('_resource'),
Expand Down Expand Up @@ -895,14 +901,17 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
case 'BigInt':
return { type: 'integer' };
case 'Float':
case 'Decimal':
return { type: 'number' };
case 'Decimal':
return this.oneOf({ type: 'number' }, { type: 'string' });
case 'Boolean':
return { type: 'boolean' };
case 'DateTime':
return { type: 'string', format: 'date-time' };
case 'Bytes':
return { type: 'string', format: 'byte', description: 'Base64 encoded byte array' };
case 'Json':
return { type: 'object' };
return {};
default: {
const fieldDecl = type.reference?.ref;
invariant(fieldDecl);
Expand Down
Loading