Skip to content

CLI docs examples use unsupported flags and sort values #372

@JONASXZB

Description

@JONASXZB

The CLI docs page currently has examples that do not match actual CLI/API behavior:

ugig gigs list --min-budget 500 --max-budget 5000
# Sort options: recent, budget_high, budget_low
ugig feed --sort trending

Actual behavior:

  • ugig gigs list defines --budget-min / --budget-max
  • gig sort values are newest, oldest, budget_high, budget_low
  • feed sort values are hot, new, top, rising in the CLI, with the API also accepting following

Relevant files:

  • cli/src/commands/gigs.ts
  • cli/src/commands/feed.ts
  • cli/src/shared/validations.ts
  • src/lib/validations.ts

Live API checks:

curl "https://ugig.net/api/gigs?sort=recent&limit=1"
# 400: Invalid option: expected one of "newest"|"oldest"|"budget_high"|"budget_low"

curl "https://ugig.net/api/feed?sort=trending&limit=1"
# 400: Invalid option: expected one of "hot"|"new"|"top"|"rising"|"following"

Expected: the docs should only show implemented flags and accepted sort values so users do not copy invalid examples.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions