Replace hide=resources for count purposes about manageiq-api

[chrisarcand]

Are you saying that as a header or a proper route the performance of this call will have a lesser impact on server load?

Yes; we need only respond with a count when all you're asking for is a count and optimize for that case, and while the hide=resources is a slight optimization this would be a much better one - and make more sense semantically. It's sort of a weird shoehorning of something that doesn't imply it's purpose in the querystring besides.

Are you proposing the depreciation of ?hide=resources ?

Yes; this is it's sole purpose (to my knowledge) and this new way would replace it.

Custom headers as a means of grabbing metadata are a little surprising, not something ya might know unless explicitly told, does this work include creating the documentation to say, "hey, yeah, we do this now, grabbing skinny metadata with custom headers"?

Surprising only if it's not documented, yeah 😄 Yes, I'll change the site documentation accordingly to help make it obvious that this is the correct way to do it.

RE: and yah, ?hide=resources is used when we only want the count of a query, none of the resources, actions, or paging

Excellent, that's what I figured.

---

Re: question 3, I'd like to discuss a reimplementation of API documentation to help consumers of the API like you to make sense of what's being deprecated, when it's being deprecated ("What release was this available? Deprecated? What changed?), etc etc. We currently don't have any way to deduce that from the documentation at all and I can respect from your end that it's probably pretty annoying to deal with. This is a whole separate can of worms that I'll bring up later, but thought I'd mention here as this is a great example.

[AllenBW]

We DO use them quite often for sidebar counts. I'm down for whatever! If a change needs to be made lemme know and it'll be done

Ok now to the questions:

1. Are you saying that as a header or a proper route the performance of this call will have a lesser impact on server load?
2. Are you proposing the depreciation of ?hide=resources ?
3. Custom headers as a means of grabbing metadata are a little surprising, not something ya might know unless explicitly told, does this work include creating the documentation to say, "hey, yeah, we do this now, grabbing skinny metadata with custom headers"?

[chrisarcand]

cc/ @imtayadeway @AllenBW from ManageIQ/manageiq#12694

[AllenBW]

RE: and yah, ?hide=resources is used when we only want the count of a query, none of the resources, actions, or paging

[Fryguy]

I'd like to discuss a reimplementation of API documentation

This should probably be discussed in the context of our discussion about moving to swagger, since the way the swagger API is documentation driven.

[abellotti]

👍 on swagger, @mkanoor did a nice presentation/poc on that.

[chrisarcand]

Yup!

[miq-bot]

This issue has been automatically marked as stale because it has not been updated for at least 6 months.

If you can still reproduce this issue on the current release or on master, please reply with all of the information you have about it in order to keep the issue open.

Thank you for all your contributions!

[JPrause]

@abellotti is this still a valid issue? If yes, please remove the stale label. If not can you close.
If there's no update by next week, I'll be closing this issue.

[JPrause]

Closing issue. If you feel the issue needs to remain open, please either reopen or let me know and it will be reopened.
@miq-bot close_issue