1. OMG Mailing List
  2. APIs for Knowledge Platforms 1.0 FTF

Open Issues

  • Issues not resolved
  • Name: api4kp-ftf
  • Issues Count: 8

Issues Descriptions

Migrate the UML model files for API4KP from UML Designer/Eclipse to MagicDraw

  • Key: API4KP-21
  • Status: open  
  • Source: Thematix Partners LLC ( Elisa Kendall)
  • Summary:

    This issue is strictly against the model files and has limited impact on the specification document. The specification document, which is ptc/21-04-04, should be revised to include the MD diagrams without change to the underlying model under this issue, however.

    Migration is important to improve the model files and gain functionality, including but not limited to canonical XMI generation for UML 2.5.1. The eclipse implementation in UML Designer uses an older version of UML and the eclipse dialect.

    Thus, the artifacts required to resolve this issue include: (1) the revised XMI file, (2) the updated specification document including the revised images, and (3) the corresponding .svg image archive.

  • Reported: API4KP 1.0a1 — Wed, 27 Jul 2022 17:02 GMT
  • Updated: Thu, 17 Nov 2022 23:12 GMT

Use RFC7231 for Error reporting

  • Key: API4KP-17
  • Status: open  
  • Source: Mayo Clinic ( Davide Sottara)
  • Summary:

    The spec defines an api4kp:services:Error datatype class used to wrap error messages.

    A better, and standard, datatype for this very purpose is defined in https://datatracker.ietf.org/doc/html/rfc7231

    Consider aligning

  • Reported: CMMN 1.1 — Wed, 29 Sep 2021 15:51 GMT
  • Updated: Thu, 17 Nov 2022 23:12 GMT

Revise the references to ISO 1087 in the ontologies to reference and use definitions from the latest version

  • Key: API4KP-25
  • Status: open  
  • Source: Thematix Partners LLC ( Elisa Kendall)
  • Summary:

    ISO 1087 was revised in 2019 and our definitions should reflect any relevant changes as well as the references.

    This change impacts the ontologies only, not the specification document.

  • Reported: API4KP 1.0a1 — Fri, 2 Sep 2022 18:54 GMT
  • Updated: Fri, 2 Sep 2022 18:54 GMT

Revise the documentation for the ontologies in Annex A

  • Key: API4KP-23
  • Status: open  
  • Source: Thematix Partners LLC ( Elisa Kendall)
  • Summary:

    This includes any diagram changes required based on changes to the ontologies themselves through migration to the Commons Ontology Library as well as updates to dependency tables, e.g., on page 48, and relevant metadata.

  • Reported: API4KP 1.0b1 — Fri, 2 Sep 2022 18:13 GMT
  • Updated: Fri, 2 Sep 2022 18:13 GMT

Modify the API4KP ontologies to leverage the new Commons Ontology Library

  • Key: API4KP-22
  • Status: open  
  • Source: Thematix Partners LLC ( Elisa Kendall)
  • Summary:

    This issue impacts the ontologies which are described in Annex A. There will be subsequent revisions to the ontologies and thus we will update the documentation in Annex A in a separate issue.

    This is primarily about replacing the URIs of the relevant properties with those in the commons, including the dependencies in the table on page 50.

  • Reported: API4KP 1.0a1 — Fri, 2 Sep 2022 18:10 GMT
  • Updated: Fri, 2 Sep 2022 18:10 GMT

Revise the documentation for datatypes in general

  • Key: API4KP-19
  • Status: open  
  • Source: Thematix Partners LLC ( Elisa Kendall)
  • Summary:

    The API4KP section 7.2.3 is underspecified and should cover all of the datatypes needed for the APIs, including diagrams.

  • Reported: API4KP 1.0b1 — Wed, 27 Jul 2022 16:35 GMT
  • Updated: Wed, 3 Aug 2022 16:29 GMT

Use RFC7231 for error reporting

  • Key: API4KP-18
  • Status: open  
  • Source: Thematix Partners LLC ( Elisa Kendall)
  • Summary:

    The spec defines an api4kp:services:error datatype class used to wrap error messages..

    A better, and standard, datatype for this very purpose is defined in https://datatracker.ietf.org/doc/html/rfc7231. API4KP should reuse this datatype rather than creating something unique that is non-standard.

    The datatype is also missing from the specification document and should be covered therein.

  • Reported: API4KP 1.0b1 — Wed, 27 Jul 2022 16:33 GMT
  • Updated: Wed, 27 Jul 2022 16:33 GMT

Synchronize IDL with UML Model

  • Key: API4KP-1
  • Status: open  
  • Source: Raytheon ( Roy Bell)
  • Summary:

    The IDL should be changed to match the UML model. This includes:
    All sequences are defaulted to infinite range, but many should be [0..1]
    Many structure fields have cardinality [1], but should be [0..1]
    Most IDL sequences are not used and should be removed
    All UML enumerated types should correspond to IDL as enumerated types
    The UML model defines classes with attributes and no operations. They should instead be represented by a simple data structure with fields. If one of these non-behavioral classes uses inheritance; the resulting "subclass" data structure type should contain an additional field that has a type of the "superclass" type.

  • Reported: API4KP 1.0b1 — Thu, 3 Jun 2021 18:23 GMT
  • Updated: Thu, 3 Jun 2021 18:30 GMT