Currently, I see no way of editing the path object inside the servcie. Only the defini

Oh thats exactly what i need. Thanks <a class="user-mention notranslate" data-hovercar

My example using mongoose : <div class="snippet-clipboard-content notranslate posi

Add documantation for customization of path object ,about feathersjs-ecosystem/feathers-swagger

Comments (6)

arddor commented on June 6, 2024 1

This is something which I also discovered recently while looking closer at the sequelize example:

const doc = {
  description: 'Operations about Users.',
  definitions: {
    'UserPaginate': swagger.definition({
      attributes: {
        data: Sequelize.ARRAY('users')
      }
    }, {
      extends: ['paginate']
    })
  },
  definition: swagger.definition(model),
  securities: ['find'],
  find: {
    parameters: [{
      description: 'Get examples by name',
      in : 'query',
      required: false,
      name: 'email',
      type: 'string'
    }],
    responses: {
      '200': {
        description: 'successful operation',
        schema: {
          '$ref': '#/definitions/UserPaginate'
        }
      }
    }
  }
};

As you see you can define response with find, get, ...
I would say that there should be some more documentation to make that clear

from feathers-swagger.

silberjan commented on June 6, 2024

Oh thats exactly what i need. Thanks @arddor !

Documentation for that feature would be really helpful ;)

from feathers-swagger.

daffl commented on June 6, 2024

If someone would like to add the documentation (just a quick example or paragraph with an explanation) feel free to edit the README. It'll then just become part of the main docs with the official release.

from feathers-swagger.

akshay2604 commented on June 6, 2024

If someone can post a basic documentation for this, it will be really helpful.

I am currently doing this.

  const doc = {
    path: {
      '/api/xbcBusinesses': { // <--- not sure about this
         description: 'A service for business',
         find: {
            parameters: [{
            description: 'Get examples by name',
            in : 'query',
            required: false,
            name: 'email',
            type: 'string'
         }],
         },
          create: { 
            description: 'Custom POST description',
            responses: {
              '201': {
                description: 'New Business was created'
              }
            }
          }
      }
    }
  }

and register it here.

app.use('/api/xbcBusinesses',Object.assign(service(options), {
      docs: doc
}));

This is the response i am getting.

Obviously I am not able to get the doc here.

Also I am not able to get the swagger.definition part from above. Where is swagger defined?

from feathers-swagger.

josx commented on June 6, 2024

My example using mongoose :

  const doc = {
     find: {
       parameters: [{
         description: 'Search model by string',
         in: 'query',
         required: false,
         name: '$text[$search]',
         type: 'string'
       }],
     },
     get: {
       parameters: [{
         description: 'Search mode by id',
         in: 'path',
         required: true,
         name: '_id',
         type: 'string'
       }],
     }
   };

from feathers-swagger.