Uploaded image for project: 'COmanage'
  1. COmanage
  2. CO-2684

Standards based documentation for COmanage Registry APIs

    XMLWordPrintable

Details

    Description

      The COmanage project should plan for and adopt a strategy for using standards based tooling for documenting its APIs, including both the REST API v1, the Core API, and the PE APIs.

      Options include (but are not limited to) JSON Schema and OpenAPI.

      The strategy should take into account other work going on in the community.

      Attachments

        Issue Links

          is related to

          Improvement - An improvement or enhancement to an existing feature or task. CO-2685 Core API message.json description does not reflect the reality of the API

          • Critical - Crashes, loss of data, severe memory leak.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. CO-2686 Add OpenAPI 3.0.3 document for Core API

          • Major - Major loss of function.
          • In Progress

          Improvement - An improvement or enhancement to an existing feature or task. CO-2760 Add OpenAPI 3.0.3 document for REST API v1

          • Major - Major loss of function.
          • In Progress

          Activity

            People

              benn.oshrin@at.internet2.edu Benn Oshrin (internet2.edu)
              scott.koranda@at.internet2.edu Scott Koranda (uwm.edu/illinois.edu)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: