Skip to content

Docs: Update developer API products list and fix Stoplight URL (MRNA-2298)#657

Open
haleyserrano wants to merge 2 commits into
masterfrom
claude/adoring-meitner-gdq5g1
Open

Docs: Update developer API products list and fix Stoplight URL (MRNA-2298)#657
haleyserrano wants to merge 2 commits into
masterfrom
claude/adoring-meitner-gdq5g1

Conversation

@haleyserrano

Copy link
Copy Markdown
Contributor

JIRA

MRNA-2298 — Migrate and update Guides content to new portal
Epic: MRNA-2294 — Developer Portal 2.0


Change Classification

Type: Developer portal restructuring — API Reference reorganized by product area
Repo: Partner Center docs only
Business App docs: No changes needed (no developer portal references exist there)


Summary of Changes

1. docusaurus/docs/administration/advanced/developer-apis/apis-and-environment.mdx

Existing doc updated.

The ## Available Product APIs section reflected the old Stoplight-era API surface and was missing several products now available in the restructured API Reference. Updated to match the product-area-based organization introduced in the new developer-center-docs portal:

  • Foundational APIs: Platform APIs, Business APIs
  • Product APIs: CRM (v1/v2), Reputation (v1/v2), Social (v1/v2), Advertising Intelligence, Customer Voice, Local SEO, SCIM, Meetings, Conversation, Sales Orders, Listing Products

Also removed the "Products Without Current API Access" list, which was incomplete and inaccurate given the expanded API surface.

Updated the "Which products have API access?" FAQ entry to match.

2. docusaurus/docs/vendor-center/vendor-onboarding-guide/technical-requirements.mdx

Existing doc updated.

Replaced the Stoplight hash URL https://developers.vendasta.com/vendor/2e2cafd289899-getting-started with the stable vendor root https://developers.vendasta.com/vendor. Stoplight hash IDs are an artifact of the old portal and will not survive the upcoming cutover to the new Docusaurus portal.


Placement Reasoning

Both files already existed and were the correct home for these updates. No new pages were created.


Acceptance Criteria Coverage

Criterion Addressed
Copy existing guides into new portal Reflected in updated API surface list
API Reference restructured by product area apis-and-environment.mdx updated
Old Stoplight links cleaned up technical-requirements.mdx hash URL replaced

Figma / Images

No visual inputs provided or applicable.


Assumptions & Limitations

  • The new developer-center-docs portal is currently at a demo URL only; developers.vendasta.com still serves the old Stoplight portal. The Partner Center docs continue to link to developers.vendasta.com — this is correct. The epic plans 301 redirects so all existing links will resolve correctly after cutover.
  • Stoplight hash URLs in service-vendor-requirements.mdx (SSO, Executive Report, File Group API) were not changed. Those point to vendor-specific Stoplight docs not yet confirmed as migrated; the epic's 301 redirect plan covers them.
  • The updated API product list is sourced from the sidebar restructuring described in developer-center-docs PR #7.

Skills Used

  • JIRA MCP (getJiraIssue, getAccessibleAtlassianResources)
  • GitHub MCP (search_pull_requests, search_code, get_file_contents, push_files)

@ahnikakuse @haleyserrano @maryam6samadi


Generated by Claude Code

…MRNA-2298)

Reflects the new product-area-based API Reference structure from the
developer-center-docs portal migration. Replaces an unstable Stoplight
hash URL in technical-requirements with the stable vendor root.

@Karthikaarunachalam11 Karthikaarunachalam11 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still api reference section is not yet fixed in the current structure, it may change based on the product level feedback so it worth not to include the new beta portal link in prod till we get confirmation from program

@haleyserrano
haleyserrano marked this pull request as ready for review July 16, 2026 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants