Skip to content

docs: ESPI 4.0/4.1 schema analysis and implementation tooling for Issue #101 #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dfcoffin merged 2 commits into from
Feb 5, 2026
Merged

docs: ESPI 4.0/4.1 schema analysis and implementation tooling for Issue #101 #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8d589d
docs: Add ESPI 4.0 schema analysis reports for enum implementation (#…
dfcoffin Feb 4, 2026
ffb17ac
Merge main and update ESPI 4.0/4.1 schema analysis with validated cha…
dfcoffin Feb 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
635 changes: 635 additions & 0 deletions CONVERSATIONAL_WORKFLOW_GUIDE.md
View file
Open in desktop

Large diffs are not rendered by default.

419 changes: 419 additions & 0 deletions FILE_LOCATIONS.md
View file
Open in desktop

Large diffs are not rendered by default.

454 changes: 454 additions & 0 deletions GETTING_STARTED.md
View file
Open in desktop

Large diffs are not rendered by default.

1,302 changes: 1,302 additions & 0 deletions ISSUE_101_IMPLEMENTATION_PLAN.md
View file
Open in desktop

Large diffs are not rendered by default.

758 changes: 758 additions & 0 deletions ISSUE_101_IMPLEMENTATION_STRATEGY.md
View file
Open in desktop

Large diffs are not rendered by default.

844 changes: 844 additions & 0 deletions ISSUE_101_TOOLING_GUIDE.md
View file
Open in desktop

Large diffs are not rendered by default.

255 changes: 255 additions & 0 deletions openespi-common/src/main/resources/schema/ESPI_4.1/atom.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,255 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
~ Copyright (c) 2018-2020 Green Button Alliance, Inc.
~
~ Portions copyright (c) 2013-2018 EnergyOS.org
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
<xs:schema xmlns:atom="http://www.w3.org/2005/Atom" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.w3.org/2005/Atom" elementFormDefault="qualified">
<xs:annotation>
<xs:documentation>
This version of the Atom schema is based on version 1.0 of the format specifications,
found here https://tools.ietf.org/pdf/rfc4287.pdf.
</xs:documentation>
</xs:annotation>
<xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="https://www.w3.org/2001/03/xml.xsd"/>
<xs:annotation>
<xs:documentation>
An Atom document may have two root elements, feed and entry, as defined in section 2.
</xs:documentation>
</xs:annotation>
<xs:element name="feed" type="atom:feedType"/>
<xs:element name="entry" type="atom:entryType"/>
<xs:complexType name="textType" mixed="true">
<xs:annotation>
<xs:documentation>
The Atom text construct is defined in section 3.1 of the format spec.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:any namespace="http://www.w3.org/1999/xhtml" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="type">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="text"/>
<xs:enumeration value="html"/>
<xs:enumeration value="xhtml"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:complexType>
<xs:complexType name="personType">
<xs:annotation>
<xs:documentation>
The Atom person construct is defined in section 3.2 of the format spec.
</xs:documentation>
</xs:annotation>
<xs:choice maxOccurs="unbounded">
<xs:element name="name" type="xs:string"/>
<xs:element name="uri" type="atom:uriType" minOccurs="0"/>
<xs:element name="email" type="atom:emailType" minOccurs="0"/>
<xs:any namespace="##other"/>
</xs:choice>
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:complexType>
<xs:simpleType name="emailType">
<xs:annotation>
<xs:documentation>
Schema definition for an email address.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:normalizedString">
<xs:pattern value="\w+@(\w+\.)+\w+"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="feedType">
<xs:annotation>
<xs:documentation>
The Atom feed construct is defined in section 4.1.1 of the format spec.
</xs:documentation>
</xs:annotation>
<xs:choice minOccurs="3" maxOccurs="unbounded">
<xs:element name="author" type="atom:personType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="category" type="atom:categoryType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="contributor" type="atom:personType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="generator" type="atom:generatorType" minOccurs="0"/>
<xs:element name="icon" type="atom:iconType" minOccurs="0"/>
<xs:element name="id" type="atom:idType"/>
<xs:element name="link" type="atom:linkType"/>
<xs:element name="logo" type="atom:logoType" minOccurs="0"/>
<xs:element name="rights" type="atom:textType" minOccurs="0"/>
<xs:element name="subtitle" type="atom:textType" minOccurs="0"/>
<xs:element name="title" type="atom:textType"/>
<xs:element name="updated" type="atom:dateTimeType"/>
<xs:element name="entry" type="atom:entryType" maxOccurs="unbounded"/>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:choice>
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:complexType>
<xs:complexType name="entryType">
<xs:annotation>
<xs:documentation>
The Atom entry construct is defined in section 4.1.2 of the format spec.
</xs:documentation>
</xs:annotation>
<xs:choice maxOccurs="unbounded">
<xs:element name="author" type="atom:personType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="category" type="atom:categoryType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="content" type="atom:contentType" minOccurs="0"/>
<xs:element name="contributor" type="atom:personType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="id" type="atom:idType"/>
<xs:element name="link" type="atom:linkType" minOccurs="2" maxOccurs="unbounded"/>
<xs:element name="published" type="atom:dateTimeType"/>
<xs:element name="rights" type="atom:textType" minOccurs="0"/>
<xs:element name="source" type="atom:textType" minOccurs="0"/>
<xs:element name="summary" type="atom:textType" minOccurs="0"/>
<xs:element name="title" type="atom:textType"/>
<xs:element name="updated" type="atom:dateTimeType"/>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:choice>
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:complexType>
<xs:complexType name="contentType" mixed="true">
<xs:annotation>
<xs:documentation>
The Atom content construct is defined in section 4.1.3 of the format spec.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="type" type="xs:string"/>
<xs:attribute name="src" type="xs:anyURI"/>
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:complexType>
<xs:complexType name="categoryType">
<xs:annotation>
<xs:documentation>
The Atom category construct is defined in section 4.2.2 of the format spec.
</xs:documentation>
</xs:annotation>
<xs:attribute name="term" type="xs:string" use="required"/>
<xs:attribute name="scheme" type="xs:anyURI"/>
<xs:attribute name="label" type="xs:string"/>
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:complexType>
<xs:complexType name="generatorType">
<xs:annotation>
<xs:documentation>
The Atom generator element is defined in section 4.2.4 of the format spec.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="uri" type="xs:anyURI"/>
<xs:attribute name="version" type="xs:string"/>
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="iconType">
<xs:annotation>
<xs:documentation>
The Atom icon construct is defined in section 4.2.5 of the format spec.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:anyURI">
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="idType">
<xs:annotation>
<xs:documentation>
The Atom id construct is defined in section 4.2.6 of the format spec.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:anyURI">
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="linkType" mixed="true">
<xs:annotation>
<xs:documentation>
The Atom link construct is defined in section 3.4 of the format spec.
</xs:documentation>
</xs:annotation>
<xs:attribute name="href" type="xs:anyURI" use="required"/>
<xs:attribute name="rel" type="xs:string" use="required"/>
<xs:attribute name="type" type="xs:string" use="required"/>
<xs:attribute name="hreflang" type="xs:NMTOKEN"/>
<xs:attribute name="title" type="xs:string"/>
<xs:attribute name="length" type="xs:positiveInteger"/>
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:complexType>
<xs:complexType name="logoType">
<xs:annotation>
<xs:documentation>
The Atom logo construct is defined in section 4.2.8 of the format spec.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:anyURI">
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="sourceType">
<xs:annotation>
<xs:documentation>
The Atom source construct is defined in section 4.2.11 of the format spec.
</xs:documentation>
</xs:annotation>
<xs:choice maxOccurs="unbounded">
<xs:element name="author" type="atom:personType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="category" type="atom:categoryType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="contributor" type="atom:personType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="generator" type="atom:generatorType" minOccurs="0"/>
<xs:element name="icon" type="atom:iconType" minOccurs="0"/>
<xs:element name="id" type="atom:idType" minOccurs="0"/>
<xs:element name="link" type="atom:linkType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="logo" type="atom:logoType" minOccurs="0"/>
<xs:element name="rights" type="atom:textType" minOccurs="0"/>
<xs:element name="subtitle" type="atom:textType" minOccurs="0"/>
<xs:element name="title" type="atom:textType" minOccurs="0"/>
<xs:element name="updated" type="atom:dateTimeType" minOccurs="0"/>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:choice>
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:complexType>
<xs:complexType name="uriType">
<xs:simpleContent>
<xs:extension base="xs:anyURI">
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="dateTimeType">
<xs:simpleContent>
<xs:extension base="xs:dateTime">
<xs:attributeGroup ref="atom:commonAttributes"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:attributeGroup name="commonAttributes">
<xs:attribute ref="xml:base"/>
<xs:attribute ref="xml:lang"/>
<xs:anyAttribute namespace="##other"/>
</xs:attributeGroup>
</xs:schema>
Loading
Loading