{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Changelog","description":"API documentation for integrating with NovaMed - healthcare partner integration platform","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":"changelog","__idx":0},"children":["Changelog"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All notable changes to the Nimbus OS API will be documented in this file."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The format is based on ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://keepachangelog.com/en/1.0.0/"},"children":["Keep a Changelog"]},","," ","and this project adheres to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://semver.org/spec/v2.0.0.html"},"children":["Semantic Versioning"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"unreleased","__idx":1},"children":["[Unreleased]"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"planned","__idx":2},"children":["Planned"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["OAuth 2.0 authentication support"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Additional webhook event types"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Order cancellation endpoint"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Refill status retrieval endpoint"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"100---2025-01-15","__idx":3},"children":["[1.0.0] - 2025-01-15"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"added","__idx":4},"children":["Added"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Initial API release"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Order creation endpoint (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /orders"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Order retrieval endpoint (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /orders/{orderId}"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Refill creation endpoint (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /refills"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Webhook test endpoint (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /webhooks/test"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["API key authentication"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Idempotency key support"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Webhook event types:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["order.created"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["order.fulfilled"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refill.ready"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Error response format with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sandbox and production environments"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"documentation","__idx":5},"children":["Documentation"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["API reference documentation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Quickstart guide"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Authentication guide"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Order management guide"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Refill workflow guide"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Webhook integration guide"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Error handling guide"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Environment configuration guide"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"versioning","__idx":6},"children":["Versioning"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API uses semantic versioning (MAJOR.MINOR.PATCH):"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["MAJOR"]},": Breaking changes (require code changes)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["MINOR"]},": New features (backward compatible)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PATCH"]},": Bug fixes (backward compatible)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"deprecation-policy","__idx":7},"children":["Deprecation Policy"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We provide at least 6 months notice before deprecating endpoints or features:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Announcement"]},": Deprecation announced in changelog"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Warning period"]},": Deprecation warnings in API responses"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sunset"]},": Endpoint removed after notice period"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"migration-guides","__idx":8},"children":["Migration Guides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Migration guides are provided for breaking changes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"#"},"children":["Version 1.0 Migration Guide"]}," (coming soon)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"support","__idx":9},"children":["Support"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For questions about API changes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"mailto:api@nimbus-os.com"},"children":["API Support"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://developer.nimbus-os.com"},"children":["Developer Portal"]}]}]}]},"headings":[{"value":"Changelog","id":"changelog","depth":1},{"value":"[Unreleased]","id":"unreleased","depth":2},{"value":"Planned","id":"planned","depth":3},{"value":"[1.0.0] - 2025-01-15","id":"100---2025-01-15","depth":2},{"value":"Added","id":"added","depth":3},{"value":"Documentation","id":"documentation","depth":3},{"value":"Versioning","id":"versioning","depth":2},{"value":"Deprecation Policy","id":"deprecation-policy","depth":2},{"value":"Migration Guides","id":"migration-guides","depth":2},{"value":"Support","id":"support","depth":2}],"frontmatter":{"title":"Changelog","description":"API version history and changes","seo":{"title":"Changelog"}},"lastModified":"2025-12-03T10:34:27.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/changelog","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}