diff options
| author | Jonathan Kamens <jik@mit.edu> | 1994-08-18 18:21:38 +0000 |
|---|---|---|
| committer | Jonathan Kamens <jik@mit.edu> | 1994-08-18 18:21:38 +0000 |
| commit | a622d7d648c12d2db69170f962ea5b846b401e86 (patch) | |
| tree | ca7c5bf350c7f33b1bb90b8ba93a9273c7e7797e | |
| parent | f0b2ef019ed2c1e0bcaac33929ed109aaa1d96a6 (diff) | |
Added a section for requirements and put the versioning requirements
in it.
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@4180 dc483132-0cff-0310-8789-dd5450dbe970
| -rw-r--r-- | doc/kadm5/api-funcspec.tex | 31 |
1 files changed, 30 insertions, 1 deletions
diff --git a/doc/kadm5/api-funcspec.tex b/doc/kadm5/api-funcspec.tex index 420f7d20c..408712c0d 100644 --- a/doc/kadm5/api-funcspec.tex +++ b/doc/kadm5/api-funcspec.tex @@ -58,7 +58,36 @@ in the dictionary will not be accepted. The behavior of any function when called with a principal name that is not in the host's local realm is currently undefined. -\section{Admin API} +\section{Admin API requirements} + +\subsection{Versioning} + +The API will include a versioning system aimed at meeting the +following requirements: +\begin{description} +\item[R1] Admin API client applications will be source-code + compatible, whenever possible, with newer versions of the + Admin API. {\bf [high]} +\item[R2] Admin API client applications will be object-code and + shared-library compatible, whenever possible, with newer + versions of the Admin API. {\bf [low]} +\item[R3] Admin API client applications will be protocol compatible, + whenever possible, with newer versions of the Admin server. + I.e., a statically linked Admin API client application will be + able to talk to an Admin server from a later version of + Secure. {\bf [medium]} +\item[R4] Admin API client applications will be protocol compatible, + whenever possible, with older versions of the Admin server. + {\bf [lower than low]} +\item[R5] Changes to the Admin API structures or protocol will, + whenever possible, require only localized changes to the Admin + server source code and Admin API library implementation. {\bf + [medium]} +\end{description} +The present implementation meets requirements R1, R2, and R3, and +partially meets requirement R5. Requirement R4 is not addressed. + +\section{Admin API functional specification} This section describes the Admin API that can be used to maintain principals and policies. It describes the data structures used for |