feat(ACI): Document Organization Detector Details Endpoints#106148
feat(ACI): Document Organization Detector Details Endpoints#106148
Conversation
github-actions
bot
added
the
Scope: Backend
| def delete(self, request: Request, organization: Organization, detector: Detector): | ||
| """ | ||
| Delete a detector | ||
| Delete a monitor |
There was a problem hiding this comment.
nit: I don't think the internal comments need to refer to detectors as monitors, just the external docs. But it's fine either way (tbh I don't think we even need these comments since it's obvious already what it does but whatevs)
| publish_status = { | ||
| "GET": ApiPublishStatus.EXPERIMENTAL, | ||
| "GET": ApiPublishStatus.PUBLIC, | ||
| "PUT": ApiPublishStatus.EXPERIMENTAL, |
There was a problem hiding this comment.
Should the PUT be public now too?
There was a problem hiding this comment.
Oops this actually shouldn't be merged as public at all, I'm going to do that all at once and add the sidebar item. Right now I am adding the docs quietly so they won't show up anywhere until they are all ready. I set them to public while working on them so I can run the API docs tests to make sure they're valid and run the docs locally and check everything.
|
|
||
| GET_DETECTOR = [ | ||
| OpenApiExample( | ||
| "Fetch a monitor", |
There was a problem hiding this comment.
IDK where this shows up but do we need to capitalize Monitor?
There was a problem hiding this comment.
Good catch, this will show up as the example success response on the docs pages - will capitalize.
There was a problem hiding this comment.
Actually this doesn't show up anywhere but I updated it anyway 😅
ceorourke
force-pushed
the
ceorourke/document-org-detector-details-get
branch
from
0c1b2cc to
86773ab
Compare
2 participants
Add documentation for GET, PUT, and DELETE detector details endpoints.