search

ustream / openduty

An open source Alerting and incident escalation tool
MIT License
787 stars 188 forks source link

API Documentation wanted. #43

Open netflash opened 8 years ago

netflash commented 8 years ago

Hi, could you please help me a little bit with how to start working with API? I was striving to use this as an example https://developer.pagerduty.com/documentation/rest/services/list

curl -v http://localhost/api/v1/services

but no luck.

I understand that I missing something, just can't understand what :-)

deathowl commented 8 years ago

Hi! No sadly, you dont miss a thing, Services API is not done yet, but I'll do it.

PenguinzPlays commented 8 years ago

Any update on this? If need help I may be able to provide some python or perl help.

deathowl commented 8 years ago

Any help is welcome as at the moment I'm a bit short on time :)

sofixa commented 8 years ago

Just FYI, the company i work at is interested in OpenDuty and we've done some dev to make OpenDuty more usable for our use cases(like various template fixes, finer ACLs, more notification methods, etc.). In a few weeks i plan to submit a PR with all our changes(or at least those that aren't too specific to us). That should include some documentation as well(as other people have noticed, the code base is pretty good, but it isn't very well documented, and that severely hampers usability and extensibility).

I don't imagine it'll take a lot of time to make a services API, and, in any case, we need it as well, so i might look into it, but it won't be for at least another week.

Regards, Adrian

deathowl commented 8 years ago

Good stuff guys, I'm more than glad to welcome your contributions, and do my part in reviewing and merging them if so.

deathowl commented 7 years ago

@sofixa any update on this?

sofixa commented 7 years ago

@deathowl mm kinda.

We have added a lot of stuff(groups, unacknowledge, resolve notifications, some UI stuff(icons, confirmation before deletion), and a few notification methods(HipChat, sms-tools) come to mind, there's more i can't think of now), and we intend to publish everything, but we haven't had the time to properly check, sanitize and document everything so its open sourcable :/ We'll discuss this next week again and i hope we'll find the time.

Besides that, we've been running it in production for a few months now and we're pretty happy.

andr01droth commented 7 years ago

@sofixa do you still plan on publishing your enhancements?

sofixa commented 7 years ago

@andr01droth Yes, but sadly i can't provide an ETA. I'll try to take a look this weekend but can't promise anything.

allahbaksh commented 7 years ago

@sofixa Can you please squeeze some time if possible for this.

sujen commented 7 years ago

@sofixa If you could share the details/PR/documentation you have worked out so far, that would be helpful.. thaks