Remove references to device-specific push rules.

This commit is contained in:
Patrick Cloke 2024-06-04 21:08:51 -04:00
parent e15a36b0a1
commit 437fad3467

View file

@ -16,38 +16,25 @@ info:
title: Matrix Client-Server Push Rules API
version: 1.0.0
paths:
/pushrules/:
/pushrules/global/:
get:
summary: Retrieve all push rulesets.
summary: Retrieve all push rules.
description: |-
Retrieve all push rulesets for this user. Clients can "drill-down" on
the rulesets by suffixing a `scope` to this path e.g.
`/pushrules/global/`. This will return a subset of this data under the
specified key e.g. the `global` key.
Retrieve all push rules for this user.
operationId: getPushRules
security:
- accessTokenQuery: []
- accessTokenBearer: []
responses:
"200":
description: All the push rulesets for this user.
description: All the push rules for this user.
content:
application/json:
schema:
type: object
required:
- global
properties:
global:
type: object
description: The global ruleset.
title: Ruleset
allOf:
- $ref: definitions/push_ruleset.yaml
$ref: definitions/push_ruleset.yaml
examples:
response:
value: {
"global": {
"content": [
{
"actions": [
@ -234,10 +221,9 @@ paths:
}
]
}
}
tags:
- Push notifications
"/pushrules/{scope}/{kind}/{ruleId}":
"/pushrules/global/{kind}/{ruleId}":
get:
summary: Retrieve a push rule.
description: Retrieve a single specified push rule.
@ -246,13 +232,6 @@ paths:
- accessTokenQuery: []
- accessTokenBearer: []
parameters:
- in: path
name: scope
required: true
description: "`global` to specify global rules."
example: global
schema:
type: string
- in: path
name: kind
required: true
@ -318,13 +297,6 @@ paths:
- accessTokenQuery: []
- accessTokenBearer: []
parameters:
- in: path
name: scope
required: true
description: "`global` to specify global rules."
example: global
schema:
type: string
- in: path
name: kind
required: true
@ -395,13 +367,6 @@ paths:
- accessTokenQuery: []
- accessTokenBearer: []
parameters:
- in: path
name: scope
required: true
description: "`global` to specify global rules."
example: global
schema:
type: string
- in: path
name: kind
required: true
@ -523,7 +488,7 @@ paths:
$ref: definitions/errors/rate_limited.yaml
tags:
- Push notifications
"/pushrules/{scope}/{kind}/{ruleId}/enabled":
"/pushrules/global/{kind}/{ruleId}/enabled":
get:
summary: Get whether a push rule is enabled
description: This endpoint gets whether the specified push rule is enabled.
@ -532,15 +497,6 @@ paths:
- accessTokenQuery: []
- accessTokenBearer: []
parameters:
- in: path
name: scope
required: true
description: |-
Either `global` or `device/<profile_tag>` to specify global
rules or device rules for the given `profile_tag`.
example: global
schema:
type: string
- in: path
name: kind
required: true
@ -604,13 +560,6 @@ paths:
- accessTokenQuery: []
- accessTokenBearer: []
parameters:
- in: path
name: scope
required: true
description: "`global` to specify global rules."
example: global
schema:
type: string
- in: path
name: kind
required: true
@ -674,7 +623,7 @@ paths:
}
tags:
- Push notifications
"/pushrules/{scope}/{kind}/{ruleId}/actions":
"/pushrules/global/{kind}/{ruleId}/actions":
get:
summary: The actions for a push rule
description: This endpoint get the actions for the specified push rule.
@ -683,15 +632,6 @@ paths:
- accessTokenQuery: []
- accessTokenBearer: []
parameters:
- in: path
name: scope
required: true
description: |-
Either `global` or `device/<profile_tag>` to specify global
rules or device rules for the given `profile_tag`.
example: global
schema:
type: string
- in: path
name: kind
required: true
@ -764,13 +704,6 @@ paths:
- accessTokenQuery: []
- accessTokenBearer: []
parameters:
- in: path
name: scope
required: true
description: "`global` to specify global rules."
example: global
schema:
type: string
- in: path
name: kind
required: true