extension_explorer/templates/publishers.html: Integrate content from …

…extension template
open-contracting · Jun 26, 2024 · 2a03b33 · 2a03b33
1 parent b2e5fd8
commit 2a03b33
Showing 1 changed file with 27 additions and 1 deletion.
diff --git a/extension_explorer/templates/publishers.html b/extension_explorer/templates/publishers.html
@@ -80,9 +80,35 @@ <h2 id="create-an-extension">
         </p>
 
         <p>
-          {{ _('To create an extension you need to understand <a href="http://json-schema.org/">JSON Schema</a> and the structure of the <a href="https://standard.open-contracting.org/latest/%(lang)s/schema/">OCDS schema</a>. Extensions are fragments of JSON Schema that can be merged into the OCDS schema to create an extended schema.', lang=lang) }}
+          {{ _('To create an extension you need to understand <a href="http://json-schema.org/">JSON Schema</a> and the structure of the <a href="https://standard.open-contracting.org/latest/%(lang)s/schema/">OCDS schema</a>. Extensions are fragments of JSON Schema, known as a <a href="https://tools.ietf.org/html/rfc7386">JSON Merge Patches</a>, that can be merged into the OCDS schema to create an extended schema.', lang=lang) }}
         </p>
 
+        <p>
+          {{ _('An extension's <code>release-schema.json</code> follows the structure of the OCDS schema and describes new and changed fields. For example, to add a new <code>.statusDetails</code> field to <code>Contract</code>:
+          ', lang=lang)}}
+        </p>
+
+        <pre>
+          <code>
+            {
+              "definitions": {
+                  "Contract": {
+                      "properties": {
+                          "statusDetails": {
+                              "title": "Status Details",
+                              "description": "Additional detail on the status of the contract. This field can be used to provide the local name of the status",
+                              "type": [
+                                  "string",
+                                  "null"
+                              ]
+                          }
+                      }
+                  }
+              }
+            }
+          </code>
+        </pre>
+
         <p>
           {{ _('The <a href="https://github.com/open-contracting/standard_extension_template">standard extension template</a> describes the structure and components of an extension and the technical steps to document an extension.', lang=lang) }}
         </p>