Skip to main content

CODITECT Specification Metadata Extractor

========================================== STATUS: STUB - Not yet implemented VERSION: 0.1.0 (placeholder) AUTHOR: CODITECT Core Team DESCRIPTION: Extracts metadata from specification files (OpenAPI, AsyncAPI, JSON Schema) for documentation and validation purposes. PURPOSE:

  • Parse spec files and extract metadata
  • Generate summary reports
  • Validate spec structure
  • Support multiple spec formats USAGE: ./scripts/spec_metadata.sh [OPTIONS] OPTIONS: -h, --help Show this help message -o, --output Output file (default: stdout) -f, --format Output format (json, yaml, text) --validate Validate spec before extraction SUPPORTED FORMATS:
  • OpenAPI 3.x (JSON/YAML)
  • AsyncAPI 2.x (JSON/YAML)
  • JSON Schema IMPLEMENTATION REQUIREMENTS:
  1. Spec file parsing (jq, yq)
  2. Format detection
  3. Metadata extraction (title, version, endpoints)
  4. Validation integration
  5. Output formatting EXAMPLES: ./scripts/spec_metadata.sh openapi.yaml ./scripts/spec_metadata.sh -f json -o meta.json openapi.yaml ./scripts/spec_metadata.sh --validate asyncapi.yaml SEE ALSO:
  • scripts/generate_openapi.py
  • docs/api/

File: spec_metadata.sh

Type: Shell Script

Usage​

bash spec_metadata.sh
# or
./spec_metadata.sh