﻿---
title: API docs checklist
description: Use this checklist to verify the quality, completeness, and consistency of your API docs contributions. Include required OpenAPI document info, Include...
url: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/5279/contribute-docs/api-docs/checklist
---

# API docs checklist
Use this checklist to verify the quality, completeness, and consistency of your API docs contributions.

## Structure, organization, and metadata

- Include required [OpenAPI document info](/elastic/docs-content/pull/5279/contribute-docs/api-docs/organize-annotate#add-open-api-document-info)
- Include [OpenAPI specification version](/elastic/docs-content/pull/5279/contribute-docs/api-docs/organize-annotate#add-openapi-specification-version)
- Define unique [operation identifiers](/elastic/docs-content/pull/5279/contribute-docs/api-docs/organize-annotate#add-operation-identifiers) using camelCase
- Use consistent [tags](/elastic/docs-content/pull/5279/contribute-docs/api-docs/organize-annotate#group-apis-with-tags) to group related operations
- Document [API lifecycle status](/elastic/docs-content/pull/5279/contribute-docs/api-docs/organize-annotate#specify-api-lifecycle-status) (availability, stability, version information)
- Mark deprecated APIs and properties with appropriate notices
- Document [required permissions](/elastic/docs-content/pull/5279/contribute-docs/api-docs/organize-annotate#document-required-permissions) for each operation


## Content quality and completeness

- Write clear [summaries](/elastic/docs-content/pull/5279/contribute-docs/api-docs/guidelines#write-summaries) (between 5-45 characters)
- Write detailed [descriptions](/elastic/docs-content/pull/5279/contribute-docs/api-docs/guidelines#write-descriptions) for operations, parameters, properties, tags etc.
- Document all [parameters](/elastic/docs-content/pull/5279/contribute-docs/api-docs/guidelines#document-parameters) and explain how changing defaults affects behavior
- Provide descriptions for non-obvious [enum values](/elastic/docs-content/pull/5279/contribute-docs/api-docs/guidelines#document-enum-values)
- Specify [default values](/elastic/docs-content/pull/5279/contribute-docs/api-docs/guidelines#set-default-values) for optional parameters
- Include realistic [examples](/elastic/docs-content/pull/5279/contribute-docs/api-docs/guidelines#add-examples) with helpful descriptions
- Add [links](/elastic/docs-content/pull/5279/contribute-docs/api-docs/guidelines#add-links) to related operations and documentation


## Quality assurance

- Preview your changes locally before submitting (see [Quickstarts](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/5279/contribute-docs/api-docs/quickstart))
- [Lint your API docs](/elastic/docs-content/pull/5279/contribute-docs/api-docs/guidelines#lint-your-api-docs) to identify and fix issues
- Check all links to ensure they work correctly
- Ensure examples are realistic and error-free