Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Proposed API JSON response format #28

Closed
jcalfee opened this issue Jun 6, 2017 · 1 comment
Closed

Proposed API JSON response format #28

jcalfee opened this issue Jun 6, 2017 · 1 comment

Comments

@jcalfee
Copy link
Contributor

jcalfee commented Jun 6, 2017

Success

{"status": "success", "data": { ... }}

Error

Instead of:

echo '{"block_num_or_id": 9999}' | curl http://127.0.0.1:8888/v1/chain/get_block -d @-
unknown block

Return valid JSON:

Example 1

echo '{"block_num_or_id": 9999}' | curl http://127.0.0.1:8888/v1/chain/get_block -d @-
{"status": "error", "message": "unknown block"}

Example 2

If a per-field error is desirable, this is another format:

echo '{"block_num_or_id": 9999}' | curl http://127.0.0.1:8888/v1/chain/get_block -d @-
{"status": "fail", "data": {"block_num_or_id": "unknown block"}}

From: https://stackoverflow.com/questions/12806386/standard-json-api-response-format
See JSend: http://labs.omniti.com/labs/jsend#Sohowsitwork
@jcalfee
Copy link
Contributor Author

jcalfee commented Jun 8, 2017

Instead I can work with the existing code. I believe this should work: if I see a response status code within response.status >= 200 && response.status < 300 I'll parse it as a successful JSON reply. Otherwise I'll treat the string as an error.

