Search Retrieval Results

Search Retrieval Results

This directory contains the raw search results from the 47 semantic queries executed against the NZ API Guidelines database via MCP server. These files represent the research phase of the project and served as source material for drafting the final API Standard.

About These Files

Each file contains search results for a specific topic area, with:

  • Search query details (query type, parameters, purpose)
  • Result listings with DocRef citations
  • Content snippets from the database
  • Metadata (part, type, level, tags, similarity scores)

Important: These are raw data files and will be displayed in their original markdown format.

Research Files

File Topic Searches Results Size
01 - Design API design principles and patterns 5 142 28KB
02 - Development REST API, HTTP methods, error handling 7 ~180 23KB
03 - Security OAuth, authentication, TLS, threats 8 ~220 78KB
04 - Deployment Versioning, gateways, releases 6 ~160 57KB
05 - Operations Management, governance, monitoring 8 ~200 33KB
06 - Definitions Term definitions 4 ~100 18KB
07 - Patterns Authentication patterns and examples 4 ~100 18KB
08 - Good Practices Good practice content by topic 7 ~180 44KB

Research Statistics

  • Total searches: 47 semantic queries
  • Total results: ~1,282 individual results
  • Total size: ~300KB of research data
  • Database: 5,612 nodes from NZ API Guidelines
  • Search types used:
    • semantic_search - General queries
    • semantic_search_filtered - Filtered by tags/parts
    • semantic_search_balanced - Cross-part coverage
    • semantic_search_cross_document - Related content

Methodology

The research phase followed a systematic approach:

  1. Topic identification: Identified 8 core topic areas
  2. Query planning: Designed 47 targeted queries
  3. Iterative searching: Started small (5-15 results), expanded based on findings
  4. Tag filtering: Used tags like must-or-shall, good-practice, definition
  5. Part filtering: Ensured coverage across Parts A, B, and C
  6. Save locally: All results saved to files before drafting

How These Were Used

These research files were loaded selectively during the drafting phase:

  • Read ONLY relevant files for each section being written
  • Preserved all DocRef citations from search results
  • Synthesized content while maintaining traceability
  • Tracked all citations in a separate tracker file

Related Documentation