Skip to content
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.

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

@iso-date attributes have no description of their own #456

Open
nosvalds opened this issue May 17, 2022 · 1 comment
Open

@iso-date attributes have no description of their own #456

nosvalds opened this issue May 17, 2022 · 1 comment

Comments

@nosvalds
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Applications that programmatically use the IATI-Schema will find no description in <xsd:documentation> for @iso-date attributes. An example of this was Datastore Search (Trello). This seems to be the only attribute where this is the case.

Describe the solution you'd like
Ideally we'd also have a simple description in the @iso-date attributes. See how @type is done below.

Describe alternatives you've considered
For now we will probably use the description of the parent element e.g. <activity-date>, however that could be somewhat confusing because that element also describes other attributes like the @type

  <xsd:element name="activity-date">
    <xsd:annotation>
      <xsd:documentation xml:lang="en">
        The planned and actual start and completion dates of the
        activity. Start dates may reflect either the commencement of
        funding, planning or physical activity. End dates should,
        wherever possible, reflect the ending of physical activity.


        The narrative content may contain text (e.g. 2011Q1) for
        accurately recording less specific dates such as month,
        quarter, or year.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element ref="narrative" minOccurs="0" maxOccurs="unbounded" />
        <xsd:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
      </xsd:sequence>
      <xsd:attribute name="type" use="required" type="xsd:string">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
            An IATI code defining the type of activity date being reported.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
      <xsd:attribute name="iso-date" type="xsd:date" use="required"/>
      <xsd:anyAttribute processContents="lax" namespace="##other"/>
    </xsd:complexType>
  </xsd:element>
@akmiller01 akmiller01 transferred this issue from IATI/IATI-Standard-SSOT Oct 21, 2022
@andylolz
Copy link
Contributor

I think this is a duplicate of #331.

#331 (comment) points to some explanation of why these descriptions were removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants