From 3f7afcb122fcbd2c10567440e26f1fa4c585d7a5 Mon Sep 17 00:00:00 2001 From: ChronosX88 Date: Sun, 6 Sep 2020 00:00:59 +0400 Subject: [PATCH] Add info about message types and URN into CPE format document --- ...at.md => cadmium-extension-document-format.md} | 15 ++++++++------- protocol-spec/core.md | 1 - 2 files changed, 8 insertions(+), 8 deletions(-) rename CPPs/{cadmium-proposal-document-format.md => cadmium-extension-document-format.md} (85%) diff --git a/CPPs/cadmium-proposal-document-format.md b/CPPs/cadmium-extension-document-format.md similarity index 85% rename from CPPs/cadmium-proposal-document-format.md rename to CPPs/cadmium-extension-document-format.md index 56a8f24..18b1da0 100644 --- a/CPPs/cadmium-proposal-document-format.md +++ b/CPPs/cadmium-extension-document-format.md @@ -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 diff --git a/protocol-spec/core.md b/protocol-spec/core.md index b6ca02b..39321cf 100644 --- a/protocol-spec/core.md +++ b/protocol-spec/core.md @@ -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