cadmium-im/cadmium-docs-legacy
1
0
Fork 0
mirror of https://github.com/cadmium-im/cadmium-docs-legacy.git synced 2024-11-08 19:51:02 +00:00
Code Issues Projects Releases Wiki Activity

Add info about message types and URN into CPE format document

Browse Source
This commit is contained in:
ChronosX88 2020-09-06 00:00:59 +04:00
parent 14192dea17
commit 3f7afcb122
Signed by: ChronosXYZ
GPG Key ID: 085A69A82C8C511A
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
CPPs/cadmium-proposal-document-format.md → CPPs/cadmium-extension-document-format.md
View File

@ -1,15 +1,16 @@
# The Sections of a Cadmium Protocol Proposal (CPP) document
# The Sections of a Cadmium Protocol Extension (CPE) document
## Introduction
The introduction to a CPP document should contain description of the extension and example of problems which this extension can solve.
The introduction to a CPE document should contain description of the extension and example of problems which this extension can solve.
## Message type identifiers
In this section, specify the identifiers of the new types of protocol messages (which are introduced by the extension)
In this section, specify the identifiers of the new types of protocol messages (which are introduced by the extension). These types SHOULD be URNs starting with `urn:cadmium` namespace.
## Glossary
If your CE document uses terms that may not be familiar to the reader, please define them in this section.
If your CPE document uses terms that may not be familiar to the reader, please define them in this section.
## Use Cases
@ -61,11 +62,11 @@ An JSON Schema is required in order for protocols to be approved by the Cadmium
## Acknowledgements (optional)
Most CE documents end with a section thanking non-authors who have made significant contributions or who have provided feedback regarding the specification.
Most CPE documents end with a section thanking non-authors who have made significant contributions or who have provided feedback regarding the specification.
## Cadmium Extension Styleguide
## Cadmium Protocol Extension Styleguide
CE document are written in English. It is not expected that you will be a fine prose writer, but try to write in a clear, easily-understood fashion.
CPE document are written in English. It is not expected that you will be a fine prose writer, but try to write in a clear, easily-understood fashion.
### Code Examples

1
protocol-spec/core.md
View File

@ -37,7 +37,6 @@ MUST NOT be empty, and MUST contain only the characters `a-z`, `0-9`, `.`, `_`,
- RoomID SHOULD be UUID identifier.
- Servers MUST use server ID in internal purposes instead of normal server-part with hostname. Only end-users MUST use normal server-part with hostname. This is done for easy multi-domain serving.
- The type of messages SHOULD be URNs starting with `urn:cadmium` namespace.
## BaseMessage