Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate Text Description and the Markdown Overview Description in Publisher Portal #874

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

AqeelMuhammad
Copy link
Contributor

@AqeelMuhammad AqeelMuhammad commented Feb 5, 2025

Purpose

This pull request separates the text description and the markdown overview description in the publisher portal.

Problem

When API descriptions are saved as markdown, they are stored as documents. As a result, fetching the API description through product APIs requires at least three API calls, making the process inefficient. Additionally, returning NULL for the description in the API response.

Approach

  • Separate Text Description and Markdown Content
  • Add a new text input field named "Description" under Design Configurations -> Portal Configurations -> Basic Info
  • Replace the "Edit description" button with a "Edit overview markdown" button linking to the markdown content of the API
  • When a user saves changes after adding markdown for the first time, create a new document with otherTypeName as _overview
  • To remove the markdown overview, clear the content and save changes. It will delete the _overview document

Screenshot 2025-02-03 at 09 49 44

image

Copy link

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.

1 participant