Operations & Troubleshooting

Keeping Firestone Running Smoothly

This section provides practical guidance for operating and troubleshooting firestone workflows.

1. Troubleshooting Generation Failures

Diagnose and fix errors that occur during spec generation (syntax errors, invalid schema).

2. Troubleshooting Validation Errors

Identify and resolve issues where your API implementation doesn't match the generated contract.

3. Understanding OpenAPI Specifications

Interpret Firestone-generated OpenAPI specs and debug output structure.

4. Client & Server Generation

Workflows for using openapi-generator with Firestone outputs.

5. Running in Docker

Using the official Docker image for consistent builds.

6. Swagger UI Server

Operational tips for the built-in --ui-server.

Pages in this section:

• Schema Design
• Multi-Resource APIs
• Security Schemes
• Design Philosophy
• Schema References & Reuse
• Client & Server Generation
• OpenAPI Ecosystem Integration
• Running in Docker
• Security Best Practices
• Custom Templates
• Advanced Pagination & Filtering
• Naming Conventions
• Versioning Strategies
• Using the Integrated Swagger UI Server
• Authentication Patterns
• Generation Failures
• Understanding the Generated OpenAPI Spec
• API Design Principles
• JSON Schema Validation