Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-04-28 21:34:09 +02:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Camel case for endpoint variables

Browse source
This commit is contained in:
Tom Foster 2025-02-14 13:47:49 +00:00
parent 17af55ddce
commit 79af78022e
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
data/api/client-server/profile.yaml
View file

@ -16,7 +16,7 @@ info:
title: Matrix Client-Server Profile API title: Matrix Client-Server Profile API
version: 1.0.0 version: 1.0.0
paths: paths:
"/profile/{userId}/{key_name}": "/profile/{userId}/{keyName}":
put: put:
summary: Set the user's profile field. summary: Set the user's profile field.
description: |- description: |-
@ -40,7 +40,7 @@ paths:
schema: schema:
type: string type: string
- in: path - in: path
name: key_name name: keyName
description: The profile field key name to set. description: The profile field key name to set.
required: true required: true
example: "displayname" example: "displayname"
@ -54,7 +54,7 @@ paths:
[Common Namespaced Identifier Grammar](/appendices/#common-namespaced-identifier-grammar). [Common Namespaced Identifier Grammar](/appendices/#common-namespaced-identifier-grammar).
requestBody: requestBody:
description: > description: >
The new profile field value. The JSON object must contain the "key_name" specified in the URL. The new profile field value. The JSON object must contain the `keyName` specified in the URL.
For custom keys, the value may be any valid JSON type. However, if the key is "displayname" For custom keys, the value may be any valid JSON type. However, if the key is "displayname"
or "avatar_url", the value MUST be a string. or "avatar_url", the value MUST be a string.
required: true required: true
@ -140,7 +140,7 @@ paths:
schema: schema:
type: string type: string
- in: path - in: path
name: key_name name: keyName
description: The profile field key name to retrieve. description: The profile field key name to retrieve.
required: true required: true
example: "displayname" example: "displayname"
@ -208,7 +208,7 @@ paths:
schema: schema:
type: string type: string
- in: path - in: path
name: key_name name: keyName
description: The profile field key name to delete. description: The profile field key name to delete.
required: true required: true
example: "displayname" example: "displayname"