API docs checklist
Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud. Availability This functionality is generally available and ready for production usage. Serverless interfaces and procedures might differ from classic Elastic Stack deployments. The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Serverless
Generally available
Stack
Generally available
Use this checklist to verify the quality, completeness, and consistency of your API docs contributions.
- Include required OpenAPI document info
- Include OpenAPI specification version
- Define unique operation identifiers
- Use consistent tags to group related operations
- Document API lifecycle status (availability, stability, version information)
- Mark deprecated APIs and properties with appropriate notices
- Document required permissions for each operation
- Write clear API operation summaries (between 5-45 characters)
- Write detailed descriptions for operations, parameters, properties, tags, and so on
- Document all parameters and explain how changing defaults affects behavior
- Provide descriptions for non-obvious enum values
- Specify default values for optional parameters
- Include realistic examples with helpful descriptions
- Add links to related operations and documentation
- Preview your changes locally before submitting (see Quickstarts)
- Lint your API docs to identify and fix issues
- Check all links to ensure they work correctly
- Ensure examples are realistic and error-free