You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@couchdb.apache.org by GitBox <gi...@apache.org> on 2019/12/22 06:36:38 UTC
[GitHub] [couchdb-documentation] nickva opened a new pull request #465:
Switch replicator "info" error message to be an object
nickva opened a new pull request #465: Switch replicator "info" error message to be an object
URL: https://github.com/apache/couchdb-documentation/pull/465
Companion to the implementation PR https://github.com/apache/couchdb/pull/2379
### Overview
The value of the `"info"` field from the _scheduler/* API cannot be a string anymore. It is now restricted to be a `null` or a JSON object.
### Related Pull Requests
https://github.com/apache/couchdb/pull/2379
### Checklist
- [x] Documentation is written and is accurate;
- [x] `make check` passes with no errors
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [couchdb-documentation] flimzy commented on issue #465: Switch
replicator "info" error message to be an object
Posted by GitBox <gi...@apache.org>.
flimzy commented on issue #465: Switch replicator "info" error message to be an object
URL: https://github.com/apache/couchdb-documentation/pull/465#issuecomment-568409347
Just two comments, nothing urgent. +1 with or without further changes :)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [couchdb-documentation] nickva commented on a change in pull
request #465: Switch replicator "info" error message to be an object
Posted by GitBox <gi...@apache.org>.
nickva commented on a change in pull request #465: Switch replicator "info" error message to be an object
URL: https://github.com/apache/couchdb-documentation/pull/465#discussion_r360952286
##########
File path: src/api/server/common.rst
##########
@@ -1210,9 +1215,11 @@ error.
:>json string target: Replication target
:>json string start_time: Timestamp of when the replication was started
:>json string last_update: Timestamp of last state update
- :>json object info: May contain additional information about the state.
- For error states, this will be a string. For success
- states this will contain a JSON object (see below).
+ :>json object info: May contain additional information about the
Review comment:
Agree
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [couchdb-documentation] flimzy commented on a change in pull
request #465: Switch replicator "info" error message to be an object
Posted by GitBox <gi...@apache.org>.
flimzy commented on a change in pull request #465: Switch replicator "info" error message to be an object
URL: https://github.com/apache/couchdb-documentation/pull/465#discussion_r360811696
##########
File path: src/api/server/common.rst
##########
@@ -1210,9 +1215,11 @@ error.
:>json string target: Replication target
:>json string start_time: Timestamp of when the replication was started
:>json string last_update: Timestamp of last state update
- :>json object info: May contain additional information about the state.
- For error states, this will be a string. For success
- states this will contain a JSON object (see below).
+ :>json object info: May contain additional information about the
Review comment:
Should this say "May" or "Will"? Is it ever blank?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [couchdb-documentation] nickva commented on a change in pull
request #465: Switch replicator "info" error message to be an object
Posted by GitBox <gi...@apache.org>.
nickva commented on a change in pull request #465: Switch replicator "info" error message to be an object
URL: https://github.com/apache/couchdb-documentation/pull/465#discussion_r360952286
##########
File path: src/api/server/common.rst
##########
@@ -1210,9 +1215,11 @@ error.
:>json string target: Replication target
:>json string start_time: Timestamp of when the replication was started
:>json string last_update: Timestamp of last state update
- :>json object info: May contain additional information about the state.
- For error states, this will be a string. For success
- states this will contain a JSON object (see below).
+ :>json object info: May contain additional information about the
Review comment:
Agree, let's put "Will" there, it makes more sense I think
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [couchdb-documentation] nickva commented on a change in pull
request #465: Switch replicator "info" error message to be an object
Posted by GitBox <gi...@apache.org>.
nickva commented on a change in pull request #465: Switch replicator "info" error message to be an object
URL: https://github.com/apache/couchdb-documentation/pull/465#discussion_r360952379
##########
File path: src/api/server/common.rst
##########
@@ -1210,9 +1215,11 @@ error.
:>json string target: Replication target
:>json string start_time: Timestamp of when the replication was started
:>json string last_update: Timestamp of last state update
- :>json object info: May contain additional information about the state.
- For error states, this will be a string. For success
- states this will contain a JSON object (see below).
+ :>json object info: May contain additional information about the
+ state. For error states, this will be an
+ object with an `"error"` field and a string
+ value. For success states this will contain a
+ JSON object (see below).
Review comment:
That's much better. Thank you!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [couchdb-documentation] flimzy commented on a change in pull
request #465: Switch replicator "info" error message to be an object
Posted by GitBox <gi...@apache.org>.
flimzy commented on a change in pull request #465: Switch replicator "info" error message to be an object
URL: https://github.com/apache/couchdb-documentation/pull/465#discussion_r360811640
##########
File path: src/api/server/common.rst
##########
@@ -1210,9 +1215,11 @@ error.
:>json string target: Replication target
:>json string start_time: Timestamp of when the replication was started
:>json string last_update: Timestamp of last state update
- :>json object info: May contain additional information about the state.
- For error states, this will be a string. For success
- states this will contain a JSON object (see below).
+ :>json object info: May contain additional information about the
+ state. For error states, this will be an
+ object with an `"error"` field and a string
+ value. For success states this will contain a
+ JSON object (see below).
Review comment:
After editing the 'error' case, the success case seems redundant. Perhaps reword to something like this?
> Will contain additional information about the state. For errors, this will be an object with an `"error`" field and string value. For success states, see below.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [couchdb-documentation] nickva merged pull request #465: Switch
replicator "info" error message to be an object
Posted by GitBox <gi...@apache.org>.
nickva merged pull request #465: Switch replicator "info" error message to be an object
URL: https://github.com/apache/couchdb-documentation/pull/465
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services