You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sometimes we want to hide some (optional) models/fields because they are not ready for public release or intended for internal usage. We may be able to support this by using apidoc attributes.
We can introduce a custom attribute internal that can be recognised by apidoc-ui and anything with that attribute are not displayed.
The text was updated successfully, but these errors were encountered:
@kalmanb That looks good to me. Do we want to name it apidoc-ui or something more generic (I think this attribute can be useful in generators as well) ?
Good point. Here's what we'll go for. We'll implement ui first, generators later if needed
"attributes": [
{
"name": "visibility",
"descrption": "Should an element be displayed in the UI and created by generators",
"value": {
"ui": "default|public|organization|user|none",
"generators": {
"default": "default|public|organization|user|none",
"scala": "default|public|organization|user|none",
}
}
],
Sometimes we want to hide some (optional) models/fields because they are not ready for public release or intended for internal usage. We may be able to support this by using apidoc
attributes
.We can introduce a custom attribute
internal
that can be recognised by apidoc-ui and anything with that attribute are not displayed.The text was updated successfully, but these errors were encountered: