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.

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

Add new methods for private network monitoring zones #53

Merged
merged 3 commits into from
Apr 9, 2018

Conversation

cyrichardson
Copy link
Contributor

Fix issue #52

Draft from information available at this time. Used existing POST, PUT, and DELETE API operations to model the 3 new methods.

Still need example requests and responses.

@cyrichardson cyrichardson requested a review from itzg March 30, 2018 16:38
@cyrichardson cyrichardson self-assigned this Mar 30, 2018
@rackernexus
Copy link

Your content preview is now ready. 🙇

Copy link

@itzg itzg left a comment

Choose a reason for hiding this comment

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

Looking great and thanks for the quick turnaround.

| | |:ref:`Get your credentials <get-credentials>` |
+-----------------+----------------+-----------------------------------------------+

.. note:: This operation does not accept a request body.
Copy link

Choose a reason for hiding this comment

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

Don't need this note since the request does have a body.

Copy link

Choose a reason for hiding this comment

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

...and the body only requires a label field of type string that is the same concept as labels on our other objects.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed note and added sentence under the Example title about the label field.


.. code::

{
Copy link

Choose a reason for hiding this comment

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

An example would be:

{
  "label": "Zone A Information"
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added

Response
--------

**Example Create a private monitoring zone: JSON response**
Copy link

Choose a reason for hiding this comment

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

Response doesn't have a body.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed

.. code::

{
<!--Todo: process Request example -->
Copy link

Choose a reason for hiding this comment

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

An example would be:

{
  "label": "Zone A Updated Information"
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added

Response
--------

The following operation does not return a response body.
Copy link

Choose a reason for hiding this comment

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

Should it be "This operation" instead of "The following operation"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Corrected

@rackernexus
Copy link

Your content preview is now ready. 🙇

Copy link

@itzg itzg left a comment

Choose a reason for hiding this comment

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

Looks great. Thanks!

@cyrichardson
Copy link
Contributor Author

Thanks, @itzg. Updates made. Please review at https://staging.developer.rackspace.com/build-29b7dc0b92/docs/rackspace-monitoring/v1/api-reference/zones-operations/#monitoring-zones.

I also removed some notes about a request body not being accepted in a couple of other method descriptions where there was actually an example request body given under the note.

I was on PTO last week, hence the late application of your review comments.

Please re-review and let me know if you have other changes. If not, when would you like to merge this PR based on your product release of these new methods?

@cyrichardson
Copy link
Contributor Author

Thanks for the quick review, @itzg! Please let me know when you are ready to merge this PR and make these new methods available externally in the docs.

@itzg
Copy link

itzg commented Apr 9, 2018

I'm ready when you are :)

@cyrichardson
Copy link
Contributor Author

Merging now, @itzg.

@cyrichardson cyrichardson merged commit bdecb03 into rackerlabs:master Apr 9, 2018
@cyrichardson cyrichardson deleted the newAPIMethods branch April 9, 2018 14:30
@cyrichardson
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants