Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-09 21:14:09 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #1571 from turt2live/travis/general/number-to-int

Browse source 
Replace applicable types of 'number' to 'integer'
This commit is contained in:
Travis Ralston 2018-08-28 07:40:28 -06:00 committed by GitHub
parent e4f8c23972 439b9d2925
commit 6cdb463829
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 32 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
api/client-server/admin.yaml
View file

@ -105,7 +105,8 @@ paths:
type: string type: string
description: Most recently seen IP address of the session. description: Most recently seen IP address of the session.
last_seen: last_seen:
type: number type: integer
format: int64
description: Unix timestamp that the session was last active. description: Unix timestamp that the session was last active.
user_agent: user_agent:
type: string type: string

9
api/client-server/content-repo.yaml
View file

@ -259,7 +259,8 @@ paths:
description: "The URL to get a preview of" description: "The URL to get a preview of"
required: true required: true
- in: query - in: query
type: number type: integer
format: int64
x-example: 1510610716656 x-example: 1510610716656
name: ts name: ts
description: |- description: |-
@ -276,7 +277,8 @@ paths:
type: object type: object
properties: properties:
"matrix:image:size": "matrix:image:size":
type: number type: integer
format: int64
description: |- description: |-
The byte-size of the image. Omitted if there is no image attached. The byte-size of the image. Omitted if there is no image attached.
"og:image": "og:image":
@ -324,7 +326,8 @@ paths:
type: object type: object
properties: properties:
m.upload.size: m.upload.size:
type: number type: integer
format: int64
description: |- description: |-
The maximum size an upload can be in bytes. The maximum size an upload can be in bytes.
Clients SHOULD use this as a guide when uploading content. Clients SHOULD use this as a guide when uploading content.

4
api/client-server/definitions/public_rooms_response.yaml
View file

@ -45,7 +45,7 @@ properties:
description: |- description: |-
The name of the room, if any. The name of the room, if any.
num_joined_members: num_joined_members:
type: number type: integer
description: |- description: |-
The number of members joined to the room. The number of members joined to the room.
room_id: room_id:
@ -82,7 +82,7 @@ properties:
absence of this token means there are no results before this absence of this token means there are no results before this
batch, i.e. this is the first batch. batch, i.e. this is the first batch.
total_room_count_estimate: total_room_count_estimate:
type: number type: integer
description: |- description: |-
An estimate on the total number of public rooms, if the An estimate on the total number of public rooms, if the
server has an estimate. server has an estimate.

8
api/client-server/list_public_rooms.yaml
View file

@ -123,7 +123,7 @@ paths:
parameters: parameters:
- in: query - in: query
name: limit name: limit
type: number type: integer
description: |- description: |-
Limit the number of results returned. Limit the number of results returned.
- in: query - in: query
@ -173,7 +173,7 @@ paths:
type: object type: object
properties: properties:
limit: limit:
type: number type: integer
description: |- description: |-
Limit the number of results returned. Limit the number of results returned.
since: since:
@ -251,7 +251,7 @@ paths:
description: |- description: |-
The name of the room, if any. The name of the room, if any.
num_joined_members: num_joined_members:
type: number type: integer
description: |- description: |-
The number of members joined to the room. The number of members joined to the room.
room_id: room_id:
@ -288,7 +288,7 @@ paths:
absence of this token means there are no results before this absence of this token means there are no results before this
batch, i.e. this is the first batch. batch, i.e. this is the first batch.
total_room_count_estimate: total_room_count_estimate:
type: number type: integer
description: |- description: |-
An estimate on the total number of public rooms, if the An estimate on the total number of public rooms, if the
server has an estimate. server has an estimate.

2
api/client-server/notifications.yaml
View file

@ -45,7 +45,7 @@ paths:
required: false required: false
x-example: "xxxxx" x-example: "xxxxx"
- in: query - in: query
type: number type: integer
name: limit name: limit
description: Limit on the number of events to return in this request. description: Limit on the number of events to return in this request.
required: false required: false

4
api/client-server/registration.yaml
View file

@ -218,7 +218,7 @@ paths:
description: The email address description: The email address
example: "example@example.com" example: "example@example.com"
send_attempt: send_attempt:
type: number type: integer
description: Used to distinguish protocol level retries from requests to re-send the email. description: Used to distinguish protocol level retries from requests to re-send the email.
example: 1 example: 1
required: ["client_secret", "email", "send_attempt"] required: ["client_secret", "email", "send_attempt"]
@ -283,7 +283,7 @@ paths:
description: The phone number. description: The phone number.
example: "example@example.com" example: "example@example.com"
send_attempt: send_attempt:
type: number type: integer
description: Used to distinguish protocol level retries from requests to re-send the SMS message. description: Used to distinguish protocol level retries from requests to re-send the SMS message.
example: 1 example: 1
required: ["client_secret", "country", "phone_number", "send_attempt"] required: ["client_secret", "country", "phone_number", "send_attempt"]

4
api/client-server/search.yaml
View file

@ -180,7 +180,7 @@ paths:
description: Mapping of category name to search criteria. description: Mapping of category name to search criteria.
properties: properties:
count: count:
type: number type: integer
description: An approximate count of the total number of results found. description: An approximate count of the total number of results found.
highlights: highlights:
type: array type: array
@ -198,7 +198,7 @@ paths:
description: The result object. description: The result object.
properties: properties:
rank: rank:
type: number type: integer
description: A number that describes how closely description: A number that describes how closely
this result matches the search. Higher is this result matches the search. Higher is
closer. closer.

2
api/client-server/users.yaml
View file

@ -47,7 +47,7 @@ paths:
description: The term to search for description: The term to search for
example: "foo" example: "foo"
limit: limit:
type: number type: integer
description: The maximum number of results to return (Defaults to 10). description: The maximum number of results to return (Defaults to 10).
example: 10 example: 10
required: ["search_term"] required: ["search_term"]

1
changelogs/client_server/newsfragments/1571.clarification Normal file
View file

@ -0,0 +1 @@
Clarify instances of ``type: number`` in the swagger/OpenAPI schema definitions.

3
event-schemas/schema/core-event-schema/room_event.yaml
View file

@ -16,7 +16,8 @@ properties:
origin_server_ts: origin_server_ts:
description: Timestamp in milliseconds on originating homeserver description: Timestamp in milliseconds on originating homeserver
when this event was sent. when this event was sent.
type: number type: integer
format: int64
unsigned: unsigned:
description: Contains optional extra information about the event. description: Contains optional extra information about the event.
properties: properties:

18
event-schemas/schema/m.room.power_levels
View file

@ -46,10 +46,10 @@ properties:
properties: properties:
ban: ban:
description: The level required to ban a user. Defaults to 50 if unspecified. description: The level required to ban a user. Defaults to 50 if unspecified.
type: number type: integer
events: events:
additionalProperties: additionalProperties:
type: number type: integer
description: The level required to send specific event types. This is a mapping from event type to power level required. description: The level required to send specific event types. This is a mapping from event type to power level required.
title: Event power levels title: Event power levels
type: object type: object
@ -57,25 +57,25 @@ properties:
description: |- description: |-
The default level required to send message events. Can be The default level required to send message events. Can be
overridden by the ``events`` key. Defaults to 0 if unspecified. overridden by the ``events`` key. Defaults to 0 if unspecified.
type: number type: integer
invite: invite:
description: The level required to invite a user. Defaults to 50 if unspecified. description: The level required to invite a user. Defaults to 50 if unspecified.
type: number type: integer
kick: kick:
description: The level required to kick a user. Defaults to 50 if unspecified. description: The level required to kick a user. Defaults to 50 if unspecified.
type: number type: integer
redact: redact:
description: The level required to redact an event. Defaults to 50 if unspecified. description: The level required to redact an event. Defaults to 50 if unspecified.
type: number type: integer
state_default: state_default:
description: |- description: |-
The default level required to send state events. Can be overridden The default level required to send state events. Can be overridden
by the ``events`` key. Defaults to 50 if unspecified, but 0 if by the ``events`` key. Defaults to 50 if unspecified, but 0 if
there is no ``m.room.power_levels`` event at all. there is no ``m.room.power_levels`` event at all.
type: number type: integer
users: users:
additionalProperties: additionalProperties:
type: number type: integer
description: The power levels for specific users. This is a mapping from ``user_id`` to power level for that user. description: The power levels for specific users. This is a mapping from ``user_id`` to power level for that user.
title: User power levels title: User power levels
type: object type: object
@ -84,7 +84,7 @@ properties:
The default power level for every user in the room, unless their The default power level for every user in the room, unless their
``user_id`` is mentioned in the ``users`` key. Defaults to 0 if ``user_id`` is mentioned in the ``users`` key. Defaults to 0 if
unspecified. unspecified.
type: number type: integer
type: object type: object
state_key: state_key:
description: A zero-length string. description: A zero-length string.