Skip to content

[Bug Report: Documentation Errors] UserID Parameter Missing from GET /user/{userId} #48

Open
@gnosticdev

Description

@gnosticdev

🐛 Describe the Bug

Missing userId path parameter in /users/{userId} endpoint

The OpenAPI spec for the GET /users/{userId} endpoint is missing a required userId path parameter definition.

File:
users.json#L198–L280


Issue:
The endpoint path includes {userId}, but there is no corresponding "in": "path" parameter defined in the parameters array. This can cause OpenAPI validators and client generators to fail.

📍 API Endpoint

/api/v2/users/{useId}

✅ Expected Behavior

Expected fix:
Add the following to the parameters array:

{
  "name": "userId",
  "in": "path",
  "required": true,
  "description": "The ID of the user",
  "schema": {
    "type": "string"
  }
}

### 💻 Screenshots or Code Samples

_No response_

### Product Area

contacts

### 🧠 Additional Context

**Note** the users product area is not available in the dropdown for this

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions