Skip to content

[Bug] API docs base URL doesn't match the actual running API path #3

Description

@RlxChap2

Description

The API documentation references an incorrect base path that doesn't match where the API is actually served.

Current behavior

The docs specify an API path that leads to a mismatch requests made following the documented base URL fail or point to the wrong location.

Expected behavior

The docs should reference the correct base URL:

https://api.bonyanoss.org

This is the actual live endpoint where the API is currently running and responding correctly (as shown in the root path response).

Steps to reproduce

  1. Open the API documentation
  2. Copy the base URL listed in the docs
  3. Try to make a request using that base URL
  4. Compare with https://api.bonyanoss.org they don't match

Suggested fix

Update the base URL in the documentation to:

https://api.bonyanoss.org

Make sure all example requests and endpoint paths in the docs are prefixed with this correct base URL.

Impact

Anyone following the docs to integrate with the API will get errors or be directed to the wrong endpoint, which breaks the onboarding experience.

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentation

Type

Fields

No fields configured for Bug.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions