Purpose
From the last developer meeting there is an emerging concensus that a public APIs need to be formally declared and maintained in uPortal. This may include uPortal2 and by all means should include uPortal3. This page discusses the process for identifying, maintaining and changing public APIs.
Identifying public APIs
Maintaining a public API carries a cost, so it would be optimal to minimize the number of public APIs.
One alternative is to make APIs public only if an articulated request for doing so is made.
Guidelines
Maintaining public APIs
Package structure
Public APIs will be deployed in a separate JAR file (e.g. up-api-3.1.jar). This enables developers writing modules for uP3 by importing just the API library.
Documentation and revision tracking
Changing public APIs
The process for introducing changes to the existing public API should involve discussion of the functional features that changes are aimed at accomplishing. Generally the changes will be introduced only if the desired functional features can not be implemented reasonably well using the existing API. More specific guidelines and procedures will need to be developedWe moved this discussion to uPortal Published API Strategy.