Giter Site home page Giter Site logo

Comments (4)

cnizzardini avatar cnizzardini commented on June 6, 2024

Surprisingly there is not that option, I thought this library had something like that, but it only gives the ability to hide an entire Entity. What you can do is use this: https://book.cakephp.org/4/en/orm/entities.html#hiding-fields

The library should respect hidden fields.

from cakephp-swagger-bake.

TheGlenn88 avatar TheGlenn88 commented on June 6, 2024

Thanks for the reply, unfortunately I cannot use the $_hidden property on the entity as that will hide them for all endpoints that use the User Entity for example.

Imagine a /users endpoint designed for viewing by the end-user and a /users endpoint for an admin. Realistically I only want to document the end-user endpoint missing some extra properties hidden.

still trying to get the hang of this package, it's really nice so far.

from cakephp-swagger-bake.

cnizzardini avatar cnizzardini commented on June 6, 2024

I guess you are not returning the full entity then on these "custom" end-user endpoints, I think both of these options will work for you:

  1. You can use the OpenApiResponse attribute, either specifying custom OpenAPI YAML or using a response DTO, both examples are documented here: https://github.com/cnizzardini/cakephp-swagger-bake/blob/master/docs/attributes.md#openapiresponse
  2. You can use an event listener to modify the response for a specific endpoint: https://github.com/cnizzardini/cakephp-swagger-bake/blob/master/docs/events.md

from cakephp-swagger-bake.

cnizzardini avatar cnizzardini commented on June 6, 2024

Closing due to lack of response

from cakephp-swagger-bake.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.