2022-11

New

• Added PUT /projects/{projectId}/queries/{queryId} operation to enable updating an existing Query. Note that this has not yet been implemented in the pilot and is included in the OpenAPI specification for review and standardization.
• Added GET /projects/{projectId}/commits/{commitId}/elements/{elementId}/projectUsage that returns the ProjectUsage that originates the provided Element
• Updated to 2022-11 metamodel baseline
• Separated response types for operation GET /projects/{projectId}/commits/{compareCommitId}/merge to
  • 201 Created with a response body of the created merge Commit
  • 409 Conflict with a response body of a paginated collection of the DataIdentities that are conflicting

Fixed

• Corrected response for GET /projects/{projectId}/commits/{commitId}/elements/{relatedElementId}/relationships caused by pagination error
• Operations GET /meta/datatypes and GET meta/datatypes/{datatypeId} now include KerML and SysML v2 metamodel types
• Fixed OpenAPI Commit schema examples
• Aligned JSON Schema and OpenAPI specifications with OMG URI standard
• Included pagination parameters for operation GET /projects/{projectId}/commits/{compareCommitId}/diff

2022-11 RC2

2022-11-rc2

2022-11-rc2

2022-11 RC1

2022-11-rc1

2022-11-rc1

2022-10

New

• Upgraded REST API PSM specification to OpenAPI 3.1 from OpenAPI 2. The new specification includes complete JSON Schema definitions and examples for every request and response model used in the API.
• Added JSON Schema definitions for API specific Data realizations, i.e. ProjectUsage, ExternalData, and ExternalRelationship, as returned by operations GET /meta/datatypes and GET /meta/datatypes/{datatypeId}
• Added operations GET /projects/{projectId}/commits/{commitId}/changes and GET /projects/{projectId}/commits/{commitId}/changes/{changeId} to allow for pagination of Commit::change. As a result of these dedicated endpoints, Commit::change is no longer included as a nested list in the response of operation GET /projects/{projectId}/commits/{commitId}.
• Added operation PUT /projects/{projectId}/queries/{queryId} (update query). Note that it has not yet been implemented in the pilot and is included in the OpenAPI specification for review and standardization.
• Added diff and merge operations to the REST API PSM (OpenAPI) specification. Note that these have not yet been implemented in the pilot and are included in the OpenAPI specification for review and standardization.
• Updated to 2022-10 metamodel baseline.

Fixed

• Added Commit::description and Project::created to related request and response models, aligning with the platform independent model (PIM) specification

2022-10 RC3

2022-10-rc3

2022-10-rc3

2022-10 RC2

2022-10-rc2

2022-10-rc2

2022-10 RC1

2022-10-rc1

2022-10-rc1

2022-09

New

• Introduces GET /meta/datatypes (paginated) and GET /meta/datatypes/{datatypeId} operations that provide JSON Schema specifications for the classes in the SysML v2 language metamodel, e.g. Element, Relationship.
• Updated to 2022-09 metamodel baseline.

Fixed

• Enumerations are no longer always uppercase, e.g. the value of VisibilityKind#public in JSON payloads is now public instead of PUBLIC.

2022-08

New

• Updated to 2022-08 metamodel baseline.

Fixed

• Project PUT request no longer ignores fields specified after defaultBranch
• DataVersion responses now include @type field
• OpenAPI specification - Commit.previousCommit type changed from object to array(object)

2022-07

New

• Updated to 2022-07 metamodel baseline.