Skip to content

[Documentation] Missing API Documentation #161

@ramkri123

Description

@ramkri123

Current State

  • No API documentation for microservices
  • Missing OpenAPI/Swagger specs
  • No gRPC API documentation

Issues

  • Difficult to integrate with services
  • Missing API contracts
  • No API versioning documented
  • Unclear request/response formats

Required

  • Create OpenAPI specs for REST APIs:
    • Mobile sensor microservice (/verify endpoint)
    • TPM Plugin Server endpoints
  • Document gRPC APIs (protobuf definitions):
    • SPIRE Workload API
    • SPIRE Server API
  • Add API versioning strategy
  • Document API authentication/authorization
  • Add API examples (request/response)
  • Generate API documentation (Swagger UI, etc.)

Location

  • mobile-sensor-microservice/service.py (needs OpenAPI spec)
  • SPIRE APIs (may already be documented, verify)
  • Keylime APIs

Related

From PRODUCTION_READINESS_ANALYSIS.md - Section 7.2

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions