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

Document COSMOS JSON API on cosmosrb.com #341

Closed
ryanatball opened this Issue Oct 6, 2016 · 6 comments

Comments

Projects
None yet
4 participants
@ryanatball
Member

ryanatball commented Oct 6, 2016

No description provided.

@donaldatball

This comment has been minimized.

Show comment
Hide comment
@donaldatball

donaldatball May 23, 2017

Collaborator

@ryanatball @jmthomas I took a first cut at a page documenting the JSON API (see 9a0bc03 ), mostly borrowed from the COSMOS 1 website. I'd prefer not to re-document everything that is already documented in the scripting guide, so I tried to put a few examples and then some verbage pointing back to the scripting guide. What do you guys think? Is this good? Do I need a few more examples? Should I bite the bullet and document every function?

Collaborator

donaldatball commented May 23, 2017

@ryanatball @jmthomas I took a first cut at a page documenting the JSON API (see 9a0bc03 ), mostly borrowed from the COSMOS 1 website. I'd prefer not to re-document everything that is already documented in the scripting guide, so I tried to put a few examples and then some verbage pointing back to the scripting guide. What do you guys think? Is this good? Do I need a few more examples? Should I bite the bullet and document every function?

@ryanatball

This comment has been minimized.

Show comment
Hide comment
@ryanatball

ryanatball May 23, 2017

Member

I think this looks good. Documenting every method is not necessary and I didn't need it when writing the Python version. My only comment is that the order of the fields in the two JSON RPC examples varies between the cmd example and the tlm example. Even though to the software it doesn't matter, keep the order the same in the examples to not confuse people.

Member

ryanatball commented May 23, 2017

I think this looks good. Documenting every method is not necessary and I didn't need it when writing the Python version. My only comment is that the order of the fields in the two JSON RPC examples varies between the cmd example and the tlm example. Even though to the software it doesn't matter, keep the order the same in the examples to not confuse people.

@jasonatball

This comment has been minimized.

Show comment
Hide comment
@jasonatball

jasonatball May 23, 2017

Collaborator

Looks good but please mention the Python version that we've already implemented because that's the first thing someone is going to try. (https://github.com/BallAerospace/python-ballcosmos)

Collaborator

jasonatball commented May 23, 2017

Looks good but please mention the Python version that we've already implemented because that's the first thing someone is going to try. (https://github.com/BallAerospace/python-ballcosmos)

@donaldatball

This comment has been minimized.

Show comment
Hide comment
@donaldatball

donaldatball May 24, 2017

Collaborator

I implemented that changes requested by @ryanatball and @jasonatball. The page is deployed now here: http://cosmosrb.com/docs/json_api/

Collaborator

donaldatball commented May 24, 2017

I implemented that changes requested by @ryanatball and @jasonatball. The page is deployed now here: http://cosmosrb.com/docs/json_api/

@jmthomas

This comment has been minimized.

Show comment
Hide comment
@jmthomas

jmthomas May 25, 2017

Member
Member

jmthomas commented May 25, 2017

@donaldatball

This comment has been minimized.

Show comment
Hide comment
@donaldatball

donaldatball May 25, 2017

Collaborator

@jmthomas Good catch, that was the start of a thought that turned into a new paragraph and never got cleaned up. I just removed that sentence fragment.

Collaborator

donaldatball commented May 25, 2017

@jmthomas Good catch, that was the start of a thought that turned into a new paragraph and never got cleaned up. I just removed that sentence fragment.

@ryanatball ryanatball modified the milestone: v4.0.0 Aug 4, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment