use new dropshot tag config to enumerate tags #751
Conversation
|
wait does this generate the openapi spec tho? with |
|
oy. it should. one second.. |
| "name": "hidden", | ||
| "description": "TODO operations that will not ship to customers", | ||
| "externalDocs": { | ||
| "url": "http://oxide.computer/docs/#xxx" |
There was a problem hiding this comment.
These are "https://docs.oxide.computer/api/{lowercase tag name}" if you want to fill them in with the real url
There was a problem hiding this comment.
But I don't technnically need that right now anyways but just so you know
There was a problem hiding this comment.
These aren't links to the API documentation; they're links to the product documentation.
There was a problem hiding this comment.
Ah ha, I see, like a tutorial? https://docs.oxide.computer/tutorials/{thing} ?
There was a problem hiding this comment.
or the thing in the rack? regardless I guess it doesn't really matter
There was a problem hiding this comment.
Yeah, like that. e.g. https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instances-and-amis.html
* first pass at implementing /by_id/ routes * Restore text that failed to get written when I ran out of space * Add docstrings * Fixup formatting * Fix compiler errors * Update config * Reverse by_id/resource name order * reorganize imports * Reorganize id lookup implementation code * Reorganize implementations, fix some tags * by_id to by-id * Prefix vpc resources * Add mechanism to valid auth endpoints with ids * Add coverage for by-id unauthed tests * Fix comment * Fix unauth tests * Restore test that was added by @ahl in #751 * Improve the setup req comment
This will require additional work in terms of the specific tags and their descriptions. I expect the external docs link will point to our product documentation.