References
Microcks' references
Welcome to Microcks References! Our References section documents the Microcks installation, configuration and usage parameters.
Container Images
All Microcks OCI images (app, async minion, uber, operator, CLI) and how they are signed.
Mock Templates
Every variable, context and function expression usable in dynamic mock templates.
Test Parameters
Test launch parameters: runners, endpoint syntax, timeout, secrets, OAuth2 and headers.
API Metadata Format
APIMetadata format for labels, delays and dispatchers that specs can't express.
API Examples Format
APIExamples format to provide mock datasets without touching the API spec itself.
Testcontainers Modules
API of the official and community Testcontainers modules: mocks, tests and async.
Artifacts Reference
Conventions each supported artifact format must follow to produce mocks and tests.
- OpenAPI Conventions
- AsyncAPI Conventions
- Swagger Conventions
- GraphQL Conventions
- gRPC Conventions
- Postman Conventions
- + 2 more…
Configuration Reference
All configuration knobs: application properties, security, Helm values and Operator CRs.
- Application Configuration
- Security Configuration
- Helm Chart Parameters
- Operator Configuration
API Reference
Microcks' own REST (OpenAPI) and events (AsyncAPI) APIs.
- Microcks' OpenAPI
- Microcks' AsyncAPI
💡 Remember
Contribute to Microcks References
Code isn't the only way to contribute to OSS; Dev Docs are a huge help that benefit the entire OSS ecosystem. At Microcks, we value Doc contributions as much as every other type of contribution. ❤️
To get started as a Docs contributor:
- Familiarize yourself with our project's Contribution Guide and our Code of Conduct
- Head over to our Microcks Docs Board
- Pick an issue you would like to contribute to and leave a comment introducing yourself. This is also the perfect place to leave any questions you may have on how to get started
- If there is no work done in that Docs issue yet, feel free to open a PR and get started!
Docs contributor questions
Do you have a documentation contributor question and you're wondering how to tag me into a GitHub discussion or PR? Have no fear!
Join us on Discord and use the
#documentationchannel to ping us!