#7829 Webhooks documentation

v1.3.0
closed
General
2015-08-20
2015-02-09
No

With [#4542] we should have docs of how webhooks work (payload examples, secret validation, etc). Can be at https://sourceforge.net/p/forge/documentation/Allura%20API/ or a page in this project's wiki.

Related

Tickets: #4542

Discussion

  • Dave Brondsema

    Dave Brondsema - 2015-02-09
    • labels: docs, sf-current --> docs, sf-current, sf-1
     
  • Dave Brondsema

    Dave Brondsema - 2015-02-10

    Looks like there are some docstrings already for the new webhook classes. We should update Allura/docs/api/ to include them too. (End-user documentation is still the main goal of this ticket, however)

     
  • Dave Brondsema

    Dave Brondsema - 2015-02-12

    Payload examples should be given for each of Git, Hg, and SVN since they do vary somewhat.

     
  • Igor Bondarenko

    Igor Bondarenko - 2015-02-19
    • Owner: Anonymous --> Igor Bondarenko
    • Labels: docs, sf-current, sf-1 --> docs, 42cc, sf-current, sf-1
    • Status: open --> in-progress
     
  • Igor Bondarenko

    Igor Bondarenko - 2015-02-23
    • status: in-progress --> review
     
  • Dave Brondsema

    Dave Brondsema - 2015-02-23

    Nice. I only made a few minor edits to grammar and formatting.

     
    • Igor Bondarenko

      Igor Bondarenko - 2015-02-23

      Thanks! While reviewing the diff I've made another edit

       
  • Dave Brondsema

    Dave Brondsema - 2015-02-23
    • status: review --> closed
    • Reviewer: Dave Brondsema
     
  • Igor Bondarenko

    Igor Bondarenko - 2015-02-24

    Did you forgot to merge ib/7829? (adds webhooks stuff to Allura/docs/api/)

     
    • Dave Brondsema

      Dave Brondsema - 2015-02-24

      Thanks for catching that. I missed that altogether. Merged now. (Plus added a link in extending.rst)

       
  • Dave Brondsema

    Dave Brondsema - 2015-03-09
    • labels: docs, 42cc, sf-current, sf-1 --> docs, 42cc, sf-1
     
  • Igor Bondarenko

    Igor Bondarenko - 2015-06-18
    • Milestone: unreleased --> asf_release_1.3.0
     

Log in to post a comment.