Skip to content

UXCore API fixes: add hy language + replace :ID with slug in API examples #4

@MaryWylde

Description

@MaryWylde

The UX Core API docs contain outdated or inconsistent examples. Update the static content on the UXCore API page.


Main Requirements:

  • Add Armenian language (hy) to the supported languages list
  • Replace :ID with slug in all relevant endpoints and examples

Languages list update
Current docs mention

Versions: ru, en

Should be

Versions: ru, en, hy

UX Core bias endpoints: Use slug instead of :ID

Current

https://api.keepsimple.io/uxcore/:ID
Example: https://api.keepsimple.io/uxcore/:ID?lang=ru

Should be

https://api.keepsimple.io/uxcore/:slug
Example: https://api.keepsimple.io/uxcore/slug?lang=ru

Fix example: get single bias by slug

Current example

GET https://api.keepsimple.io/uxcore/6?field=[link]

Should be

GET https://api.keepsimple.io/uxcore/6-cue-dependent-forgetting?field=[link]

UXCG endpoints: use slug instead of :ID
The following endpoints should all reference slug, not numeric ID:

Current

https://api.keepsimple.io/uxcg/:ID
https://api.keepsimple.io/uxcg/:ID?lang=ru
https://api.keepsimple.io/uxcg/:ID?answers=7

Should be

https://api.keepsimple.io/uxcg/:slug
https://api.keepsimple.io/uxcg/slug?lang=ru
https://api.keepsimple.io/uxcg/slug?answers=7

Fix example: get single UXCG question by slug
Current example
GET https://api.keepsimple.io/uxcg/15?lang=en&answers=0&related_questions=2

Should be
GET https://api.keepsimple.io/uxcg/users-call-our-product-boring?lang=en&answers=0&related_questions=2

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingcontributionFor reporting bugs, issues, or suggestions intended to improve the project.enhancementNew feature or requestgood first issueGood for newcomers

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions