Skip to content

feat: Add enhanced descriptions and metadata support#89

Open
jlouvel wants to merge 1 commit intomainfrom
feat-enh-desc-and-metadata
Open

feat: Add enhanced descriptions and metadata support#89
jlouvel wants to merge 1 commit intomainfrom
feat-enh-desc-and-metadata

Conversation

@jlouvel
Copy link
Contributor

@jlouvel jlouvel commented Mar 3, 2026

Add description fields to API specification elements for improved documentation generation and agent discoverability. Implements metadata extraction utilities for comprehensive capability documentation.

  • Add description field to ApiServerStepSpec and ApiServerCallSpec
  • Create DocumentationMetadata utility for extracting and formatting specs in tests
  • Support description serialization/deserialization in YAML/JSON roundtrips
  • Add 16 comprehensive tests covering metadata extraction and formatting
  • All 110 tests passing with zero regressions

SCOPE:

  • Spec layer: 2 new description fields
  • Tests: 2 test classes (16 tests total),1 new DocumentationMetadata utility with 4 core methods

Add description fields to API specification elements for improved documentation generation and agent discoverability. Implements metadata extraction utilities for comprehensive capability documentation.

- Add description field to ApiServerStepSpec and ApiServerCallSpec
- Create DocumentationMetadata utility for extracting and formatting specs in tests
- Support description serialization/deserialization in YAML/JSON roundtrips
- Add 16 comprehensive tests covering metadata extraction and formatting
- All 110 tests passing with zero regressions

SCOPE:
- Spec layer: 2 new description fields
- Tests: 2 test classes (16 tests total),1 new DocumentationMetadata utility with 4 core methods
@jlouvel jlouvel requested review from eskenazit and jeremnaf March 3, 2026 19:43
@jlouvel jlouvel self-assigned this Mar 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant