Skip to content

#521: Draft: JSON-based exchange format for OFT items and reports #580

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

Open
redcatbear wants to merge 3 commits into
base: main
Choose a base branch
from
+769 −0
Open

#521: Draft: JSON-based exchange format for OFT items and reports #580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b9a631a
#521: Draft: JSON-based exchange format for OFT items and reports
redcatbear Aug 23, 2026
7b72942
#521: Draft: JSON-based exchange format for OFT items and reports
redcatbear Aug 23, 2026
062a0c1
Merge remote-tracking branch 'origin/documentation/521_draft-json-bas…
redcatbear Aug 23, 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
Binary file removed doc/OFT-Ideas-and-Proposals.pdf
View file
Open in desktop
Binary file not shown.
112 changes: 112 additions & 0 deletions doc/schemas/example.oftr.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
{
"header": {
"formatVersion": "1.0",
"oftVersion": "4.10.0",
"format": "report",
"reproducible": true,
"parameters": {
"inputs": [
{
"type": "directory", "reference": "relative", "path": "doc"
},
{
"type": "directory", "reference": "relative", "path": "src/main/java"
},
{
"type": "directory", "reference": "relative", "path": "src/test/java"
},
{
"type": "file", "reference": "relative", "path": "pom.xml"
}
],
"output": {
"format": "oftr",
"showOrigin": true,
"newline": "unix"
},
"filters": {
"artifactTypes": ["feat", "req", "dsn"],
"tags": ["import", "export", "report"],
"statuses": ["approved", "proposed"],
"includeUntagged": true
}
}
},
"traceSummary": {
"totalItems": 2,
"passedItems": 0,
"completionPercent": 0,
"directDefects": 1,
"transitiveDefects": 1
},
"items": [
{
"id": "feat~oft.json-based-export~1",
"title": "JSON-based export",
"description": "Export artifacts in JSON format",
"rationale": "This feature allows exporting artifacts in JSON format for better compatibility and integration with other systems.",
"comment": "Deprecates OSPEC format",
"tags": ["export"],
"status": "approved",
"needs": ["req"],
"source": {
"file": "doc/spec/system_requirements.md",
"item": {
"start": {"line": 15, "column": 1},
"end": {"line": 20, "column": 44}
},
"id": {
"range": {
"start": {"line": 15, "column": 1},
"end": {"line": 15, "column": 29}
},
"artifactType": {
"start": {"line": 15, "column": 1},
"end": {"line": 15, "column": 5}
},
"name": {
"start": {"line": 15, "column": 6},
"end": {"line": 15, "column": 27}
},
"revision": {
"start": {"line": 15, "column": 28},
"end": {"line": 15, "column": 29}
}
}
},
"trace": {
"defect": "transitive",
"deepCoverage": "uncovered",
"coveredArtifactTypes": ["req"],
"incomingLinks": [
{
"id": "req~oft.oft-json-header~1",
"status": "coveredShallow"
}
]
}
},
{
"id": "req~oft.oft-json-header~1",
"title": "OFT JSON header",
"description": "Shared header for OFTX and OFTR formats",
"rationale": "Information about how the document was generated and processed.",
"tags": ["export", "report"],
"needs": ["dsn"],
"covers": [
"feat~oft.json-based-export~1"
],
"trace": {
"defect": "direct",
"deepCoverage": "uncovered",
"uncoveredArtifactTypes": ["dsn"],
"outgoingLinks": [
{
"id": "feat~oft.json-based-export~1",
"status": "covers"
}
]
}
}
]
}
83 changes: 83 additions & 0 deletions doc/schemas/example.oftx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
{
"header": {
"formatVersion": "1.0",
"oftVersion": "4.10.0",
"format": "exchange",
"reproducible": true,
"parameters": {
"inputs": [
{
"type": "directory", "reference": "relative", "path": "doc"
},
{
"type": "directory", "reference": "relative", "path": "src/main/java"
},
{
"type": "directory", "reference": "relative", "path": "src/test/java"
},
{
"type": "file", "reference": "relative", "path": "pom.xml"
}
],
"output": {
"format": "oftx",
"showOrigin": true,
"newline": "unix"
},
"filters": {
"artifactTypes": ["feat", "req", "dsn"],
"tags": ["import", "export", "report"],
"statuses": ["approved", "proposed"],
"includeUntagged": true
}
}
},
"items": [
{
"id": "feat~oft.json-based-export~1",
"title": "JSON-based export",
"description": "Export artifacts in JSON format",
"rationale": "This feature allows exporting artifacts in JSON format for better compatibility and integration with other systems.",
"comment": "Deprecates OSPEC format",
"tags": ["export"],
"status": "approved",
"needs": ["req"],
"source": {
"file": "doc/spec/system_requirements.md",
"item": {
"start": {"line": 15, "column": 1},
"end": {"line": 20, "column": 44}
},
"id": {
"range": {
"start": {"line": 15, "column": 1},
"end": {"line": 15, "column": 29}
},
"artifactType": {
"start": {"line": 15, "column": 1},
"end": {"line": 15, "column": 5}
},
"name": {
"start": {"line": 15, "column": 6},
"end": {"line": 15, "column": 27}
},
"revision": {
"start": {"line": 15, "column": 28},
"end": {"line": 15, "column": 29}
}
}
}
},
{
"id": "req~oft.oft-json-header~1",
"title": "OFT JSON header",
"description": "Shared header for OFTX and OFTR formats",
"rationale": "Information about how the document was generated and processed.",
"tags": ["export", "report"],
"needs": ["dsn"],
"covers": [
"feat~oft.json-based-export~1"
]
}
]
}
Loading
Loading