Rust · 0.1.0

Get User

GET /api/v1/users/{user}

UserService · UserService_GetUser

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Anonymous calls are allowed only when the instance permits public access. Authenticated calls remain subject to resource visibility and operation-specific filtering.

Usernames and projection

The path segment is the exact username. The server projects account fields according to the caller; a public read is not a dump of private account data. The declared readMask is currently ignored.

Request

GetUser gets a user by username. Format: users/{user} (e.g., users/steven)

GET/api/v1/users/{user}

Parameters

Name / location	Type / requirement	Description
`user` path	string Required	The user id.
`readMask` query	string (field-mask) Not marked required in OpenAPI	Optional. The fields to return in the response. If not specified, all fields are returned.

Request body

No request body is declared.

Responses

200 · OK

application/json · User

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition

{
  "tags": [
    "UserService"
  ],
  "description": "GetUser gets a user by username.\n Format: users/{user} (e.g., users/steven)",
  "operationId": "UserService_GetUser",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "readMask",
      "in": "query",
      "description": "Optional. The fields to return in the response.\n If not specified, all fields are returned.",
      "schema": {
        "type": "string",
        "format": "field-mask"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/User"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}