Skip to content

Commit 12b8f8a

Browse files
abrahamabraham
authored
Merge pull request #629 from abraham/update-schema
Update docs SHA and regenerate OpenAPI schema
2 parents 19f1d8b + 501122f commit 12b8f8a

File tree

3 files changed

+172
-5
lines changed

3 files changed

+172
-5
lines changed

‎config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"mastodonDocsCommit": "f2feffedeb4f71272da187304e2412d412dce82c",
2+
"mastodonDocsCommit": "3584c39b9cea3ffde27c21f9a5000a8735794578",
33
"mastodonVersion": "4.5.0",
44
"minimumMastodonVersion": "4.3.0",
55
"blockedFiles": ["methods/notifications_alpha.md"],

‎dist/schema.json‎

Lines changed: 170 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"info": {
44
"title": "Mastodon API",
55
"version": "4.5.0",
6-
"description": "Unofficial documentation for the Mastodon API. Generated with [mastodon-openapi](https://github.com/abraham/mastodon-openapi) from [f2feffe](https://github.com/mastodon/documentation/commit/f2feffedeb4f71272da187304e2412d412dce82c). Targets [supported](https://github.com/mastodon/mastodon/security/policy#supported-versions) Mastodon versions.",
6+
"description": "Unofficial documentation for the Mastodon API. Generated with [mastodon-openapi](https://github.com/abraham/mastodon-openapi) from [3584c39](https://github.com/mastodon/documentation/commit/3584c39b9cea3ffde27c21f9a5000a8735794578). Targets [supported](https://github.com/mastodon/mastodon/security/policy#supported-versions) Mastodon versions.",
77
"license": {
88
"name": "GFDL-1.3",
99
"url": "https://www.gnu.org/licenses/fdl-1.3.en.html"
@@ -30231,11 +30231,11 @@
3023130231
"description": "Additional entity definition for Field",
3023230232
"properties": {
3023330233
"name": {
30234-
"description": "The key of a given field's key-value pair.",
30234+
"description": "The key of a given field's key-value pair. This is the raw string before processing, not HTML.",
3023530235
"type": "string"
3023630236
},
3023730237
"value": {
30238-
"description": "The value associated with the `name` key.",
30238+
"description": "The value associated with the `name` key. This is the raw string before processing, not HTML.",
3023930239
"type": "string"
3024030240
},
3024130241
"verified_at": {
@@ -34145,6 +34145,173 @@
3414534145
"content": "<p>This privacy policy describes how example.com (&quot;example.com&quot;, &quot;we&quot;, &quot;us&quot;) collects,\nprotects and uses the personally identifiable information you may provide\nthrough the example.com website or its API.</p>\n\n<h1>What information do we collect?</h1>\n\n<ul>\n<li><strong>Basic account information</strong>: If you register on this server, you may be\nasked to enter a username, an e-mail address and a password.</li>\n<li><strong>Posts, following and other public information</strong>: The list of people you\nfollow is listed publicly, the same is true for your followers.</li>\n<li><strong>Direct and followers-only posts</strong>: All posts are stored and processed on the\nserver. You may\ntoggle an option to approve and reject new followers manually in the settings.\n<strong>Please keep in mind that the operators of the server and any receiving\nserver may view such messages</strong>, and that recipients may screenshot, copy or\notherwise re-share them. <strong>Do not share any sensitive information over\nMastodon.</strong></li>\n<li><strong>IPs and other metadata</strong>: When you log in, we record the IP address you log\nin from, as well as the name of your browser application.</li>\n</ul>\n\n<hr>\n\n<p>This document is CC-BY-SA. Originally adapted from the <a href=\"https://github.com/discourse/discourse\">Discourse privacy\npolicy</a>.</p>\n"
3414634146
}
3414734147
},
34148+
"Profile": {
34149+
"type": "object",
34150+
"description": "Represents the current user's profile, with source values for all the editable fields.",
34151+
"properties": {
34152+
"attribution_domains": {
34153+
"description": "Domains of websites allowed to credit the account.",
34154+
"type": "array",
34155+
"items": {
34156+
"type": "string"
34157+
}
34158+
},
34159+
"avatar_description": {
34160+
"description": "A textual description of the avatar, to be used for the visually impaired or when avatars do not load.",
34161+
"type": "string"
34162+
},
34163+
"bot": {
34164+
"description": "Indicates that the account may perform automated actions, may not be monitored, or identifies as a robot. This is determined by the account's `actor_type` being set to 'Application' or 'Service'.",
34165+
"type": "boolean"
34166+
},
34167+
"display_name": {
34168+
"description": "The profile's display name.",
34169+
"type": "string"
34170+
},
34171+
"fields": {
34172+
"description": "Metadata about the account. Those contain the raw unprocessed names and values.",
34173+
"type": "array",
34174+
"items": {
34175+
"$ref": "#/components/schemas/Field"
34176+
}
34177+
},
34178+
"header_description": {
34179+
"description": "A textual description of the profile header, to be used for the visually impaired or when avatars do not load.",
34180+
"type": "string"
34181+
},
34182+
"id": {
34183+
"description": "The account id.",
34184+
"type": "string"
34185+
},
34186+
"indexable": {
34187+
"description": "Whether the account allows indexing by search engines.",
34188+
"type": "boolean"
34189+
},
34190+
"locked": {
34191+
"description": "Whether the account manually approves follow requests.",
34192+
"type": "boolean"
34193+
},
34194+
"note": {
34195+
"description": "The profile's bio or description. Unlike for [Account]({{< relref \"entities/Account\">}}), this is the raw unprocessed text, not the rendered HTML.",
34196+
"type": "string"
34197+
},
34198+
"show_featured": {
34199+
"description": "Whether the account wishes to have a “Featured” tab on their profile.",
34200+
"type": "boolean"
34201+
},
34202+
"show_media": {
34203+
"description": "Whether the account wishes to have a “Media” tab with media attachments on their profile.",
34204+
"type": "boolean"
34205+
},
34206+
"show_media_replies": {
34207+
"description": "Whether the account wishes to have replies in the “Media” tab on their profile.",
34208+
"type": "boolean"
34209+
},
34210+
"avatar": {
34211+
"description": "An image icon that is shown next to statuses and in the profile. Unlike for [Account]({{< relref \"entities/Account\">}}), this is nullable and will be null if the avatar is unset.",
34212+
"type": [
34213+
"string",
34214+
"null"
34215+
],
34216+
"format": "uri"
34217+
},
34218+
"avatar_static": {
34219+
"description": "A static version of the avatar. Unlike for [Account]({{< relref \"entities/Account\">}}), this is nullable and will be null if the avatar is unset.",
34220+
"type": [
34221+
"string",
34222+
"null"
34223+
],
34224+
"format": "uri"
34225+
},
34226+
"discoverable": {
34227+
"description": "Whether the account has opted into discovery features such as the profile directory.",
34228+
"type": [
34229+
"boolean",
34230+
"null"
34231+
]
34232+
},
34233+
"header": {
34234+
"description": "An image banner that is shown above the profile and in profile cards. Unlike for [Account]({{< relref \"entities/Account\">}}), this is nullable and will be null if the header is unset.",
34235+
"type": [
34236+
"string",
34237+
"null"
34238+
],
34239+
"format": "uri"
34240+
},
34241+
"header_static": {
34242+
"description": "A static version of the header. Unlike for [Account]({{< relref \"entities/Account\">}}), this is nullable and will be null if the header is unset.",
34243+
"type": [
34244+
"string",
34245+
"null"
34246+
],
34247+
"format": "uri"
34248+
},
34249+
"hide_collections": {
34250+
"description": "Whether the user hides the contents of their follows and followers collections.",
34251+
"type": [
34252+
"boolean",
34253+
"null"
34254+
]
34255+
}
34256+
},
34257+
"required": [
34258+
"attribution_domains",
34259+
"avatar_description",
34260+
"bot",
34261+
"display_name",
34262+
"fields",
34263+
"header_description",
34264+
"id",
34265+
"indexable",
34266+
"locked",
34267+
"note",
34268+
"show_featured",
34269+
"show_media",
34270+
"show_media_replies"
34271+
],
34272+
"externalDocs": {
34273+
"url": "https://docs.joinmastodon.org/entities/Profile/#attributes",
34274+
"description": "Official Mastodon API documentation"
34275+
},
34276+
"example": {
34277+
"id": "116222600881276277",
34278+
"display_name": "Documentation user",
34279+
"note": "I'm only here as an example for documentation",
34280+
"fields": [
34281+
{
34282+
"name": "pronouns",
34283+
"value": "it/its",
34284+
"verified_at": null
34285+
}
34286+
],
34287+
"avatar": null,
34288+
"avatar_static": null,
34289+
"avatar_description": "",
34290+
"header": null,
34291+
"header_static": null,
34292+
"header_description": "",
34293+
"locked": false,
34294+
"bot": false,
34295+
"hide_collections": null,
34296+
"discoverable": true,
34297+
"indexable": true,
34298+
"show_media": true,
34299+
"show_media_replies": true,
34300+
"show_featured": true,
34301+
"attribution_domains": [
34302+
"articles.example.com"
34303+
],
34304+
"featured_tags": [
34305+
{
34306+
"id": "1",
34307+
"name": "foo",
34308+
"url": "https://example.com/@darrel_metz0/tagged/foo",
34309+
"statuses_count": "0",
34310+
"last_status_at": null
34311+
}
34312+
]
34313+
}
34314+
},
3414834315
"Quote": {
3414934316
"type": "object",
3415034317
"description": "Represents a quote or a quote placeholder, with the current authorization status.",

‎src/__tests__/parsers/EntityParser.draft.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,6 @@ describe('EntityParser - Draft File Handling', () => {
4040
// This test validates that only explicit draft: true is filtered
4141
// This is implicitly tested by checking that we still get a reasonable number of entities
4242
const entities = parser.parseAllEntities();
43-
expect(entities.length).toBe(92); // Exact count after removing EncryptedMessage and entities from blocked files (increased due to extracted nested entities + Admin::DimensionData + DiscoverOauthServerConfigurationResponse + OEmbedResponse)
43+
expect(entities.length).toBe(94); // Exact count after removing EncryptedMessage and entities from blocked files (increased due to extracted nested entities + Admin::DimensionData + DiscoverOauthServerConfigurationResponse + OEmbedResponse)
4444
});
4545
});

0 commit comments

Comments
 (0)