C2S: Update metadata for new endpoints

This commit is contained in:
Travis Ralston 2024-06-10 16:38:47 -06:00
parent a1e558b461
commit ce861df511

View file

@ -1,5 +1,5 @@
# Copyright 2016 OpenMarket Ltd # Copyright 2016 OpenMarket Ltd
# Copyright 2019 The Matrix.org Foundation C.I.C. # Copyright 2019-2024 The Matrix.org Foundation C.I.C.
# #
# Licensed under the Apache License, Version 2.0 (the "License"); # Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License. # you may not use this file except in compliance with the License.
@ -14,14 +14,14 @@
# limitations under the License. # limitations under the License.
openapi: 3.1.0 openapi: 3.1.0
info: info:
title: Matrix Client-Server Content Repository API title: Matrix Client-Server (Authenticated) Content Repository API
version: 1.0.0 version: 1.0.0
paths: paths:
"/media/v3/download/{serverName}/{mediaId}": "/media/download/{serverName}/{mediaId}":
get: get:
deprecated: true x-addedInMatrixVersion: "1.11"
summary: Download content from the content repository. summary: Download content from the content repository.
operationId: getContent operationId: getContentAuthed
parameters: parameters:
- $ref: '#/components/parameters/serverName' - $ref: '#/components/parameters/serverName'
- $ref: '#/components/parameters/mediaId' - $ref: '#/components/parameters/mediaId'
@ -55,15 +55,15 @@ paths:
$ref: '#/components/responses/notYetUploaded' $ref: '#/components/responses/notYetUploaded'
tags: tags:
- Media - Media
"/media/v3/download/{serverName}/{mediaId}/{fileName}": "/media/download/{serverName}/{mediaId}/{fileName}":
get: get:
deprecated: true x-addedInMatrixVersion: "1.11"
summary: Download content from the content repository overriding the file name summary: Download content from the content repository overriding the file name
description: |- description: |-
This will download content from the content repository (same as This will download content from the content repository (same as
the previous endpoint) but replace the target file name with the one the previous endpoint) but replace the target file name with the one
provided by the caller. provided by the caller.
operationId: getContentOverrideName operationId: getContentOverrideNameAuthed
parameters: parameters:
- $ref: '#/components/parameters/serverName' - $ref: '#/components/parameters/serverName'
- $ref: '#/components/parameters/mediaId' - $ref: '#/components/parameters/mediaId'
@ -106,14 +106,14 @@ paths:
$ref: '#/components/responses/notYetUploaded' $ref: '#/components/responses/notYetUploaded'
tags: tags:
- Media - Media
"/media/v3/thumbnail/{serverName}/{mediaId}": "/media/thumbnail/{serverName}/{mediaId}":
get: get:
deprecated: true x-addedInMatrixVersion: "1.11"
summary: Download a thumbnail of content from the content repository summary: Download a thumbnail of content from the content repository
description: |- description: |-
Download a thumbnail of content from the content repository. Download a thumbnail of content from the content repository.
See the [Thumbnails](/client-server-api/#thumbnails) section for more information. See the [Thumbnails](/client-server-api/#thumbnails) section for more information.
operationId: getContentThumbnail operationId: getContentThumbnailAuthed
parameters: parameters:
- $ref: '#/components/parameters/serverName' - $ref: '#/components/parameters/serverName'
- $ref: '#/components/parameters/mediaId' - $ref: '#/components/parameters/mediaId'
@ -258,9 +258,9 @@ paths:
$ref: '#/components/responses/notYetUploaded' $ref: '#/components/responses/notYetUploaded'
tags: tags:
- Media - Media
/media/v3/preview_url: /media/preview_url:
get: get:
deprecated: true x-addedInMatrixVersion: "1.11"
summary: Get information about a URL for a client summary: Get information about a URL for a client
description: |- description: |-
Get information about a URL for the client. Typically this is called when a Get information about a URL for the client. Typically this is called when a
@ -272,7 +272,7 @@ paths:
do not want to share with the homeserver, and this can mean that the URLs do not want to share with the homeserver, and this can mean that the URLs
being shared should also not be shared with the homeserver. being shared should also not be shared with the homeserver.
{{% /boxes/note %}} {{% /boxes/note %}}
operationId: getUrlPreview operationId: getUrlPreviewAuthed
security: security:
- accessTokenQuery: [] - accessTokenQuery: []
- accessTokenBearer: [] - accessTokenBearer: []
@ -330,9 +330,9 @@ paths:
$ref: '#/components/responses/rateLimited' $ref: '#/components/responses/rateLimited'
tags: tags:
- Media - Media
/media/v3/config: /media/config:
get: get:
deprecated: true x-addedInMatrixVersion: "1.11"
summary: Get the configuration for the content repository. summary: Get the configuration for the content repository.
description: |- description: |-
This endpoint allows clients to retrieve the configuration of the content This endpoint allows clients to retrieve the configuration of the content
@ -347,7 +347,7 @@ paths:
repository APIs, for example, proxies may enforce a lower upload size limit repository APIs, for example, proxies may enforce a lower upload size limit
than is advertised by the server on this endpoint. than is advertised by the server on this endpoint.
{{% /boxes/note %}} {{% /boxes/note %}}
operationId: getConfig operationId: getConfigAuthed
security: security:
- accessTokenQuery: [] - accessTokenQuery: []
- accessTokenBearer: [] - accessTokenBearer: []
@ -386,7 +386,7 @@ servers:
hostname: hostname:
default: localhost:8008 default: localhost:8008
basePath: basePath:
default: /_matrix default: /_matrix/client/v1
components: components:
securitySchemes: securitySchemes:
accessTokenQuery: accessTokenQuery: