chore(project-map): regenerate .pi-map artifacts across the repo
This commit is contained in:
Developer
@@ -1,18 +1,18 @@
|
||||
# 2026-05-19-api-documentation/.openspec (index)
|
||||
dir: 2026-05-19-api-documentation/.openspec
|
||||
# openspec/changes/archive/2026-05-19-api-documentation/.openspec (index)
|
||||
dir: openspec/changes/archive/2026-05-19-api-documentation/.openspec
|
||||
|
||||
## role
|
||||
Defines the OpenAPI specification configuration schema for generating API documentation
|
||||
Defines configuration metadata for an archived API documentation specification snapshot
|
||||
## parent
|
||||
index: 2026-05-19-api-documentation/.pi-map.index.md
|
||||
map: 2026-05-19-api-documentation/.pi-map.md
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- config.yaml
|
||||
## links
|
||||
index: 2026-05-19-api-documentation/.openspec/.pi-map.index.md
|
||||
map: 2026-05-19-api-documentation/.openspec/.pi-map.md
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.openspec/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/.openspec/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
# 2026-05-19-api-documentation/.openspec
|
||||
dir: 2026-05-19-api-documentation/.openspec
|
||||
# openspec/changes/archive/2026-05-19-api-documentation/.openspec
|
||||
dir: openspec/changes/archive/2026-05-19-api-documentation/.openspec
|
||||
|
||||
index: 2026-05-19-api-documentation/.openspec/.pi-map.index.md
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.openspec/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Defines the OpenAPI specification configuration schema for generating API documentation
|
||||
Defines configuration metadata for an archived API documentation specification snapshot
|
||||
## files
|
||||
- config.yaml | Defines a configuration file specifying a schema-driven API documentation specification
|
||||
- config.yaml | Defines a basic configuration file specifying a schema type and name for API documentation
|
||||
## arch
|
||||
Schema-driven configuration using YAML to specify API documentation generation parameters and metadata
|
||||
Simple declarative configuration using YAML key-value pairs for schema identification
|
||||
## tags
|
||||
config, defines, configuration, specifying, schema, driven, api, documentation
|
||||
config, defines, basic, configuration, specifying, schema, type, name
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
# 2026-05-19-api-documentation (index)
|
||||
dir: 2026-05-19-api-documentation
|
||||
# openspec/changes/archive/2026-05-19-api-documentation (index)
|
||||
dir: openspec/changes/archive/2026-05-19-api-documentation
|
||||
|
||||
## role
|
||||
Planning and design documents for improving API documentation in a FastAPI-based application.
|
||||
Archive directory preserving historical API documentation improvement proposals and their implementation tracking for a FastAPI project.
|
||||
## parent
|
||||
index: ./.pi-map.index.md
|
||||
map: ./.pi-map.md
|
||||
index: openspec/changes/archive/.pi-map.index.md
|
||||
map: openspec/changes/archive/.pi-map.md
|
||||
## children
|
||||
- 2026-05-19-api-documentation/.openspec
|
||||
index: 2026-05-19-api-documentation/.openspec/.pi-map.index.md
|
||||
map: 2026-05-19-api-documentation/.openspec/.pi-map.md
|
||||
- 2026-05-19-api-documentation/specs
|
||||
index: 2026-05-19-api-documentation/specs/.pi-map.index.md
|
||||
map: 2026-05-19-api-documentation/specs/.pi-map.md
|
||||
- openspec/changes/archive/2026-05-19-api-documentation/.openspec
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.openspec/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/.openspec/.pi-map.md
|
||||
- openspec/changes/archive/2026-05-19-api-documentation/specs
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/specs/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/specs/.pi-map.md
|
||||
## files
|
||||
- design.md
|
||||
- proposal.md
|
||||
- tasks.md
|
||||
## links
|
||||
index: 2026-05-19-api-documentation/.pi-map.index.md
|
||||
map: 2026-05-19-api-documentation/.pi-map.md
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
|
||||
@@ -1,18 +1,18 @@
|
||||
# 2026-05-19-api-documentation
|
||||
dir: 2026-05-19-api-documentation
|
||||
# openspec/changes/archive/2026-05-19-api-documentation
|
||||
dir: openspec/changes/archive/2026-05-19-api-documentation
|
||||
|
||||
index: 2026-05-19-api-documentation/.pi-map.index.md
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Planning and design documents for improving API documentation in a FastAPI-based application.
|
||||
Archive directory preserving historical API documentation improvement proposals and their implementation tracking for a FastAPI project.
|
||||
## files
|
||||
- design.md | Design document outlining API documentation structure, health endpoints, and OpenAPI enhancements for a FastAPI-based application | dep: FastAPI, Pydantic v2, psutil, SQLAlchemy, PostgreSQL, Docker
|
||||
- proposal.md | Proposes a comprehensive API documentation improvement plan for a FastAPI-based project | dep: FastAPI, OpenAPI/Swagger, ReDoc, Pydantic, apps/api/README.md, docs/architecture/decisions/
|
||||
- tasks.md | Project task tracking document for API documentation improvements across health endpoints, endpoint documentation, model documentation, README creation, architecture decisions, and quality gates
|
||||
- design.md | Design document outlining API documentation structure, health endpoints, and architecture decisions for a FastAPI-based application | dep: FastAPI, Pydantic, psutil, SQLAlchemy, PostgreSQL, Docker, OpenAPI/Swagger
|
||||
- proposal.md | Proposes a plan to add comprehensive API documentation, health monitoring, and developer onboarding materials to a FastAPI-based project. | dep: FastAPI, OpenAPI/Swagger, Pydantic, ADR
|
||||
- tasks.md | Tracks completed API documentation tasks across health endpoints, endpoint documentation, model documentation, README creation, architecture decisions, and quality verification for a FastAPI-based project.
|
||||
## arch
|
||||
Documentation-driven development with structured markdown specifications covering OpenAPI enhancements, health endpoint standards, and phased task tracking for documentation quality gates.
|
||||
Document-driven change management using sequential design-proposal-tasks workflow with markdown-based specification and progress tracking.
|
||||
## tags
|
||||
documentation, api, fastapi, design, document, health, endpoints, openapi
|
||||
documentation, fastapi, design, api, health, tasks, endpoints, architecture
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
@@ -1,18 +1,18 @@
|
||||
# 2026-05-19-api-documentation/specs (index)
|
||||
dir: 2026-05-19-api-documentation/specs
|
||||
# openspec/changes/archive/2026-05-19-api-documentation/specs (index)
|
||||
dir: openspec/changes/archive/2026-05-19-api-documentation/specs
|
||||
|
||||
## role
|
||||
Defines API documentation requirements, health endpoint specifications, and documentation standards for a FastAPI-based project
|
||||
Defines API documentation requirements and specifications for health endpoints, auto-generated docs, and developer onboarding materials for a FastAPI-based service
|
||||
## parent
|
||||
index: 2026-05-19-api-documentation/.pi-map.index.md
|
||||
map: 2026-05-19-api-documentation/.pi-map.md
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- spec.md
|
||||
## links
|
||||
index: 2026-05-19-api-documentation/specs/.pi-map.index.md
|
||||
map: 2026-05-19-api-documentation/specs/.pi-map.md
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/specs/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/specs/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
# 2026-05-19-api-documentation/specs
|
||||
dir: 2026-05-19-api-documentation/specs
|
||||
# openspec/changes/archive/2026-05-19-api-documentation/specs
|
||||
dir: openspec/changes/archive/2026-05-19-api-documentation/specs
|
||||
|
||||
index: 2026-05-19-api-documentation/specs/.pi-map.index.md
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/specs/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Defines API documentation requirements, health endpoint specifications, and documentation standards for a FastAPI-based project
|
||||
Defines API documentation requirements and specifications for health endpoints, auto-generated docs, and developer onboarding materials for a FastAPI-based service
|
||||
## files
|
||||
- spec.md | Defines API documentation requirements, health endpoint specifications, and documentation standards for a FastAPI-based project | dep: FastAPI, OpenAPI, Pydantic, Swagger UI, ReDoc
|
||||
- spec.md | Defines API documentation requirements and specifications for health endpoints, auto-generated docs, and developer onboarding materials for a FastAPI-based service | dep: FastAPI, Pydantic, OpenAPI/Swagger, ReDoc
|
||||
## arch
|
||||
Specification-driven documentation approach using markdown-based standards for API contract definition and health check endpoint design
|
||||
Specification-driven documentation architecture using Markdown-based API specs with FastAPI auto-generation patterns for health endpoints and developer onboarding materials
|
||||
## tags
|
||||
documentation, fastapi, spec, defines, api, requirements, health, endpoint
|
||||
fastapi, spec, defines, api, documentation, requirements, specifications, health
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
Reference in New Issue
Block a user