Shahed Nasser
8a1aac028e
* improve curl examples in OAS * update tags * fix oas errors * update tags and their descriptions * updated oas of endpoints * improved oas of all admin endpoints * improved store OAS comments * improved models OAS comments * small change
105 lines
2.7 KiB
TypeScript
105 lines
2.7 KiB
TypeScript
import {
|
|
BeforeInsert,
|
|
Column,
|
|
Entity,
|
|
Index,
|
|
JoinColumn,
|
|
ManyToOne,
|
|
} from "typeorm"
|
|
|
|
import { DbAwareColumn } from "../utils/db-aware-column"
|
|
import { SoftDeletableEntity } from "../interfaces/models/soft-deletable-entity"
|
|
import { User } from "./user"
|
|
import { generateEntityId } from "../utils/generate-entity-id"
|
|
|
|
@Entity()
|
|
export class Note extends SoftDeletableEntity {
|
|
@Column()
|
|
value: string
|
|
|
|
@Index()
|
|
@Column()
|
|
resource_type: string
|
|
|
|
@Index()
|
|
@Column()
|
|
resource_id: string
|
|
|
|
@Column({ nullable: true })
|
|
author_id: string
|
|
|
|
@ManyToOne(() => User)
|
|
@JoinColumn({ name: "author_id" })
|
|
author: User
|
|
|
|
@DbAwareColumn({ type: "jsonb", nullable: true })
|
|
metadata: Record<string, unknown>
|
|
|
|
@BeforeInsert()
|
|
private beforeInsert(): void {
|
|
this.id = generateEntityId(this.id, "note")
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @schema Note
|
|
* title: "Note"
|
|
* description: "A Note is an element that can be used in association with different resources to allow admin users to describe additional information. For example, they can be used to add additional information about orders."
|
|
* type: object
|
|
* required:
|
|
* - author_id
|
|
* - created_at
|
|
* - deleted_at
|
|
* - id
|
|
* - metadata
|
|
* - resource_id
|
|
* - resource_type
|
|
* - updated_at
|
|
* - value
|
|
* properties:
|
|
* id:
|
|
* description: The note's ID
|
|
* type: string
|
|
* example: note_01G8TM8ENBMC7R90XRR1G6H26Q
|
|
* resource_type:
|
|
* description: The type of resource that the Note refers to.
|
|
* type: string
|
|
* example: order
|
|
* resource_id:
|
|
* description: The ID of the resource that the Note refers to.
|
|
* type: string
|
|
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
|
|
* value:
|
|
* description: The contents of the note.
|
|
* type: string
|
|
* example: This order must be fulfilled on Monday
|
|
* author_id:
|
|
* description: The ID of the user that created the note.
|
|
* nullable: true
|
|
* type: string
|
|
* example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
|
|
* author:
|
|
* description: The details of the user that created the note.
|
|
* x-expandable: "author"
|
|
* nullable: true
|
|
* $ref: "#/components/schemas/User"
|
|
* created_at:
|
|
* description: The date with timezone at which the resource was created.
|
|
* type: string
|
|
* format: date-time
|
|
* updated_at:
|
|
* description: The date with timezone at which the resource was updated.
|
|
* type: string
|
|
* format: date-time
|
|
* deleted_at:
|
|
* description: The date with timezone at which the resource was deleted.
|
|
* nullable: true
|
|
* type: string
|
|
* format: date-time
|
|
* metadata:
|
|
* description: An optional key-value map with additional details
|
|
* nullable: true
|
|
* type: object
|
|
* example: {car: "white"}
|
|
*/
|