Skip to content

research: OpenAPI Spec Promotion #3

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

Draft
lenileiro wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

research: OpenAPI Spec Promotion #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions .harness/research/promotions/candidate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"id": "cand-001",
"hypothesis_id": "hyp-001",
"title": "OpenAPI Spec Candidate",
"target_files": [
".harness/research/promotions/opportunity.json",
".harness/research/promotions/hypothesis.json",
".harness/research/promotions/candidate.json",
".harness/research/promotions/openapi_spec.json"
]
}
10 changes: 10 additions & 0 deletions .harness/research/promotions/hypothesis.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"id": "hyp-001",
"opportunity_id": "opt-001",
"title": "Automated OpenAPI Spec Generation",
"description": "Verify if using a tool like FastAPI or a decorator-based approach can accurately capture existing REST endpoints.",
"success_criteria": [
"Successful generation of valid OpenAPI 3.0 spec",
"Coverage of >90% of existing endpoints"
]
}
18 changes: 18 additions & 0 deletions .harness/research/promotions/openapi_spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"openapi": "3.0.0",
"info": {
"title": "Research API",
"version": "1.0.0"
},
"paths": {
"/status": {
"get": {
"responses": {
"200": {
"description": "OK"
}
}
}
}
}
}
6 changes: 6 additions & 0 deletions .harness/research/promotions/opportunity.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"id": "opt-001",
"title": "Research Promotion Opportunity: Automated API Documentation Generation",
"description": "Exploring the automated generation of OpenAPI specifications from existing Python codebases to improve developer experience.",
"hypothesis": "Automating OpenAPI spec generation will reduce documentation drift by 50%."
}
Loading