Skip to content

docs: restore missing POST /suggestions API reference section - #1714

Merged
imDarshanGK merged 1 commit into
imDarshanGK:mainfrom
Vaishnavi10706:fix/readme-suggestions-api-reference-v2
Jul 30, 2026
Merged

docs: restore missing POST /suggestions API reference section#1714
imDarshanGK merged 1 commit into
imDarshanGK:mainfrom
Vaishnavi10706:fix/readme-suggestions-api-reference-v2

Conversation

@Vaishnavi10706

Copy link
Copy Markdown
Contributor

Description

This PR fixes a formatting issue in the README.md API Reference.

Changes made

  • Restored the missing ### POST /suggestions/ section heading.
  • Added the endpoint description.
  • Inserted the missing opening ```json code fence.
  • Restored proper Markdown formatting and JSON syntax highlighting for the example response.
  • No API behavior or project code was modified.

Related Issue

Fixes #1709

Type of change

  • Bug fix
  • New feature / enhancement
  • Documentation update
  • Test addition
  • Refactor

Checklist

  • I have read [CONTRIBUTING.md](../CONTRIBUTING.md)
  • My branch is up to date with main
  • I have run pytest -v and all tests pass (not applicable – documentation-only change)
  • I have not introduced duplicate issues or features
  • My PR title follows the format: feat/fix/docs/test: short description
  • I have added tests for new features (Level 2 and 3 issues) (not applicable)
  • No hardcoded secrets or API keys in my code
  • This PR is linked to a GSSoC 2026 issue

Screenshots (if frontend change)

Not applicable.

Test evidence

Documentation-only change. No code or tests were modified.

@imDarshanGK imDarshanGK added type:bug Something is not working type:docs Improvements or additions to documentation type:enhancement Documentation related changes good first issue Beginner friendly tasks gssoc2026 Official GSSoC 2026 issue level:beginner Beginner friendly gssoc:approved type:docs-tests-devops Docs, tests, CI, packaging, and deployment labels Jul 30, 2026
@imDarshanGK
imDarshanGK merged commit 650736e into imDarshanGK:main Jul 30, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

good first issue Beginner friendly tasks gssoc:approved gssoc2026 Official GSSoC 2026 issue level:beginner Beginner friendly type:bug Something is not working type:docs Improvements or additions to documentation type:docs-tests-devops Docs, tests, CI, packaging, and deployment type:enhancement Documentation related changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] README API Reference is missing the \POST /suggestions/` section heading and opening code fence

2 participants