docs: Instance admin #3961
docs: Instance admin #3961
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
| schemaName: string, | ||
| ): OpenAPIV3.ResponseObject => { | ||
| return createResponseSchemas(schemaName, { | ||
| 'text/csv': schemaNamed(schemaName), |
There was a problem hiding this comment.
Cool! Does this convert it to CSV (for examples etc)? Does the example response show as CSV in swagger UI?
There was a problem hiding this comment.
Unfortunately swagger does not show examples for CSV
There was a problem hiding this comment.
Hmm ... Yeah, it doesn't look like it's well supported. Can we still show examples, though? according to this stack overflow thread, you should mark CSV payloads as strings if I read correctly. And they can probably have examples. Right?
There was a problem hiding this comment.
This is annoying, the schema still shows the json example, but we definitely have an object here, so I'm inclined to keep it.
There was a problem hiding this comment.
yeah, which means we should just drop the schemaNamed here then. and just use string
There was a problem hiding this comment.
There was a problem hiding this comment.
I fixed it by making the type of the response string, and then allowing the makeCsvResponseSchema take an example string. Our example is now a csv serialized object of the type we're expecting.
| openApiService.validPath({ | ||
| tags: ['Instance Admin'], | ||
| operationId: 'getInstanceAdminStatsCsv', | ||
| responses: { | ||
| 200: createCsvResponseSchema( | ||
| 'instanceAdminStatsSchema', | ||
| ), | ||
| }, | ||
| }), |
There was a problem hiding this comment.
This should have a summary and a description.
There was a problem hiding this comment.
Indeed. Oversight from my side.
| @@ -46,6 +60,10 @@ class InstanceAdminController extends Controller { | |||
| openApiService.validPath({ | |||
| tags: ['Instance Admin'], | |||
| operationId: 'getInstanceAdminStats', | |||
| summary: | |||
| 'An overview of usage of various features of Unleash', | |||
There was a problem hiding this comment.
Maybe we can shorten it down a bit?
| 'An overview of usage of various features of Unleash', | |
| 'Get feature usage overview', |
There was a problem hiding this comment.
I feel like we've conflated the word feature here. Maybe "Get usage statistics" instead?
There was a problem hiding this comment.
Yeah, that's much better 😄
There was a problem hiding this comment.
Ended up using Instance usage statistics
| description: 'The number of users this instance has', | ||
| example: 8, | ||
| }, | ||
| featureToggles: { | ||
| type: 'number', | ||
| description: 'The number of feature-toggles this instance has', | ||
| example: 47, | ||
| }, | ||
| projects: { | ||
| type: 'number', | ||
| description: 'The number of projects defined in this instance.', | ||
| example: 3, | ||
| }, | ||
| contextFields: { | ||
| type: 'number', | ||
| description: | ||
| 'The number of context fields defined in this instance.', | ||
| example: 7, | ||
| }, | ||
| roles: { | ||
| type: 'number', | ||
| description: 'The number of roles defined in this instance', | ||
| example: 5, | ||
| }, | ||
| groups: { | ||
| type: 'number', | ||
| description: 'The number of groups defined in this instance', | ||
| example: 12, | ||
| }, | ||
| environments: { | ||
| type: 'number', | ||
| description: 'The number of environments defined in this instance', | ||
| example: 3, | ||
| }, | ||
| segments: { | ||
| type: 'number', | ||
| description: 'The number of segments defined in this instance', | ||
| example: 19, | ||
| }, | ||
| strategies: { | ||
| type: 'number', | ||
| description: 'The number of strategies defined in this instance', | ||
| example: 8, |
There was a problem hiding this comment.
We could mark all these numbers in the admin stats schema with a minimum: 0. That would be more accurate. However, because this is a response schema, we're not in any danger of the users submitting wrong data based on this, so it's not that important.
What do you think? I think it'd be nice, but I'll leave it up to you.
There was a problem hiding this comment.
Sure, I mean, when parsing this that would allow me to use unsigned types safely. Compared to how little work it is to add, happy to add it.
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
chriswk
force-pushed
the
docs/instanceAdmin
branch
from
203451f
to
cf840f7
Compare
What
Adds the documentation for the instance admin endpoints.