feat: migrate Apiary public API docs to Mintlify with interactive playground - #2
Open
Nitesh-BE wants to merge 16 commits into
Open
feat: migrate Apiary public API docs to Mintlify with interactive playground#2Nitesh-BE wants to merge 16 commits into
Nitesh-BE wants to merge 16 commits into
Conversation
Author: Nitesh M <maddala.nitesh@birdeye.com>
… Report) Author: Nitesh M <maddala.nitesh@birdeye.com>
…onversation, Subscription, Webhook) Author: Nitesh M <maddala.nitesh@birdeye.com>
…le Q&A, Google Services) Author: Nitesh M <maddala.nitesh@birdeye.com>
…eting, Integration) Author: Nitesh M <maddala.nitesh@birdeye.com>
…roducts, Listing (part 1)
…, User, Insight AI, Social, Google Services (part 1)
…Business, Aggregation
…ion, Contact V2, Survey, Employee, Google Q&A (part 1)
…ct, Conversation, Ticketing, Competitor AI, Business Media (part 1)
…AQ, Custom Fields, Subscription, Search AI
Adds the `api` configuration block to docs.json to unlock: - Interactive "Try It" playground on every API reference page - Persistent x-api-key input field (set once, used across all requests) - Correct base URL wired from OpenAPI servers block
Maps every MDX page to its exact "METHOD /path" in the corresponding OpenAPI spec so Mintlify can resolve each operation and render: - Interactive API playground with x-api-key header - Request parameter tables (path, query, header) - Request body schema with field descriptions - Response schema documentation Previously all openapi: values used simplified/guessed paths that did not match any operation in the spec files, causing Mintlify to skip rendering the playground and field docs entirely.
…rences
- Add api-reference/openapi.yaml from master (163 operations, full field
descriptions, request/response schemas, parameter docs, enum values)
- Remove api-reference/openapi-{1..5}.json skeleton files that had empty
object schemas with no field descriptions
- Update docs.json to reference single openapi.yaml instead of 5 split files
- Fix 11 MDX openapi: path values to match exact keys in openapi.yaml:
- update-business: {business_id} -> {businessId}
- delete-business: {business_id} -> {business_Id}
- get-custom-field: add ?locationBizNumber={locationBizNumber} query param
- list-custom-fields: add ?locationBizNumber={locationBizNumber} query param
- add-aggregation-link: {businessId} -> {business_id}
- get-competitor-child-business: {EnterpriseBusinessNumber} -> {EnterpriseCompetitorBusinessId}
- add-products-to-location: PUT -> POST
- remove-products-from-location: PUT -> POST
- get-accuracy-report: add ?page-size=100&start-index=0
- get-sentiment-report: add ?page-size=100&start-index=0
- get-all-ticket-data: add trailing ?
- Add create-child-competitor-enterprise.mdx (POST /v1/signup/competitor/{businessId})
- Add new competitor page to docs.json navigation Competitor group
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
apiary.apibApiKeyAuthglobally and per-operation, withx-api-keyas an explicit required header so the playground always prompts for the API keyChanges
docs.json"Public API"tab (first position) with all 27 navigation groupsapi-reference/openapi-1.json…openapi-5.json) at the root to power the interactive playgroundapi-reference/overview.mdxapiary.apib: base URL, authentication warning, rate limiting, pagination rules with examples, HTTP status codes table, error response format, API groups indexapi-reference/change-logs.mdxapi-reference/openapi-{1..5}.json(5 files, ~150 KB total)ApiKeyAuthsecurity;x-api-keyrequired header on every operationapi-reference/<group>/<endpoint>.mdx(162 files)Test plan
x-api-keyinput fieldGenerated by Claude Code