magidoc icon indicating copy to clipboard operation
magidoc copied to clipboard

Add option to remove deprecated fields from documentation

Open leonardehrenfried opened this issue 2 years ago • 2 comments

Describe the problem

We have quite a few of deprecated fields in our API schema and GraphiQL does a good thing with these: it hides them by default and moves them into a separate section of the docs.

Describe the proposed solution

It would be great if magidoc could either:

  • completely remove the input fields
  • move them to a separate section

Importance

Nice to have

leonardehrenfried avatar Apr 20 '23 11:04 leonardehrenfried

Hi @leonardehrenfried. Sorry for the late reply. You're right, that is a good proposition. I'm curious, how would you organize that ? There are many things that could be deprecated.

  • a type
  • a query/mutation/subscription
  • a field inside a type or a query

In the current page layout, I'm not sure there is a good way to show them in a separated section. They are already crossed out so I guess it separates them a bit from the others.

Removing them completely is a good option too, I would not have any problem adding that option.

That being said, I am quite busy in the recent days. It might take a little while until I get time to implement this. Contributions are always appreciated if you get some time to look at it and if this is urgent.

pelletier197 avatar Apr 23 '23 12:04 pelletier197

Personally I would totally be happy if there was a way to completely hide them.

It's doesn't stop me from using this tool though, it's definitely in the nice-to-have category.

leonardehrenfried avatar Apr 24 '23 15:04 leonardehrenfried