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

R4R: Rename LCD endpoints (Docs) #2066

Merged
merged 8 commits into from
Aug 21, 2018
Merged

R4R: Rename LCD endpoints (Docs) #2066

merged 8 commits into from
Aug 21, 2018

Conversation

fedekunze
Copy link
Collaborator

@fedekunze fedekunze commented Aug 16, 2018 •
edited
Loading

Closes #1305, #1762

This PR is only docs for #1979

  • Linked to github-issue with discussion and accepted design OR link to spec that describes this work.
  • Updated all relevant documentation (docs/)
  • Updated all relevant code comments
  • Wrote tests
  • Added entries in PENDING.md that include links to the relevant issue or PR that most accurately describes the change.
  • Updated cmd/gaia and examples/

For Admin Use:

  • Added appropriate labels to PR (ex. wip, ready-for-review, docs)
  • Reviewers Assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

@fedekunze fedekunze added the T: API Breaking Breaking changes that impact APIs and the SDK only (not state machine). label Aug 16, 2018
@jackzampolin
Copy link
Member

I'm going to also push some commits here.

@codecov
Copy link

codecov bot commented Aug 16, 2018

Codecov Report

Merging #2066 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #2066   +/-   ##
========================================
  Coverage    64.86%   64.86%           
========================================
  Files          115      115           
  Lines         6863     6863           
========================================
  Hits          4452     4452           
  Misses        2127     2127           
  Partials       284      284

@jackzampolin
Copy link
Member

Ok I've made some changes here and started to add the actual POST body json schema as well as a couple of formatting changes. Would love to hear your thoughts here, also we need to fix all of the stuff marked TODO in there. Hit me up tomorrow and we can talk through it.

fedekunze
fedekunze commented Aug 17, 2018
View reviewed changes
docs/light/api.md Outdated

Functionality: Submit or edit a delegation.

> NOTE: Should this be a PUT instead of a POST? the code indicates that this is an edit operation
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@jackzampolin I think the idea is to split this function into several ones, but I agree

fedekunze
fedekunze commented Aug 17, 2018
View reviewed changes
docs/light/api.md Outdated

Functionality: Create a transfer in the bank module.

Parameters:
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@jackzampolin Should we get rid of the parameter table ? I think they are useful and combined with the Post body would make it more clear for the end user

fedekunze
fedekunze commented Aug 17, 2018
View reviewed changes
docs/light/api.md Outdated

POST Body:

```js
Copy link
Collaborator Author

@fedekunze fedekunze Aug 17, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

json format instead

@fedekunze fedekunze mentioned this pull request Aug 20, 2018
Merged
9 tasks
jackzampolin
jackzampolin approved these changes Aug 21, 2018
View reviewed changes
Copy link
Member

@jackzampolin jackzampolin left a comment

Choose a reason for hiding this comment

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

Just that one comment to add links to the top, but otherwise its ready to go.

docs/light/api.md Outdated
* ICS20 (TokenAPI)
* ICS21 (StakingAPI) - not yet implemented
* ICS22 (GovernanceAPI) - not yet implemented
- ICS0 (TendermintAPI)
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we add links to the rest of the document here?

@jackzampolin jackzampolin changed the title WIP: Rename LCD endpoints R4R: Rename LCD endpoints Aug 21, 2018
@jackzampolin
Copy link
Member

I think this ready for final review here. Great work @fedekunze

@fedekunze fedekunze added T:Docs Changes and features related to documentation. and removed T: API Breaking Breaking changes that impact APIs and the SDK only (not state machine). labels Aug 21, 2018
@fedekunze fedekunze changed the title R4R: Rename LCD endpoints R4R: Rename LCD endpoints (Docs) Aug 21, 2018
@fedekunze fedekunze mentioned this pull request Aug 21, 2018
Closed
4 tasks
cwgoes
cwgoes approved these changes Aug 21, 2018
View reviewed changes
Copy link
Contributor

@cwgoes cwgoes left a comment

Choose a reason for hiding this comment

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

utACK

@cwgoes cwgoes merged commit 011e61a into develop Aug 21, 2018
@cwgoes cwgoes deleted the fedekunze/1979-rename-endpoints branch August 21, 2018 14:00
@jackzampolin jackzampolin mentioned this pull request Aug 21, 2018
Closed
51 tasks
This was referenced Aug 21, 2018
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jackzampolin jackzampolin jackzampolin approved these changes

@cwgoes cwgoes cwgoes approved these changes

@zramsay zramsay Awaiting requested review from zramsay

Assignees

@jackzampolin jackzampolin

@fedekunze fedekunze

Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fedekunze @jackzampolin @cwgoes