Package com.atlassian.adf.model

Annotation Type Documentation

  • @Documented
@Target(TYPE)
public @interface Documentation
    Expresses the library maintainer's opinion of the state of the public documentation for the Atlassian Document Format with regard to the annotated node or mark.

    The Atlassian Document Format (ADF) was originally created as part of the development of Atlassian Stride, the intended successor to HipChat that was later abandoned in favor of a strategic partnership with Slack.

    When Jira began the process of adopting ADF, Stride's existing documentation for it was copied into the Jira Cloud REST API documentation, where it can still be found. The plan was for all products to keep their own copy of this documentation, tailored to the feature set in each product. For example, layoutColumn nodes are a feature of how Confluence uses ADF and are not available in Jira, so Jira does not include them in its copy of the documentation.

    Unfortunately, Stride was divested in the middle of this process, and the copy of the documentation that Jira made in mid-2018 has not been updated since. Worse, none of the other products ever incorporated the Stride copy of the documentation into their own REST APIs, and they all point at either Stride's original URL (which is no longer available) or at Jira's unmaintained copy.

    The good news is that the original source for the documentation still exists and (with a few oversights) has been maintained. We just aren't publishing it anywhere, yet. Hopefully we will fix this soon, but in the meantime, this annotation is intended to help call out where the public documentation is known to fall short.

    See Also:
    Jira Cloud REST API — Atlassian Document Format — Document structure

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String date
      The date on which the documentation was last reviewed.
      Documentation.State state
      A simple status indicator for the health of the public documentation regarding this item.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String comment
      Additional information about the nature of the problem with the existing public documentation.

    • Element Detail

      • state

        Documentation.State state
        A simple status indicator for the health of the public documentation regarding this item.

      • date

        String date
        The date on which the documentation was last reviewed.

      • comment

        String comment
        Additional information about the nature of the problem with the existing public documentation.
        Default:
        ""