diff --git a/.harness/research/promotions/candidate.json b/.harness/research/promotions/candidate.json new file mode 100644 index 00000000..935cf129 --- /dev/null +++ b/.harness/research/promotions/candidate.json @@ -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" + ] +} diff --git a/.harness/research/promotions/hypothesis.json b/.harness/research/promotions/hypothesis.json new file mode 100644 index 00000000..691e861a --- /dev/null +++ b/.harness/research/promotions/hypothesis.json @@ -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" + ] +} diff --git a/.harness/research/promotions/openapi_spec.json b/.harness/research/promotions/openapi_spec.json new file mode 100644 index 00000000..6bf4708e --- /dev/null +++ b/.harness/research/promotions/openapi_spec.json @@ -0,0 +1,18 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Research API", + "version": "1.0.0" + }, + "paths": { + "/status": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + } + } +} diff --git a/.harness/research/promotions/opportunity.json b/.harness/research/promotions/opportunity.json new file mode 100644 index 00000000..a9bb60ca --- /dev/null +++ b/.harness/research/promotions/opportunity.json @@ -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%." +}