Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add documentation for /monitoring/sinks/** #933

Merged
merged 9 commits into from
Oct 29, 2024
Merged

Add documentation for /monitoring/sinks/** #933

merged 9 commits into from
Oct 29, 2024

Conversation

dwilsondo
Copy link
Contributor

Adds documentation for the following routes/methods:

  • GET, POST -- /v2/monitoring/sinks/destinations
  • GET, POST, DELETE -- /v2/monitoring/sinks/destinations/{destination_uuid}
  • GET, POST -- /v2/monitoring/sinks
  • GET, DELETE -- /v2/monitoring/sinks/{sink_uuid}

sharmita3
sharmita3 reviewed Oct 22, 2024
View reviewed changes
specification/resources/monitoring/responses/monitoring_list_destinations.yml Outdated
@@ -0,0 +1,18 @@
description: The response will be a JSON object with a `destinations` key.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: The response will be a JSON object with a `destinations` key.
description: The response is a JSON object with a `destinations` key.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it 'destinationordestinations key? There's at least one instance of 'destination.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The key is destinations and the type is an array of destination.

@sharmita3
Copy link
Contributor

Left some inline edits. Additionally, please update Opensearch to OpenSearch, and use caps and periods (for example, on this line and others).

andrewsomething
andrewsomething reviewed Oct 22, 2024
View reviewed changes
Copy link
Member

@andrewsomething andrewsomething left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this looks great. Left a few questions/suggestions inline where I think a bit more clarity could help.

specification/resources/monitoring/models/destination.yml Outdated Show resolved Hide resolved
specification/resources/monitoring/models/destination_omit_credentials.yml Outdated Show resolved Hide resolved
specification/resources/monitoring/models/destination_request.yml Outdated Show resolved Hide resolved
specification/resources/monitoring/models/sink_resource.yml Outdated Show resolved Hide resolved
specification/resources/monitoring/monitoring_create_destination.yml Show resolved Hide resolved
@dwilsondo dwilsondo marked this pull request as ready for review October 29, 2024 14:32
@andrewsomething andrewsomething merged commit 138147a into digitalocean:main Oct 29, 2024
5 checks passed
@digitalocean-engineering digitalocean-engineering mentioned this pull request Oct 29, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sharmita3 sharmita3 sharmita3 left review comments

@andrewsomething andrewsomething andrewsomething approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dwilsondo @sharmita3 @andrewsomething @loosla