@jcalfee jcalfee closed this as completed Jun 8, 2017
@MatthewPappas MatthewPappas mentioned this issue Aug 18, 2017
Closed
@xdengpao xdengpao mentioned this issue Apr 18, 2018
Closed
@StepOITD StepOITD mentioned this issue Apr 23, 2018
Closed
@liangcd liangcd mentioned this issue Apr 23, 2018
Closed
@fher98 fher98 mentioned this issue May 12, 2018
Closed
@ycryptx ycryptx mentioned this issue Jun 4, 2018
Closed
@ruizhaoz1 ruizhaoz1 mentioned this issue Jul 19, 2018
Closed
@ruizhaoz1 ruizhaoz1 mentioned this issue Aug 17, 2018
Closed
@adm991 adm991 mentioned this issue Aug 18, 2018
Closed
@Drug0j Drug0j mentioned this issue Aug 30, 2018
Closed
@byterminator byterminator mentioned this issue Sep 18, 2018
Closed
@qmarliu qmarliu mentioned this issue Mar 20, 2019
Closed
justefg referenced this issue in mixbytes/haya Apr 29, 2019
@justefg
Fix block creation (#28)
1924bd9 
* Working tests

* eos finality works

* log GrandpaNode

* fix broken add_stop_task logic
taokayan pushed a commit to taokayan/eos that referenced this issue May 15, 2019
@arhag
Merge pull request EOSIO#28 from EOSIO/missing_std_opt
d220a0b 
added -std option
@quanhuynhUmb quanhuynhUmb mentioned this issue Jun 3, 2019
Closed
NorseGaud pushed a commit that referenced this issue Jul 30, 2019
# This is a combination of 186 commits.
6c09577 
# This is the 1st commit message:

various improvements

# This is the commit message #2:

new hash

# This is the commit message #3:

fix for script path

# This is the commit message #4:

fixes

# This is the commit message #5:

fixes

# This is the commit message #6:

fixes

# This is the commit message #7:

fixes

# This is the commit message #8:

fixes

# This is the commit message #9:

fixes

# This is the commit message #10:

fixes

# This is the commit message #11:

fixes

# This is the commit message #12:

fixes

# This is the commit message #13:

fixes

# This is the commit message #14:

fixes

# This is the commit message #15:

fixes

# This is the commit message #16:

fixes

# This is the commit message #17:

fixes

# This is the commit message #18:

fixes

# This is the commit message #19:

fixes

# This is the commit message #20:

fixes

# This is the commit message #21:

fixes

# This is the commit message #22:

fixes

# This is the commit message #23:

fixes

# This is the commit message #24:

fixes

# This is the commit message #25:

fixes

# This is the commit message #26:

testing

# This is the commit message #27:

testing

# This is the commit message #28:

testing

# This is the commit message #29:

testing

# This is the commit message #30:

testing

# This is the commit message #31:

testing

# This is the commit message #32:

testing

# This is the commit message #33:

testing

# This is the commit message #34:

testing

# This is the commit message #35:

testing

# This is the commit message #36:

testing

# This is the commit message #37:

testing

# This is the commit message #38:

testing

# This is the commit message #39:

testing

# This is the commit message #40:

testing

# This is the commit message #41:

testing

# This is the commit message #42:

testing

# This is the commit message #43:

testing

# This is the commit message #44:

fixes

# This is the commit message #45:

fixes

# This is the commit message #46:

fixes

# This is the commit message #47:

fixes

# This is the commit message #48:

fixes

# This is the commit message #49:

fixes

# This is the commit message #50:

fixes

# This is the commit message #51:

fixes

# This is the commit message #52:

fixes

# This is the commit message #53:

fixes

# This is the commit message #54:

fixes

# This is the commit message #55:

fixes

# This is the commit message #56:

fixes

# This is the commit message #57:

fixes

# This is the commit message #58:

fixes

# This is the commit message #59:

fixes

# This is the commit message #60:

fixes

# This is the commit message #61:

fixes

# This is the commit message #62:

fixes

# This is the commit message #63:

fixes

# This is the commit message #64:

fixes

# This is the commit message #65:

fixes

# This is the commit message #66:

fixes

# This is the commit message #67:

fixes

# This is the commit message #68:

fixes

# This is the commit message #69:

fixes

# This is the commit message #70:

fixes

# This is the commit message #71:

fixes

# This is the commit message #72:

fixes

# This is the commit message #73:

fixes

# This is the commit message #74:

fixes

# This is the commit message #75:

fixes

# This is the commit message #76:

fixes

# This is the commit message #77:

fixes

# This is the commit message #78:

fixes

# This is the commit message #79:

more testing

# This is the commit message #80:

testing

# This is the commit message #81:

fixes

# This is the commit message #82:

fixes

# This is the commit message #83:

fixes

# This is the commit message #84:

fixes

# This is the commit message #85:

fixes

# This is the commit message #86:

fixes

# This is the commit message #87:

fixes

# This is the commit message #88:

fixes

# This is the commit message #89:

fixes

# This is the commit message #90:

fixes

# This is the commit message #91:

fixes

# This is the commit message #92:

fixes

# This is the commit message #93:

propagate-environment for buildkite-agent

# This is the commit message #94:

propagate-environment for buildkite-agent

# This is the commit message #95:

propagate-environment for buildkite-agent

# This is the commit message #96:

propagate-environment for buildkite-agent

# This is the commit message #97:

fixes

# This is the commit message #98:

fixes

# This is the commit message #99:

fixes

# This is the commit message #100:

fixes

# This is the commit message #101:

fixes

# This is the commit message #102:

fixes

# This is the commit message #103:

fixes

# This is the commit message #104:

fixes

# This is the commit message #105:

fixes

# This is the commit message #106:

fixes

# This is the commit message #107:

fixes

# This is the commit message #108:

fixes

# This is the commit message #109:

fixes

# This is the commit message #110:

fixes

# This is the commit message #111:

fixes

# This is the commit message #112:

fixes

# This is the commit message #113:

fixes

# This is the commit message #114:

fixes

# This is the commit message #115:

fixes

# This is the commit message #116:

fixes

# This is the commit message #117:

fixes

# This is the commit message #118:

fixes

# This is the commit message #119:

fixes

# This is the commit message #120:

fixes

# This is the commit message #121:

fixes

# This is the commit message #122:

fixes

# This is the commit message #123:

fixes

# This is the commit message #124:

fixes

# This is the commit message #125:

fixes

# This is the commit message #126:

fixes

# This is the commit message #127:

fixes

# This is the commit message #128:

fixes

# This is the commit message #129:

fixes

# This is the commit message #130:

fixes

# This is the commit message #131:

fixes

# This is the commit message #132:

fixes

# This is the commit message #133:

fixes

# This is the commit message #134:

fixes

# This is the commit message #135:

fixes

# This is the commit message #136:

fixes

# This is the commit message #137:

fixes

# This is the commit message #138:

fixes

# This is the commit message #139:

fixes

# This is the commit message #140:

fixes

# This is the commit message #141:

fixes

# This is the commit message #142:

fixes

# This is the commit message #143:

fixes

# This is the commit message #144:

fixes

# This is the commit message #145:

fixes

# This is the commit message #146:

fixes

# This is the commit message #147:

fixes

# This is the commit message #148:

fixes

# This is the commit message #149:

fixes

# This is the commit message #150:

fixes

# This is the commit message #151:

fixes

# This is the commit message #152:

fixes

# This is the commit message #153:

testing

# This is the commit message #154:

fixes

# This is the commit message #155:

fixes

# This is the commit message #156:

fixes

# This is the commit message #157:

fixes

# This is the commit message #158:

fixes

# This is the commit message #159:

fixes

# This is the commit message #160:

fixes

# This is the commit message #161:

fixes

# This is the commit message #162:

fixes

# This is the commit message #163:

fixes

# This is the commit message #164:

fixes

# This is the commit message #165:

fixes

# This is the commit message #166:

fixes

# This is the commit message #167:

fixes

# This is the commit message #168:

fixes

# This is the commit message #169:

fixes

# This is the commit message #170:

fixes

# This is the commit message #171:

fixes

# This is the commit message #172:

fixes

# This is the commit message #173:

fixes

# This is the commit message #174:

fixes

# This is the commit message #175:

fixes

# This is the commit message #176:

fixes

# This is the commit message #177:

fixes

# This is the commit message #178:

fixes

# This is the commit message #179:

fixes

# This is the commit message #180:

fixes

# This is the commit message #181:

fixes

# This is the commit message #182:

fixes

# This is the commit message #183:

fixes

# This is the commit message #184:

fixes

# This is the commit message #185:

fixes

# This is the commit message #186:

fixes
heifner pushed a commit that referenced this issue Feb 28, 2022
@swatanabe
Merge pull request #28 from eosnetworkfoundation/oc-version
368045b 
Increment codegen_version
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jcalfee