diff options
| author | 2025-03-06 11:31:52 -0500 | |
|---|---|---|
| committer | 2025-03-06 16:31:52 +0000 | |
| commit | 424f62dd70d765673e7cacd5373728ba4762496b (patch) | |
| tree | b94d29d1a97d0a44ed8d14da5cff56f7c036eb5b /docs/api | |
| parent | [bugfix] Return useful err on `server start` failure (#3879) (diff) | |
| download | gotosocial-424f62dd70d765673e7cacd5373728ba4762496b.tar.xz | |
[bugfix] Store and expose status content type (#3870)
* Add ContentType to internal models
* Add ContentType to API models StatusSource and StatusEdit
* Add helpers to convert between API/internal StatusContentType
* Write status content type on create/edit
* Add migration
* Update API docs
go run github.com/go-swagger/go-swagger/cmd/swagger generate spec --scan-models --exclude-deps --output docs/api/swagger.yaml
* ensure ContentType is updated anywhere Text is
* Update docs, take care of TODOs
* Set ContentType in more places where Text is set
* We don't actually use ContentType on the API status model
* Update StatusSource test
* Remove unused helper function I copied
* Revert change to StatusContentType swagger annotation
I'm going to include this in a follow-on PR instead.
* Add test for updating content type in edits
* Return a value from processContentType instead of modifying the existing status
Fixes an issue that was caught by the test I just added - the recorded edit would be marked with the *new* content type instead of the old one, which is obviously bad
* Add test for handling of statuses with no stored content type
* repurpose an existing test status instead of adding a new one to avoid breaking other tests
* Add test to ensure newly created statuses always have content type saved
* Do include content type on status API model actually
This is mostly important when deleting and redrafting.
The comment on `apimodel.Status.Text` implies that it's not sent except in response to status deletion, but actually this doesn't seem to be the case; it also appears to be present in responses to creations and normal fetches and stuff. So I'm treating `ContentType` the same here.
* Update new tests to check content type on API statuses
* Check content type of API statuses in all tests where text is checked
* update other api tests with status content type field
* Add test ensuring text and content type are returned when deleting a status
* Convert processContentType to free function and remove unused parameter
* check for the correct value in the deletion test
* Be explicit about this test status having an empty content type
* Use omitempty consistently on API models
* clean up the final diff a bit
* one more swagger regen for the road
* Handle nil statuses in processContentType
* Don't pass processContentType the entire edit form, it doesn't need it
* Move processContentType to common.go and use for creation as well
* Remove unused parameters to ContentTypeToAPIContentType
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/swagger.yaml | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml index 25b23770c..6d9ca2f95 100644 --- a/docs/api/swagger.yaml +++ b/docs/api/swagger.yaml @@ -2840,6 +2840,13 @@ definitions: example: <p>Hey this is a status!</p> type: string x-go-name: Content + content_type: + description: |- + Content type that was used to parse the status's text. Returned when + status is deleted, so if the user is redrafting the message the client + can default to the same content type. + type: string + x-go-name: ContentType created_at: description: The date when this status was created (ISO 8601 Datetime). example: "2021-07-30T09:20:25+00:00" @@ -3042,6 +3049,13 @@ definitions: example: <p>Hey this is a status!</p> type: string x-go-name: Content + content_type: + description: |- + Content type that was used to parse the status's text. Returned when + status is deleted, so if the user is redrafting the message the client + can default to the same content type. + type: string + x-go-name: ContentType created_at: description: The date when this status was created (ISO 8601 Datetime). example: "2021-07-30T09:20:25+00:00" @@ -3186,6 +3200,10 @@ definitions: StatusSource represents the source text of a status as submitted to the API when it was created. properties: + content_type: + description: Content type that was used to parse the text. + type: string + x-go-name: ContentType id: description: ID of the status. example: 01FBVD42CQ3ZEEVMW180SBX03B |
