Uploaded image for project: 'Confluence Data Center'
  1. Confluence Data Center
  2. CONFSERVER-58434

Rest doc generation is not generating response codes or examples

    XMLWordPrintable

Details

    Description

      We get the following warnings in the log when running:

      mvn clean site -B
      
      [WARNING] Javadoc Warnings
      [WARNING] /Users/slancashire/src/atlassian/confluence/core/confluence/confluence-plugins/confluence-bundled-plugins/confluence-rest-resources/src/main/java/com/atlassian/confluence/rest/resources/AttachmentResource.java:93: warning - @response.representation.200.qname is an unknown tag.
      [WARNING] /Users/slancashire/src/atlassian/confluence/core/confluence/confluence-plugins/confluence-bundled-plugins/confluence-rest-resources/src/main/java/com/atlassian/confluence/rest/resources/AttachmentResource.java:93: warning - @response.representation.200.mediaType is an unknown tag.
      [WARNING] /Users/slancashire/src/atlassian/confluence/core/confluence/confluence-plugins/confluence-bundled-plugins/confluence-rest-resources/src/main/java/com/atlassian/confluence/rest/resources/AttachmentResource.java:93: warning - @response.representation.200.doc is an unknown tag.
      [WARNING] /Users/slancashire/src/atlassian/confluence/core/confluence/confluence-plugins/confluence-bundled-plugins/confluence-rest-resources/src/main/java/com/atlassian/confluence/rest/resources/AttachmentResource.java:93: warning - @response.representation.200.example is an unknown tag.
      [WARNING] /Users/slancashire/src/atlassian/confluence/core/confluence/confluence-plugins/confluence-bundled-plugins/confluence-rest-resources/src/main/java/com/atlassian/confluence/rest/resources/AttachmentResource.java:93: warning - @response.representation.404.doc is an unknown tag.
      ...
      

      We're also seeing a number of errors around doc generation on for the examples:

      [WARNING] [com.sun.istack.SAXException2: unable to marshal type "com.atlassian.confluence.api.model.content.Space" as an element because it is missing an @XmlRootElement annotation]
      

      We're using jackson so that model object definitely does not have an @XmlRootElemenet

      Attachments

        Activity

          People

            cpetchell Petch (Inactive)
            slancashire Steve Lancashire (Inactive)
            Votes:
            1 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: