Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Schema fields that start with underscore should be hidden in the API response #385

Closed
subnetmarco opened this issue Jul 8, 2015 · 3 comments
Assignees
Labels
task/feature Requests for new features in Kong

Comments

@subnetmarco
Copy link
Member

In some situations it's very convenient to cache some otherwise long operations inside the datastore in specific private fields, like https://github.com/Mashape/kong/blob/master/kong/plugins/ssl/schema.lua#L27-L29

This is to avoid the "Dogpile Effect" in production, and increase performance.

This fields are currently being displayed in the API response, while they should only be visibile internally. Not sure if we want to use the underscore convention, or have a specific hide = true property for the field.

@thibaultcha
Copy link
Member

Sounds good. I'm more in favour of the hide = true than the underscore, just to stay consistent with how fields acquire properties.

@subnetmarco subnetmarco added this to the 0.5.0 milestone Jul 23, 2015
@subnetmarco
Copy link
Member Author

@thibaultcha this needs to be implemented in the Admin API right before returning the response, because we still want to have the visibility of the fields when the DAO is being invoked.

@subnetmarco subnetmarco self-assigned this Jul 23, 2015
@subnetmarco
Copy link
Member Author

Actually hide = true is the wrong property name. Should be internal = true.

@thibaultcha thibaultcha removed this from the 0.5.0 milestone Aug 27, 2015
@thibaultcha thibaultcha added the task/feature Requests for new features in Kong label Oct 15, 2015
@guanlan guanlan closed this as completed May 26, 2021
@Kong Kong locked and limited conversation to collaborators May 26, 2021

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
task/feature Requests for new features in Kong
Projects
None yet
Development

No branches or pull requests

4 participants