API refactoring

I could be wrong, but the source code is not for review.

It is wise to read https://www.geni.com/platform/developer/help/terms

But help with the documentation is helpfull.

If you want to review the source code then this not the place or way to offer your help.

Understood. two concerns

One, i offered to assist on this project. i believe i was accepted, but i have not heard further

2nd, api documentation is not clear, and i am hitting a roadblock on a project

I will react by PM as the questions are now not longer in general, but personal.

But in general. On point You joined a project. This was not seen as an offer to assist on this project, but you are member of this project. So it correct that you did not hear further.

2nd the documentation is not part of the project. The project is has other goals. like working with the API. And having discussions about the API. And asking question about the API.

what does join the project mean?

i am a computer engineer, and when i join projects, for the past 35+ years that means working on the project.

i don't have a problem either way, however, the api has bugs, and it does not appear to be designed as per industry best practices

also, where do i report defects with API?

We have another definition of project. It is more group what work together and talk.

I am computer engineer also, so I know that project is working together and share your knowledge. But the goals of this project is not to remove the bugs.

The defects with API can be reported. But not in an open discussion.

One of the goals of this project is to inform.

if you use something like swagger, it could provide much better supporting documentation

Lawrence Smith,

May be you could try to contact Dan Cornett, he might be able to help you a bit more (or know somebody that can help you further)

If you mean with swagger an opensoftware framework, then I have to inform you that the Geni API is not open-source. It is a ground where open source software can be build on.

Yes Dan H. Cornett and others can tell you more about the Geni API.

Just a couple of clarify notes:

1) As noted earlier, a Geni 'project' is not like a technical/business project. A Geni "Project" is simply a software construct to allow a 'connection' or 'collection' of information to be "tied together". In some ways it is similar to a "profile" for a person (in the genealogical sense that it is used on Geni) that "ties together" a variety of data & links to other entities.

'Membership' in a project is to enable collaboration on the "items" associated with that project.

All of that, in a theoretical sense, has nothing to do with the "title" of the Project.

So, joining "The Geni API" project means (solely) that you can help contribute to, add to, and update the 'materials' / 'items' associated with that project.

I can understand the implication that it would have to do with the actual API code, though!

2) Geni is not Open Source; the API is something Geni has 'exposed' to enable programmatic interfaces.

One of the uses of this particular 'Geni Project', though, is as a means for the Geni API developers/maintainers to see what the users of the API have to say & how they might be using it.

3) There are a number of users here who have years of experience working with the Geni API ; my knowledge is more 'theoretical', rather than as a hands-on programming user (at this point). <smile>

Thanks Dan. my knowledge is more theoretical, but that explanation is a good example of pseudo programming language.

Joining "The Geni API" project does also give you notifications on the project discussions which is a discussion group for those interested in the project topic, - i.e. is more narrow and does not drown in the public discussions.

first, i was referring to using swagger to provide better API documentation, refer to https://www.youtube.com/watch?v=xggucT_xl5U

second, i was hoping there be opportunity to provide feedback to improve the APi

i may not know the subject matter as well , however, API could be better aligned with industry best practices

Also, i believe that there may be opportunity to make API more flexible, etc.

from my professional experience , although platform is good, API seems to be alittle more challenging to work with than other APIs i have used in the past.