Skip to content

Commit 7357bf9

Browse files
ronaldtseronaldtse
committed
chore: cleanup
1 parent ea7f1e3 commit 7357bf9

16 files changed

+265
-146
lines changed

‎.github/workflows/generate.yml‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,10 @@ jobs:
2828
uses: actions-mn/cache@v1
2929

3030
- name: Metanorma generate site
31-
uses: actions-mn/build-and-publish@main
31+
uses: actions-mn/build-and-publish@v2
3232
with:
33-
token: ${{ secrets.GITHUB_TOKEN }}
3433
agree-to-terms: true
35-
34+
destination: gh-pages
3635
deploy:
3736
if: ${{ github.ref == 'refs/heads/main' }}
3837
environment:

‎sources/cc-51022.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ include::sections/02-norm-refs.adoc[]
2727

2828
include::sections/03-terms.adoc[]
2929

30+
include::sections/03-conventions.adoc[]
31+
3032
include::sections/04-server-info-use.adoc[]
3133

3234
include::sections/05-server-info-structure.adoc[]

‎sources/sections-ietf/03-conventions.adoc‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
== Conventions Used in This Document
22

3-
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",
4-
"MAY", and "OPTIONAL" in this document are to be interpreted as described in <<RFC2119>>.
3+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
4+
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
5+
interpreted as described in <<RFC2119>>.
56

67
=== Application
78

8-
An application running on one or more hosts at the network application layer and above. The application may
9-
provide data storage, manipulation, presentation, communication or other capabilities. The application may
10-
use a well defined protocol and is often implemented with a client-server relationship.
9+
An application running on one or more hosts at the network application layer and
10+
above. The application may provide data storage, manipulation, presentation,
11+
communication or other capabilities. The application may use a well defined
12+
protocol and is often implemented with a client-server relationship.
1113

12-
A application will usually implement one or more features which may be defined by standard specifications.
13-
Applications and features may also be constrained by various limits.
14+
A application will usually implement one or more features which may be defined
15+
by standard specifications. Applications and features may also be constrained by
16+
various limits.
1417

1518
Examples of applications are:
1619

17-
* caldav
18-
* email
19-
* File servers
20+
* caldav * email * File servers
2021

2122
=== Feature
2223

23-
A feature is some functionality provided by a application. For example, a DAV based application may provide
24-
the versioning feature.
24+
A feature is some functionality provided by a application. For example, a DAV
25+
based application may provide the versioning feature.
2526

26-
Applications need not support all features that are defined as an optional part of that application. Some
27-
features may depend on the authenticated state and/or the authorization of the authenticated principal.
27+
Applications need not support all features that are defined as an optional part
28+
of that application. Some features may depend on the authenticated state and/or
29+
the authorization of the authenticated principal.
2830

2931
Examples of features are:
3032

‎sources/sections/00-abstract.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[abstract]
22
== Abstract
33

4-
This specification describes a new XML object that can be retrieved from hosts to discover
5-
applications, features and limits for that host or domain.
4+
This specification describes a new XML object that can be retrieved from hosts
5+
to discover applications, features and limits for that host or domain.

‎sources/sections/01-introduction.adoc‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@
33
Any given host on a network may support a number of applications. Each will have
44
limits or optional features. The advertising and discovery of applications,
55
features and limits is often through the use of properties and headers. As the
6-
number of applications and features grows the amount of data and complexity of the
7-
requests grows.
6+
number of applications and features grows the amount of data and complexity of
7+
the requests grows.
88

99
Additionally, headers and properties don't allow for caching mechanisms based on
10-
etags. A client has to fetch all the information and compare with its stored copies
11-
to determine if a application change has taken place.
10+
etags. A client has to fetch all the information and compare with its stored
11+
copies to determine if a application change has taken place.
1212

1313
This specification defines a new XML document type which can be retrieved from a
14-
host and is easily extended to allow the description of complex applications. The
15-
schema as described here only handles basic DAV applications. Other specifications
16-
will extend this specification to define elements for other DAV based applications.
14+
host and is easily extended to allow the description of complex applications.
15+
The schema as described here only handles basic DAV applications. Other
16+
specifications will extend this specification to define elements for other DAV
17+
based applications.

‎sources/sections/01-scope.adoc‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
== Scope
22

3-
//This document specifies a new XML object that can be retrieved from hosts to
4-
//discover applications, features and limits for that host or domain. It defines:
5-
6-
//* A mechanism for retrieving server information
7-
//* A format for describing server capabilities and features
8-
//* A synchronization mechanism to detect server changes
9-
//* XML elements for describing WebDAV and CalDAV features
3+
This specification describes a new XML object that can be retrieved from hosts
4+
to discover applications, features and limits for that host or domain.

‎sources/sections/03-conventions.adoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
== Conventions
2+
3+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
4+
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
5+
interpreted as described in <<RFC2119>>.
6+

‎sources/sections/03-terms.adoc‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
== Terms and definitions
22

3-
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",
4-
"MAY", and "OPTIONAL" in this document are to be interpreted as described in <<RFC2119>>.
5-
63
=== Application
74

8-
An application running on one or more hosts at the network application layer and above. The application may
9-
provide data storage, manipulation, presentation, communication or other capabilities. The application may
10-
use a well defined protocol and is often implemented with a client-server relationship.
5+
An application running on one or more hosts at the network application layer and
6+
above. The application may provide data storage, manipulation, presentation,
7+
communication or other capabilities. The application may use a well defined
8+
protocol and is often implemented with a client-server relationship.
119

12-
A application will usually implement one or more features which may be defined by standard specifications.
13-
Applications and features may also be constrained by various limits.
10+
A application will usually implement one or more features which may be defined
11+
by standard specifications. Applications and features may also be constrained by
12+
various limits.
1413

1514
Examples of applications are:
1615

@@ -20,11 +19,12 @@ Examples of applications are:
2019

2120
=== Feature
2221

23-
A feature is some functionality provided by a application. For example, a DAV based application may provide
24-
the versioning feature.
22+
A feature is some functionality provided by a application. For example, a DAV
23+
based application may provide the versioning feature.
2524

26-
Applications need not support all features that are defined as an optional part of that application. Some
27-
features may depend on the authenticated state and/or the authorization of the authenticated principal.
25+
Applications need not support all features that are defined as an optional part
26+
of that application. Some features may depend on the authenticated state and/or
27+
the authorization of the authenticated principal.
2828

2929
Examples of features are:
3030

‎sources/sections/04-server-info-use.adoc‎

Lines changed: 45 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,84 @@
11
== Server Information Document Use
22

3-
A host will make the document available through one or more methods. Depending upon the endpoint and
4-
method of retrieval the retrieved document may describe one or more applications.
3+
A host will make the document available through one or more methods. Depending
4+
upon the endpoint and method of retrieval the retrieved document may describe
5+
one or more applications.
56

6-
If a document provides information for more than one application it SHOULD contain information allowing
7-
clients to obtain information about each individual application only. This allows a client to determine
8-
what the actual limits and features are for the specific application.
7+
If a document provides information for more than one application it SHOULD
8+
contain information allowing clients to obtain information about each individual
9+
application only. This allows a client to determine what the actual limits and
10+
features are for the specific application.
911

1012
=== Server Information Location and Retrieval
1113

1214
==== Server Information Retrieval
1315

14-
The document may be retrieved from the server by including the server-info-token header field with a
15-
value of "*" any request to the server.
16+
The document may be retrieved from the server by including the server-info-token
17+
header field with a value of "*" any request to the server.
1618

17-
The server MUST respond to such a request by including a LINK header field with a reltype of
18-
"server-info", a token parameter with the current token value and the url being the location of the
19-
document.
19+
The server MUST respond to such a request by including a LINK header field with
20+
a reltype of "server-info", a token parameter with the current token value and
21+
the url being the location of the document.
2022

21-
Following that a GET may be executed by the client against that URL, specifying a content type in the
22-
ACCEPT header field of "application/server-info+xml".
23+
Following that a GET may be executed by the client against that URL, specifying
24+
a content type in the ACCEPT header field of "application/server-info+xml".
2325

24-
Clients SHOULD retrieve the document in the context of a session and applications SHOULD ensure the
25-
context is appropriate. Values in the returned document may differ depending on who is authenticated so a
26-
server SHOULD require authentication before returning server information for an authenticated application.
26+
Clients SHOULD retrieve the document in the context of a session and
27+
applications SHOULD ensure the context is appropriate. Values in the returned
28+
document may differ depending on who is authenticated so a server SHOULD require
29+
authentication before returning server information for an authenticated
30+
application.
2731

2832
==== Server Information Synchronization
2933

30-
While server features may not change frequently it may be important for clients to react rapidly when
31-
server features or limits change. Polling for server feature changes is undesirable so this specification
32-
allows clients to check for such changes during normal operations.
34+
While server features may not change frequently it may be important for clients
35+
to react rapidly when server features or limits change. Polling for server
36+
feature changes is undesirable so this specification allows clients to check for
37+
such changes during normal operations.
3338

34-
Clients SHOULD include the server-info-token header field with the current stored value of the token from
35-
the document in requests to the server.
39+
Clients SHOULD include the server-info-token header field with the current
40+
stored value of the token from the document in requests to the server.
3641

37-
The server MUST add the link header field to the response when the tokens do not match.
42+
The server MUST add the link header field to the response when the tokens do not
43+
match.
3844

3945
===== Header Field: server-info-token
4046

41-
The server-info-token header field takes as a value the current value of the token element in the
42-
server-info document or the value "*".
47+
The server-info-token header field takes as a value the current value of the
48+
token element in the server-info document or the value "*".
4349

44-
This header field may be included in a request at any time a client feels appropriate.
50+
This header field may be included in a request at any time a client feels
51+
appropriate.
4552

4653
===== Header Field: link
4754

48-
The link header field is defined in <<RFC5988>>. The target IRI as defined by that specification will be the
49-
location of the server information document. The "reltype" parameter will have the value "server-info".
55+
The link header field is defined in <<RFC5988>>. The target IRI as defined by
56+
that specification will be the location of the server information document. The
57+
"reltype" parameter will have the value "server-info".
5058

51-
Additionally, there will be a "token" parameter which has a quoted token as the value.
59+
Additionally, there will be a "token" parameter which has a quoted token as the
60+
value.
5261

53-
This header field may be included in a response at any time a server feels appropriate.
62+
This header field may be included in a response at any time a server feels
63+
appropriate.
5464

5565
The link header field MUST be returned in response to:
5666

57-
* An OPTIONS request where the server-info-token header is absent or it's value does not match.
58-
* Any request with the server-info-token header field where the value of the header field does not math
59-
the current token value.
67+
* An OPTIONS request where the server-info-token header is absent or it's value
68+
does not match. * Any request with the server-info-token header field where the
69+
value of the header field does not math the current token value.
6070

6171
The link header field SHOULD be returned when a client:
6272

6373
* Attempts to use an unsupported feature.
6474
* Misuses a feature according to the server info document.
6575
* Exceeds a limit defined in the document.
6676

67-
If the server returns a link header field as part of the response it is an indication to the client that
68-
it SHOULD fetch a new copy of the server information document.
77+
If the server returns a link header field as part of the response it is an
78+
indication to the client that it SHOULD fetch a new copy of the server
79+
information document.
6980

70-
The following is an example of a link header field - folded
71-
to fit on the page
81+
The following is an example of a link header field - folded to fit on the page
7282

7383
[source%unnumbered]
7484
----

‎sources/sections/05-server-info-structure.adoc‎

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
== Server Information Document Structure
22

3-
This specification defines a new XML document type "server-info". All XML elements in this
4-
specification are in the DAV name space.
3+
This specification defines a new XML document type "server-info". All XML
4+
elements in this specification are in the DAV name space.
55

66
=== Server Information server-info element
77

8-
At the top level of the document is a "server-info" element which encloses a change token, an
9-
optional "features" element and an "applications" element:
8+
At the top level of the document is a "server-info" element which encloses a
9+
change token, an optional "features" element and an "applications" element:
1010

1111
[source%unnumbered,xml]
1212
----
@@ -26,27 +26,29 @@ optional "features" element and an "applications" element:
2626
</server-info>
2727
----
2828

29-
If a "features" element appears inside the "server-info" element then the features apply to
30-
all applications.
29+
If a "features" element appears inside the "server-info" element then the
30+
features apply to all applications.
3131

3232
=== Server Information server element
3333

34-
The optional "server" element appears once and contains a name and version for the server. The
35-
values for both those elements is server specific.
34+
The optional "server" element appears once and contains a name and version for
35+
the server. The values for both those elements is server specific.
3636

3737
=== Server Information applications element
3838

39-
The "applications" element appears once and contains 0 or more "application" elements each of
40-
which provides information about a application.
39+
The "applications" element appears once and contains 0 or more "application"
40+
elements each of which provides information about a application.
4141

4242
NOTE: do the applications have to be on the same host? I think not.
4343

4444
==== Server Information application element
4545

46-
The "application" element contains the name and information about the location of that
47-
application and how to obtain a application specific server-info document.
46+
The "application" element contains the name and information about the location
47+
of that application and how to obtain a application specific server-info
48+
document.
4849

49-
It may also contain a "features" element which lists features implemented by that application.
50+
It may also contain a "features" element which lists features implemented by
51+
that application.
5052

5153
For example:
5254

@@ -67,33 +69,33 @@ For example:
6769

6870
=== Server Information features element
6971

70-
The "features" element contains 0 or more elements each specifying a feature supported by that
71-
application.
72+
The "features" element contains 0 or more elements each specifying a feature
73+
supported by that application.
7274

73-
The "features" element may appear within the "server-info" element - in which case it applies
74-
to all applications or it may appear inside a "application" element in which case it only
75-
applies to that application.
75+
The "features" element may appear within the "server-info" element - in which
76+
case it applies to all applications or it may appear inside a "application"
77+
element in which case it only applies to that application.
7678

77-
When a single application is specified the features named SHOULD be accessible for the same
78-
authentication and authorization level.
79+
When a single application is specified the features named SHOULD be accessible
80+
for the same authentication and authorization level.
7981

8082
==== Server Information feature element
8183

82-
A feature is specified by an element defined in this document or by an element defined in the
83-
specification for that feature.
84+
A feature is specified by an element defined in this document or by an element
85+
defined in the specification for that feature.
8486

85-
WebDAV feature elements correspond to, but are not exactly the same as, the elements returned
86-
in the DAV header field.
87+
WebDAV feature elements correspond to, but are not exactly the same as, the
88+
elements returned in the DAV header field.
8789

88-
Some features have no corresponding DAV header field element. This may be because the feature
89-
is not available on all resources. The occurrence of a such a feature simply advertises the
90-
availability of that feature on some resources.
90+
Some features have no corresponding DAV header field element. This may be
91+
because the feature is not available on all resources. The occurrence of a such
92+
a feature simply advertises the availability of that feature on some resources.
9193

92-
For an application supporting this specification, the absence of a feature means that this
93-
feature is NOT supported on any resource.
94+
For an application supporting this specification, the absence of a feature means
95+
that this feature is NOT supported on any resource.
9496

95-
For example, a calendar application may return the following which specifies a global set of
96-
features:
97+
For example, a calendar application may return the following which specifies a
98+
global set of features:
9799

98100
[source%unnumbered,xml]
99101
----

0 commit comments

Comments
 (0)