{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API Documentation Improvement Plan (v2)","description":"Official Altegio API documentation for integrating online booking, CRM, scheduling, POS, and business management features into your applications.","siteUrl":"https://developer.alteg.io","lang":"en","keywords":["Altegio API","REST API","online booking API","appointment scheduling API","business management API","CRM integration","POS API"],"image":"/assets/og-image.5c9c342f49e4dd72b96f7a0faf29bb71fab6ff06bbf97cf4b230d6fcc0abcdb3.e746d8a7.jpg","meta":[{"name":"author","content":"Altegio"},{"name":"twitter:card","content":"summary_large_image"},{"name":"twitter:site","content":"@altegio"}],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-documentation-improvement-plan-v2","__idx":0},"children":["API Documentation Improvement Plan (v2)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last Updated:"]}," 2026-01-01",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status:"]}," In Progress"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"goals","__idx":1},"children":["Goals"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keep terminology consistent across descriptions while preserving API contracts (paths, field names, enums)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ensure operationIds remain snake_case and aligned with standard entity names."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sanitize example data/placeholders to avoid Russian markers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reorder methods within tags for consistent reader experience."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"current-state","__idx":2},"children":["Current State"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Terminology:"]}," Descriptions use the standard vocabulary (location, team member, appointment, etc.). Continue spot checks, especially when adding new sections."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Operation IDs:"]}," snake_case and terminology-aligned; no pending fixes identified."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example data:"]}," Russian names/icons removed; examples now use neutral/US-style names, phone codes (+1), and non-Russian icons."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method sorting:"]}," Not started. Needs implementation per GitHub-style ordering."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-actions","__idx":3},"children":["Next Actions"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Guardrails for new content"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keep contract fields intact (e.g., legacy ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["master_request"]}," keys), but describe them in English and prefer “team member” in text."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Avoid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".ru"]}," domains, Russian social networks, Cyrillic, Russian area codes/timezones in examples."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Quick checks:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rg '[А-Яа-я]' docs"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rg 'Odnoklassniki|Oksana|Sergei|Sidorov|Olga|Natalia' docs"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method sorting (planned execution)"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Apply GitHub-style order inside each tag: LIST → SEARCH → GET → CREATE → UPDATE → DELETE → SUB-RESOURCES → ACTIONS → DEPRECATED."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["High-priority tags: Loyalty Cards; Products & Inventory; Sales & Payments; Activities & Events; Subscriptions & Certificates; Loyalty Programs; Schedule & Resources."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Exceptions: keep user-journey order for Online Booking; keep auth flow ordering for auth tags; keep logical grouping for Analytics."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Validation after edits"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["make lint"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["make build-dev"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Visual spot-check of reordered tags in the rendered docs."]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"maintenance","__idx":4},"children":["Maintenance"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use US/UK-style names (e.g., Alex Taylor, Sam Carter), phone codes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["+1"]},", and timezones like ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["America/New_York"]}," in samples."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Update this document when method sorting is executed or new guardrails are added."]}]}]},"headings":[{"value":"API Documentation Improvement Plan (v2)","id":"api-documentation-improvement-plan-v2","depth":1},{"value":"Goals","id":"goals","depth":2},{"value":"Current State","id":"current-state","depth":2},{"value":"Next Actions","id":"next-actions","depth":2},{"value":"Maintenance","id":"maintenance","depth":2}],"frontmatter":{"seo":{"title":"API Documentation Improvement Plan (v2)"}},"lastModified":"2026-01-01T12:12:03.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/plans/api_documentation_improvement_plan","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}