Uploaded image for project: 'Crucible'
  1. Crucible
  2. CRUC-6072

FeCru REST API docs don't provide description of the XML tags.

    XMLWordPrintable

Details

    Description

      Without a precise XML tag description for APIs that demand POST, it may be almost impossible to use some of them.

      A good example is the:

      /rest-service/reviews-v1/{id}/patch
      

      http://docs.atlassian.com/fisheye-crucible/latest/wadl/crucible.html#d2e821

      It demands POST and therefore, input thru XML. However, it just describes the URL parameter (id).

      We need a precise descriptions for each of the XML tags:

      ...
      <anchor>
          <anchorPath>/</anchorPath>
          <anchorRepository>REPO</anchorRepository>
          <stripCount>2</stripCount>
      </anchor>
      ...
      
      Also, the API doc does not mention the fact that the XML must be scaped.
      

      Attachments

        Activity

          People

            mswinarski Maciej Swinarski (Inactive)
            rbattaglin Renan Battaglin
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: