[@feathersjs/schema] Feathers schema associations using $ref may not be working #2675

Activity

1. ejmudrak commented on Jun 21, 2022

   

   ejmudrak

   on Jun 21, 2022

   Author

   More actions

   My temporary workaround is importing the referenced schema directly like so:

   albums: {
     type: 'array',
     items: { 
         type: 'object',
         properties: albumResultSchema.definition.properties,
     },
   },
   
2. ejmudrak

   changed the title [-]Feathers schema associations using $ref may not be working[/-] [+][@feathersjs/schema] Feathers schema associations using $ref may not be working[/+] on Jun 30, 2022
3. AshotN commented on Sep 29, 2022

   

   AshotN

   on Sep 29, 2022

   Contributor

   More actions

   Were you able to resolve this issue? I am running into something similar and I'm unsure if it's user error.
4. daffl commented on Oct 5, 2022

   

   daffl

   on Oct 5, 2022

   Member

   More actions

   This has been addressed now in #2772 with making the schema wrapper optional and using FromSchema or TypeBox directly which both do support references. With plain JSON schema this would look like this:

   export const userSchema = {
     $id: 'User',
     type: 'object',
    // etc.
   } as const
   
   // ...
   
   import { FromSchema } from '@feathersjs/schema'
   
   export const messageSchema = {
     $id: 'Message',
     type: 'object',
     additionalProperties: false,
     required: ['text'],
     properties: {
       text: {
         type: 'string'
       },
      user: {
       $ref: 'User'
      }
    }
   } as const
   
   export type Message = FromSchema<typeof messageSchema, {
     references: [ typeof userSchema ]
   }>
5. daffl

   closed this as completedin #2772on Oct 7, 2022
6. RickEyre commented on Nov 1, 2023

   

   RickEyre

   on Nov 1, 2023

   More actions

   Is there a more complete example for this solution? I'm having trouble understanding how you go from this example to actually using getValidator and getDataValidator and their respective hooks.

   👍React with 👍1Reacted by Tarek Gamal
7. opatajoshua commented on Feb 20, 2024

   

   opatajoshua

   on Feb 20, 2024

   Last edited by opatajoshua

   More actions

   Error is thrown by getValidator

   1. Option 1: Omit refs from your query shema if you don't need them in query validation

   export const postQueryProperties = Type.Partial(Type.Omit(postSchema, ["user"])); // where user is a ref for userSchema

   2. Option2: addSchema before getValidator is called

   queryValidator.addSchema(userSchema);
   export const postQueryValidator = getValidator(postQuerySchema, queryValidator);

   👍React with 👍1Reacted by Bartram Nason