Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GET media/config #1189

Merged
merged 18 commits into from
Jul 6, 2018
Merged

GET media/config #1189

Changes from 17 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
2783820
Initial draft of GET media/limits
Half-Shot May 3, 2018
c9abf36
size > upload_size
Half-Shot May 3, 2018
de6fe1b
Add note about auth
Half-Shot May 3, 2018
ffc8ee2
a upload > an upload
Half-Shot May 8, 2018
077cd04
/limits => /config
Half-Shot Jun 20, 2018
6b9640b
upload_size => m.upload.size
Half-Shot Jun 20, 2018
6d0a56d
Suggestions by Travis tend to be sensible ones
Half-Shot Jun 22, 2018
ddc1523
Extending words and rate limiting
Half-Shot Jun 27, 2018
80935ea
Update content-repo.yaml
Half-Shot Jun 27, 2018
eeaf438
Speling is my weakniss
Half-Shot Jun 28, 2018
091b2a6
Hard limit on requiring accessToken. Rephrased some sections
Half-Shot Jun 28, 2018
1820df0
media => content repository
Half-Shot Jun 28, 2018
21e957e
Better note for /config
Half-Shot Jun 28, 2018
41c18be
+repository
Half-Shot Jun 28, 2018
a1309d6
Remove "Clients should handle gracefully" sentence
Half-Shot Jun 29, 2018
d5ce87e
Split summary up into description and summary
Half-Shot Jul 6, 2018
2e6cc80
Better indent of description
Half-Shot Jul 6, 2018
77f4ac5
Wordy intro sentence for description
Half-Shot Jul 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions api/client-server/content-repo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,3 +269,42 @@ paths:
"$ref": "definitions/error.yaml"
tags:
- Media
"/config":
get:
summary: Get the configuration for the content repository.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this isn't a summary! It's messing up the formatting in the swagger UI (https://matrix.org/docs/api/client-server/?url=https%3A%2F%2Fmatrix.org%2Fspeculator%2Fspec%2F1189%2Fapi-docs.json#!/Media/getConfig) : please see the notes at https://github.com/matrix-org/matrix-doc/blob/master/meta/documentation_style.rst#openapi.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh dear, yes. good catch.

description: |-
Clients SHOULD use this as a guide when using content repository endpoints.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

generally we start with a wordy description of the endpoint here. "This endpoint allows clients to retrieve information about the media repository."

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[which makes it read better in the spec doc]

All values are intentionally left optional. Clients SHOULD follow
the advice given in the field description when the field is not available.

**NOTE:** Both clients and server administrators should be aware that proxies
between the client and the server may affect the apparent behaviour of content
repository APIs, for example, proxies may enforce a lower upload size limit
than is advertised by the server on this endpoint.
operationId: getConfig
produces: ["application/json"]
security:
- accessToken: []
responses:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a 429 should be added to indicate rate limiting:

         429:
           description: This request was rate-limited.
           schema:
             "$ref": "definitions/error.yaml"

200:
description: The public content repository configuration for the matrix server.
schema:
type: object
properties:
m.upload.size:
type: number
description: |-
The maximum size an upload can be in bytes.
Clients SHOULD use this as a guide when uploading content.
If not listed or null, the size limit should be treated as unknown.
examples:
application/json: {
"m.upload.size": 50000000
}
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/error.yaml"

tags:
- Media