Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to remove deprecated fields from documentation #208

Open
leonardehrenfried opened this issue Apr 20, 2023 · 2 comments
Open

Add option to remove deprecated fields from documentation #208

leonardehrenfried opened this issue Apr 20, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@leonardehrenfried
Copy link
Contributor

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 leonardehrenfried added the enhancement New feature or request label Apr 20, 2023
@pelletier197
Copy link
Collaborator

pelletier197 commented Apr 23, 2023

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.

@leonardehrenfried
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants