@meshery/schemas 1.3.108 → 1.3.109

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/dist/cloudApi.d.mts +8624 -4661
  2. package/dist/cloudApi.d.ts +8624 -4661
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +682 -33
  6. package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +215 -22
  7. package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +215 -22
  8. package/dist/constructs/v1beta3/media_asset/MediaAsset.d.ts +2322 -0
  9. package/dist/constructs/v1beta3/media_asset/MediaAssetSchema.d.ts +2 -0
  10. package/dist/constructs/v1beta3/media_asset/MediaAssetSchema.js +61 -0
  11. package/dist/constructs/v1beta3/media_asset/MediaAssetSchema.mjs +61 -0
  12. package/dist/constructs/v1beta3/mention_alias/MentionAlias.d.ts +678 -0
  13. package/dist/constructs/v1beta3/mention_alias/MentionAlias.js +1 -0
  14. package/dist/constructs/v1beta3/mention_alias/MentionAlias.mjs +0 -0
  15. package/dist/constructs/v1beta3/mention_alias/MentionAliasSchema.d.ts +2 -0
  16. package/dist/constructs/v1beta3/mention_alias/MentionAliasSchema.js +75 -0
  17. package/dist/constructs/v1beta3/mention_alias/MentionAliasSchema.mjs +75 -0
  18. package/dist/constructs/v1beta3/{risk_profile/RiskProfile.d.ts → posture/Posture.d.ts} +7 -7
  19. package/dist/constructs/v1beta3/posture/Posture.js +1 -0
  20. package/dist/constructs/v1beta3/posture/Posture.mjs +0 -0
  21. package/dist/constructs/v1beta3/posture/PostureSchema.d.ts +2 -0
  22. package/dist/constructs/v1beta3/posture/PostureSchema.js +22 -0
  23. package/dist/constructs/v1beta3/posture/PostureSchema.mjs +22 -0
  24. package/dist/constructs/v1beta3/schedule/Schedule.d.ts +41 -41
  25. package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +23 -23
  26. package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +23 -23
  27. package/dist/index.d.mts +23 -1
  28. package/dist/index.d.ts +23 -1
  29. package/dist/index.js +2 -2
  30. package/dist/index.mjs +2 -2
  31. package/package.json +1 -1
  32. package/dist/constructs/v1beta3/risk_profile/RiskProfileSchema.d.ts +0 -2
  33. package/dist/constructs/v1beta3/risk_profile/RiskProfileSchema.js +0 -22
  34. package/dist/constructs/v1beta3/risk_profile/RiskProfileSchema.mjs +0 -22
  35. /package/dist/constructs/v1beta3/{risk_profile/RiskProfile.js → media_asset/MediaAsset.js} +0 -0
  36. /package/dist/constructs/v1beta3/{risk_profile/RiskProfile.mjs → media_asset/MediaAsset.mjs} +0 -0
@@ -0,0 +1,2 @@
1
+ declare const MentionAliasSchema: Record<string, unknown>;
2
+ export default MentionAliasSchema;
@@ -0,0 +1,75 @@
1
+ 'use strict';var e={openapi:"3.0.0",info:{title:"MentionAlias",description:`OpenAPI schema for mention aliases: an organization's memory of who's who
2
+ across platforms. A message tags an entity as \`@entity\`; one message goes
3
+ to several platforms, and each names the same entity its own way. A
4
+ mention alias records one confirmed answer, the entity's form on one
5
+ platform, so the next message that tags the entity starts from it.
6
+
7
+ Uniqueness: an organization keeps at most one alias per (\`entity\`,
8
+ \`platform\`), with \`entity\` compared ignoring case. Writing aliases
9
+ (\`upsertMentionAliases\`) creates the alias for a new key and replaces the
10
+ \`handle\` of an existing one; it never adds a second alias for a key.
11
+
12
+ Organization scope: every operation acts only in the organization the
13
+ session resolved to (X-Current-Orgid, then the user's selected
14
+ organization), and only when the caller is a live member of it. No
15
+ operation takes an organization in its path or body.
16
+
17
+ Authorization: aliases describe how the organization's content items tag
18
+ people, so they reuse the content item keys (Catalog Management / Content
19
+ Items) in that organization: View Content Items for the read, Edit
20
+ Content Item for the write and Delete Content Item for the delete. A
21
+ caller without the key receives a 403 before any row is read. Past that
22
+ check, an id that does not name a mention alias of the organization and
23
+ a caller who is not a live member of it receive the same 404, so the
24
+ existence of another organization's aliases is never disclosed.
25
+ `,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"mentionAliases",description:"Operations related to mention aliases."}],paths:{"/api/mention-aliases":{get:{"x-internal":["cloud"],tags:["mentionAliases"],summary:"List mention aliases",operationId:"getMentionAliases",description:"Returns a paginated list of the mention aliases of the organization\nof the authenticated session. `entity` (repeatable) returns only the\naliases of those entities, each compared ignoring case, so the\naliases for every tag in one message come back in one read; an entity\nwith no alias contributes nothing. `platform` (repeatable) returns\nonly the aliases on those platforms. `search` matches `entity` or\n`handle` containing the term, ignoring case. `order` sorts by\n`entity`, `platform`, `createdAt` or `updatedAt` (`asc` or `desc`);\nthe default is `entity asc`, then `platform asc`. An organization\nwith no matching alias returns an empty page.\n",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"entity",in:"query",required:false,description:"Return only the aliases of these entities (repeatable), each compared ignoring case.",schema:{type:"array",maxItems:100,items:{type:"string",minLength:1,maxLength:100}}},{name:"platform",in:"query",required:false,description:"Return only the aliases on these platforms (repeatable).",schema:{type:"array",items:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"]}}}],responses:{200:{description:"Mention alias page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of mention aliases.",required:["page","pageSize","totalCount","mentionAliases"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},mentionAliases:{type:"array",items:{"x-go-type":"MentionAlias",$schema:"http://json-schema.org/draft-07/schema#",title:"Mention Alias Schema",description:`Server-returned mention alias: how one tagged entity (a person, company,
26
+ page or community, written \`@entity\` in a message) is named on one
27
+ platform, as a member of the organization confirmed it. An organization
28
+ keeps at most one alias per (entity, platform), with \`entity\` compared
29
+ ignoring case, so a confirmed answer is remembered across every later
30
+ message that tags the same entity. Writing the same key again replaces the
31
+ alias rather than adding a second one. Aliases belong to the organization
32
+ of the authenticated session; any member holding the content item keys
33
+ may read and change them.
34
+ `,type:"object",additionalProperties:false,required:["id","organizationId","entity","platform","handle","createdAt","updatedAt"],properties:{id:{description:"Server-generated mention alias ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},entity:{type:"string",description:"The tag as written after `@`, without the `@` (`kate`). Compared ignoring case: `Kate` and `kate` are the same entity, and the alias keeps the casing of the write that last stored it. The pattern is the tag grammar a message is read with: letters, digits, `_`, `.` and `-`, starting and ending with a letter, digit or `_`.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$","x-oapi-codegen-extra-tags":{db:"entity"},"x-order":3},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"],"x-oapi-codegen-extra-tags":{db:"platform"},"x-order":4},handle:{type:"string",description:"The entity's form on `platform`, stored as confirmed: `@kate_ops` on X, `@kate.example.org` on Bluesky, `u/kate` or `r/kate` on Reddit, a member ID such as `U012AB3CD` on Slack, or a plain-text name on LinkedIn. An empty string is a confirmed answer, not a missing one: it means the entity is sent as its name in plain text on that platform. The server checks length and surrounding whitespace only; whether a value is a valid handle on its platform is the client's check.\n",minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$","x-oapi-codegen-extra-tags":{db:"handle"},"x-order":5},confirmedBy:{description:`ID of the user whose session last wrote the alias. Derived from the authenticated session on every write, never client-settable. Omitted when that user was later purged.
35
+ `,"x-go-name":"ConfirmedBy","x-oapi-codegen-extra-tags":{db:"confirmed_by",json:"confirmedBy,omitempty"},"x-order":6,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"Timestamp the alias was first confirmed.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:`Timestamp the alias was last confirmed. Every write of the alias's key advances it, including one that stores the same handle again.
36
+ `,"x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},description:"Mention aliases included on this page of results."}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},post:{"x-internal":["cloud"],tags:["mentionAliases"],summary:"Write mention aliases",operationId:"upsertMentionAliases",description:"Writes the confirmed aliases in `mentionAliases`, keyed by (`entity`,\n`platform`) with `entity` compared ignoring case. A new key creates\nthe alias; an existing key replaces its `handle` and `entity` casing,\nsets `confirmedBy` to the caller and advances `updatedAt`, even when\nthe handle is unchanged. `id`, `organizationId` and `createdAt` of an\nexisting alias never change. The write is all or nothing in one\ntransaction: a body that fails validation, or that names the same key\ntwice, is refused with a 400 and stores nothing. Answers 200 with the\nstored aliases, one per entry and in the order of the request.\n",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"The confirmed aliases to write in one all-or-nothing request.",required:["mentionAliases"],properties:{mentionAliases:{type:"array",description:"Aliases to write, at most one per (`entity`, `platform`) key with `entity` compared ignoring case. A key named twice refuses the whole request with 400.\n",minItems:1,maxItems:250,items:{"x-go-type":"MentionAliasPayload",type:"object",description:"One confirmed alias to write. Contains only client-settable fields: the alias is keyed by (`entity`, `platform`), so there is no `id`; the owning `organizationId` comes from the session; `confirmedBy` is the caller; and the timestamps are server-generated.\n",required:["entity","platform","handle"],properties:{entity:{type:"string",description:"The tag as written after `@`, without the `@`. Compared ignoring case; the stored alias keeps this casing.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$"},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"]},handle:{type:"string",description:'The entity\'s form on `platform`. Required, because the write replaces the stored handle: an empty string is the confirmed answer "send the name as plain text", never "keep what is stored".\n',minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$"}}}}}}}}},responses:{200:{description:"The stored mention aliases, one per request entry, in request order",content:{"application/json":{schema:{type:"array",items:{$schema:"http://json-schema.org/draft-07/schema#",title:"Mention Alias Schema",description:`Server-returned mention alias: how one tagged entity (a person, company,
37
+ page or community, written \`@entity\` in a message) is named on one
38
+ platform, as a member of the organization confirmed it. An organization
39
+ keeps at most one alias per (entity, platform), with \`entity\` compared
40
+ ignoring case, so a confirmed answer is remembered across every later
41
+ message that tags the same entity. Writing the same key again replaces the
42
+ alias rather than adding a second one. Aliases belong to the organization
43
+ of the authenticated session; any member holding the content item keys
44
+ may read and change them.
45
+ `,type:"object",additionalProperties:false,required:["id","organizationId","entity","platform","handle","createdAt","updatedAt"],properties:{id:{description:"Server-generated mention alias ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},entity:{type:"string",description:"The tag as written after `@`, without the `@` (`kate`). Compared ignoring case: `Kate` and `kate` are the same entity, and the alias keeps the casing of the write that last stored it. The pattern is the tag grammar a message is read with: letters, digits, `_`, `.` and `-`, starting and ending with a letter, digit or `_`.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$","x-oapi-codegen-extra-tags":{db:"entity"},"x-order":3},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"],"x-oapi-codegen-extra-tags":{db:"platform"},"x-order":4},handle:{type:"string",description:"The entity's form on `platform`, stored as confirmed: `@kate_ops` on X, `@kate.example.org` on Bluesky, `u/kate` or `r/kate` on Reddit, a member ID such as `U012AB3CD` on Slack, or a plain-text name on LinkedIn. An empty string is a confirmed answer, not a missing one: it means the entity is sent as its name in plain text on that platform. The server checks length and surrounding whitespace only; whether a value is a valid handle on its platform is the client's check.\n",minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$","x-oapi-codegen-extra-tags":{db:"handle"},"x-order":5},confirmedBy:{description:`ID of the user whose session last wrote the alias. Derived from the authenticated session on every write, never client-settable. Omitted when that user was later purged.
46
+ `,"x-go-name":"ConfirmedBy","x-oapi-codegen-extra-tags":{db:"confirmed_by",json:"confirmedBy,omitempty"},"x-order":6,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"Timestamp the alias was first confirmed.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:`Timestamp the alias was last confirmed. Every write of the alias's key advances it, including one that stores the same handle again.
47
+ `,"x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/mention-aliases/{mentionAliasId}":{delete:{"x-internal":["cloud"],tags:["mentionAliases"],summary:"Delete a mention alias",operationId:"deleteMentionAlias",description:`Removes the mention alias, so the next message that tags its entity
48
+ on its platform starts without a confirmed answer. The row is
49
+ removed, not soft-deleted, and its key can be written again. An id
50
+ that does not name a mention alias of the session organization is a
51
+ 404, the same answer whether it never existed or belongs to another
52
+ organization.
53
+ `,parameters:[{name:"mentionAliasId",in:"path",description:"Mention alias ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Mention alias deleted"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}},MeshkitError429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}}},parameters:{page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},pageSize:{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},entity:{name:"entity",in:"query",required:false,description:"Return only the aliases of these entities (repeatable), each compared ignoring case.",schema:{type:"array",maxItems:100,items:{type:"string",minLength:1,maxLength:100}}},platform:{name:"platform",in:"query",required:false,description:"Return only the aliases on these platforms (repeatable).",schema:{type:"array",items:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"]}}},mentionAliasId:{name:"mentionAliasId",in:"path",description:"Mention alias ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},schemas:{MentionAlias:{$schema:"http://json-schema.org/draft-07/schema#",title:"Mention Alias Schema",description:`Server-returned mention alias: how one tagged entity (a person, company,
54
+ page or community, written \`@entity\` in a message) is named on one
55
+ platform, as a member of the organization confirmed it. An organization
56
+ keeps at most one alias per (entity, platform), with \`entity\` compared
57
+ ignoring case, so a confirmed answer is remembered across every later
58
+ message that tags the same entity. Writing the same key again replaces the
59
+ alias rather than adding a second one. Aliases belong to the organization
60
+ of the authenticated session; any member holding the content item keys
61
+ may read and change them.
62
+ `,type:"object",additionalProperties:false,required:["id","organizationId","entity","platform","handle","createdAt","updatedAt"],properties:{id:{description:"Server-generated mention alias ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},entity:{type:"string",description:"The tag as written after `@`, without the `@` (`kate`). Compared ignoring case: `Kate` and `kate` are the same entity, and the alias keeps the casing of the write that last stored it. The pattern is the tag grammar a message is read with: letters, digits, `_`, `.` and `-`, starting and ending with a letter, digit or `_`.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$","x-oapi-codegen-extra-tags":{db:"entity"},"x-order":3},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"],"x-oapi-codegen-extra-tags":{db:"platform"},"x-order":4},handle:{type:"string",description:"The entity's form on `platform`, stored as confirmed: `@kate_ops` on X, `@kate.example.org` on Bluesky, `u/kate` or `r/kate` on Reddit, a member ID such as `U012AB3CD` on Slack, or a plain-text name on LinkedIn. An empty string is a confirmed answer, not a missing one: it means the entity is sent as its name in plain text on that platform. The server checks length and surrounding whitespace only; whether a value is a valid handle on its platform is the client's check.\n",minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$","x-oapi-codegen-extra-tags":{db:"handle"},"x-order":5},confirmedBy:{description:`ID of the user whose session last wrote the alias. Derived from the authenticated session on every write, never client-settable. Omitted when that user was later purged.
63
+ `,"x-go-name":"ConfirmedBy","x-oapi-codegen-extra-tags":{db:"confirmed_by",json:"confirmedBy,omitempty"},"x-order":6,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"Timestamp the alias was first confirmed.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:`Timestamp the alias was last confirmed. Every write of the alias's key advances it, including one that stores the same handle again.
64
+ `,"x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},MentionAliasPlatform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"]},MentionAliasPage:{type:"object",description:"Paginated collection of mention aliases.",required:["page","pageSize","totalCount","mentionAliases"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},mentionAliases:{type:"array",items:{"x-go-type":"MentionAlias",$schema:"http://json-schema.org/draft-07/schema#",title:"Mention Alias Schema",description:`Server-returned mention alias: how one tagged entity (a person, company,
65
+ page or community, written \`@entity\` in a message) is named on one
66
+ platform, as a member of the organization confirmed it. An organization
67
+ keeps at most one alias per (entity, platform), with \`entity\` compared
68
+ ignoring case, so a confirmed answer is remembered across every later
69
+ message that tags the same entity. Writing the same key again replaces the
70
+ alias rather than adding a second one. Aliases belong to the organization
71
+ of the authenticated session; any member holding the content item keys
72
+ may read and change them.
73
+ `,type:"object",additionalProperties:false,required:["id","organizationId","entity","platform","handle","createdAt","updatedAt"],properties:{id:{description:"Server-generated mention alias ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},entity:{type:"string",description:"The tag as written after `@`, without the `@` (`kate`). Compared ignoring case: `Kate` and `kate` are the same entity, and the alias keeps the casing of the write that last stored it. The pattern is the tag grammar a message is read with: letters, digits, `_`, `.` and `-`, starting and ending with a letter, digit or `_`.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$","x-oapi-codegen-extra-tags":{db:"entity"},"x-order":3},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"],"x-oapi-codegen-extra-tags":{db:"platform"},"x-order":4},handle:{type:"string",description:"The entity's form on `platform`, stored as confirmed: `@kate_ops` on X, `@kate.example.org` on Bluesky, `u/kate` or `r/kate` on Reddit, a member ID such as `U012AB3CD` on Slack, or a plain-text name on LinkedIn. An empty string is a confirmed answer, not a missing one: it means the entity is sent as its name in plain text on that platform. The server checks length and surrounding whitespace only; whether a value is a valid handle on its platform is the client's check.\n",minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$","x-oapi-codegen-extra-tags":{db:"handle"},"x-order":5},confirmedBy:{description:`ID of the user whose session last wrote the alias. Derived from the authenticated session on every write, never client-settable. Omitted when that user was later purged.
74
+ `,"x-go-name":"ConfirmedBy","x-oapi-codegen-extra-tags":{db:"confirmed_by",json:"confirmedBy,omitempty"},"x-order":6,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"Timestamp the alias was first confirmed.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:`Timestamp the alias was last confirmed. Every write of the alias's key advances it, including one that stores the same handle again.
75
+ `,"x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},description:"Mention aliases included on this page of results."}}},MentionAliasPayload:{type:"object",description:"One confirmed alias to write. Contains only client-settable fields: the alias is keyed by (`entity`, `platform`), so there is no `id`; the owning `organizationId` comes from the session; `confirmedBy` is the caller; and the timestamps are server-generated.\n",required:["entity","platform","handle"],properties:{entity:{type:"string",description:"The tag as written after `@`, without the `@`. Compared ignoring case; the stored alias keeps this casing.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$"},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"]},handle:{type:"string",description:'The entity\'s form on `platform`. Required, because the write replaces the stored handle: an empty string is the confirmed answer "send the name as plain text", never "keep what is stored".\n',minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$"}}},MentionAliasesPayload:{type:"object",description:"The confirmed aliases to write in one all-or-nothing request.",required:["mentionAliases"],properties:{mentionAliases:{type:"array",description:"Aliases to write, at most one per (`entity`, `platform`) key with `entity` compared ignoring case. A key named twice refuses the whole request with 400.\n",minItems:1,maxItems:250,items:{"x-go-type":"MentionAliasPayload",type:"object",description:"One confirmed alias to write. Contains only client-settable fields: the alias is keyed by (`entity`, `platform`), so there is no `id`; the owning `organizationId` comes from the session; `confirmedBy` is the caller; and the timestamps are server-generated.\n",required:["entity","platform","handle"],properties:{entity:{type:"string",description:"The tag as written after `@`, without the `@`. Compared ignoring case; the stored alias keeps this casing.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$"},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"]},handle:{type:"string",description:'The entity\'s form on `platform`. Required, because the write replaces the stored handle: an empty string is the confirmed answer "send the name as plain text", never "keep what is stored".\n',minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$"}}}}}}}}},t=e;module.exports=t;
@@ -0,0 +1,75 @@
1
+ var e={openapi:"3.0.0",info:{title:"MentionAlias",description:`OpenAPI schema for mention aliases: an organization's memory of who's who
2
+ across platforms. A message tags an entity as \`@entity\`; one message goes
3
+ to several platforms, and each names the same entity its own way. A
4
+ mention alias records one confirmed answer, the entity's form on one
5
+ platform, so the next message that tags the entity starts from it.
6
+
7
+ Uniqueness: an organization keeps at most one alias per (\`entity\`,
8
+ \`platform\`), with \`entity\` compared ignoring case. Writing aliases
9
+ (\`upsertMentionAliases\`) creates the alias for a new key and replaces the
10
+ \`handle\` of an existing one; it never adds a second alias for a key.
11
+
12
+ Organization scope: every operation acts only in the organization the
13
+ session resolved to (X-Current-Orgid, then the user's selected
14
+ organization), and only when the caller is a live member of it. No
15
+ operation takes an organization in its path or body.
16
+
17
+ Authorization: aliases describe how the organization's content items tag
18
+ people, so they reuse the content item keys (Catalog Management / Content
19
+ Items) in that organization: View Content Items for the read, Edit
20
+ Content Item for the write and Delete Content Item for the delete. A
21
+ caller without the key receives a 403 before any row is read. Past that
22
+ check, an id that does not name a mention alias of the organization and
23
+ a caller who is not a live member of it receive the same 404, so the
24
+ existence of another organization's aliases is never disclosed.
25
+ `,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"mentionAliases",description:"Operations related to mention aliases."}],paths:{"/api/mention-aliases":{get:{"x-internal":["cloud"],tags:["mentionAliases"],summary:"List mention aliases",operationId:"getMentionAliases",description:"Returns a paginated list of the mention aliases of the organization\nof the authenticated session. `entity` (repeatable) returns only the\naliases of those entities, each compared ignoring case, so the\naliases for every tag in one message come back in one read; an entity\nwith no alias contributes nothing. `platform` (repeatable) returns\nonly the aliases on those platforms. `search` matches `entity` or\n`handle` containing the term, ignoring case. `order` sorts by\n`entity`, `platform`, `createdAt` or `updatedAt` (`asc` or `desc`);\nthe default is `entity asc`, then `platform asc`. An organization\nwith no matching alias returns an empty page.\n",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"entity",in:"query",required:false,description:"Return only the aliases of these entities (repeatable), each compared ignoring case.",schema:{type:"array",maxItems:100,items:{type:"string",minLength:1,maxLength:100}}},{name:"platform",in:"query",required:false,description:"Return only the aliases on these platforms (repeatable).",schema:{type:"array",items:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"]}}}],responses:{200:{description:"Mention alias page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of mention aliases.",required:["page","pageSize","totalCount","mentionAliases"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},mentionAliases:{type:"array",items:{"x-go-type":"MentionAlias",$schema:"http://json-schema.org/draft-07/schema#",title:"Mention Alias Schema",description:`Server-returned mention alias: how one tagged entity (a person, company,
26
+ page or community, written \`@entity\` in a message) is named on one
27
+ platform, as a member of the organization confirmed it. An organization
28
+ keeps at most one alias per (entity, platform), with \`entity\` compared
29
+ ignoring case, so a confirmed answer is remembered across every later
30
+ message that tags the same entity. Writing the same key again replaces the
31
+ alias rather than adding a second one. Aliases belong to the organization
32
+ of the authenticated session; any member holding the content item keys
33
+ may read and change them.
34
+ `,type:"object",additionalProperties:false,required:["id","organizationId","entity","platform","handle","createdAt","updatedAt"],properties:{id:{description:"Server-generated mention alias ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},entity:{type:"string",description:"The tag as written after `@`, without the `@` (`kate`). Compared ignoring case: `Kate` and `kate` are the same entity, and the alias keeps the casing of the write that last stored it. The pattern is the tag grammar a message is read with: letters, digits, `_`, `.` and `-`, starting and ending with a letter, digit or `_`.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$","x-oapi-codegen-extra-tags":{db:"entity"},"x-order":3},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"],"x-oapi-codegen-extra-tags":{db:"platform"},"x-order":4},handle:{type:"string",description:"The entity's form on `platform`, stored as confirmed: `@kate_ops` on X, `@kate.example.org` on Bluesky, `u/kate` or `r/kate` on Reddit, a member ID such as `U012AB3CD` on Slack, or a plain-text name on LinkedIn. An empty string is a confirmed answer, not a missing one: it means the entity is sent as its name in plain text on that platform. The server checks length and surrounding whitespace only; whether a value is a valid handle on its platform is the client's check.\n",minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$","x-oapi-codegen-extra-tags":{db:"handle"},"x-order":5},confirmedBy:{description:`ID of the user whose session last wrote the alias. Derived from the authenticated session on every write, never client-settable. Omitted when that user was later purged.
35
+ `,"x-go-name":"ConfirmedBy","x-oapi-codegen-extra-tags":{db:"confirmed_by",json:"confirmedBy,omitempty"},"x-order":6,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"Timestamp the alias was first confirmed.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:`Timestamp the alias was last confirmed. Every write of the alias's key advances it, including one that stores the same handle again.
36
+ `,"x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},description:"Mention aliases included on this page of results."}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},post:{"x-internal":["cloud"],tags:["mentionAliases"],summary:"Write mention aliases",operationId:"upsertMentionAliases",description:"Writes the confirmed aliases in `mentionAliases`, keyed by (`entity`,\n`platform`) with `entity` compared ignoring case. A new key creates\nthe alias; an existing key replaces its `handle` and `entity` casing,\nsets `confirmedBy` to the caller and advances `updatedAt`, even when\nthe handle is unchanged. `id`, `organizationId` and `createdAt` of an\nexisting alias never change. The write is all or nothing in one\ntransaction: a body that fails validation, or that names the same key\ntwice, is refused with a 400 and stores nothing. Answers 200 with the\nstored aliases, one per entry and in the order of the request.\n",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"The confirmed aliases to write in one all-or-nothing request.",required:["mentionAliases"],properties:{mentionAliases:{type:"array",description:"Aliases to write, at most one per (`entity`, `platform`) key with `entity` compared ignoring case. A key named twice refuses the whole request with 400.\n",minItems:1,maxItems:250,items:{"x-go-type":"MentionAliasPayload",type:"object",description:"One confirmed alias to write. Contains only client-settable fields: the alias is keyed by (`entity`, `platform`), so there is no `id`; the owning `organizationId` comes from the session; `confirmedBy` is the caller; and the timestamps are server-generated.\n",required:["entity","platform","handle"],properties:{entity:{type:"string",description:"The tag as written after `@`, without the `@`. Compared ignoring case; the stored alias keeps this casing.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$"},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"]},handle:{type:"string",description:'The entity\'s form on `platform`. Required, because the write replaces the stored handle: an empty string is the confirmed answer "send the name as plain text", never "keep what is stored".\n',minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$"}}}}}}}}},responses:{200:{description:"The stored mention aliases, one per request entry, in request order",content:{"application/json":{schema:{type:"array",items:{$schema:"http://json-schema.org/draft-07/schema#",title:"Mention Alias Schema",description:`Server-returned mention alias: how one tagged entity (a person, company,
37
+ page or community, written \`@entity\` in a message) is named on one
38
+ platform, as a member of the organization confirmed it. An organization
39
+ keeps at most one alias per (entity, platform), with \`entity\` compared
40
+ ignoring case, so a confirmed answer is remembered across every later
41
+ message that tags the same entity. Writing the same key again replaces the
42
+ alias rather than adding a second one. Aliases belong to the organization
43
+ of the authenticated session; any member holding the content item keys
44
+ may read and change them.
45
+ `,type:"object",additionalProperties:false,required:["id","organizationId","entity","platform","handle","createdAt","updatedAt"],properties:{id:{description:"Server-generated mention alias ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},entity:{type:"string",description:"The tag as written after `@`, without the `@` (`kate`). Compared ignoring case: `Kate` and `kate` are the same entity, and the alias keeps the casing of the write that last stored it. The pattern is the tag grammar a message is read with: letters, digits, `_`, `.` and `-`, starting and ending with a letter, digit or `_`.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$","x-oapi-codegen-extra-tags":{db:"entity"},"x-order":3},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"],"x-oapi-codegen-extra-tags":{db:"platform"},"x-order":4},handle:{type:"string",description:"The entity's form on `platform`, stored as confirmed: `@kate_ops` on X, `@kate.example.org` on Bluesky, `u/kate` or `r/kate` on Reddit, a member ID such as `U012AB3CD` on Slack, or a plain-text name on LinkedIn. An empty string is a confirmed answer, not a missing one: it means the entity is sent as its name in plain text on that platform. The server checks length and surrounding whitespace only; whether a value is a valid handle on its platform is the client's check.\n",minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$","x-oapi-codegen-extra-tags":{db:"handle"},"x-order":5},confirmedBy:{description:`ID of the user whose session last wrote the alias. Derived from the authenticated session on every write, never client-settable. Omitted when that user was later purged.
46
+ `,"x-go-name":"ConfirmedBy","x-oapi-codegen-extra-tags":{db:"confirmed_by",json:"confirmedBy,omitempty"},"x-order":6,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"Timestamp the alias was first confirmed.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:`Timestamp the alias was last confirmed. Every write of the alias's key advances it, including one that stores the same handle again.
47
+ `,"x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/mention-aliases/{mentionAliasId}":{delete:{"x-internal":["cloud"],tags:["mentionAliases"],summary:"Delete a mention alias",operationId:"deleteMentionAlias",description:`Removes the mention alias, so the next message that tags its entity
48
+ on its platform starts without a confirmed answer. The row is
49
+ removed, not soft-deleted, and its key can be written again. An id
50
+ that does not name a mention alias of the session organization is a
51
+ 404, the same answer whether it never existed or belongs to another
52
+ organization.
53
+ `,parameters:[{name:"mentionAliasId",in:"path",description:"Mention alias ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Mention alias deleted"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}},MeshkitError429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}}},parameters:{page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},pageSize:{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},entity:{name:"entity",in:"query",required:false,description:"Return only the aliases of these entities (repeatable), each compared ignoring case.",schema:{type:"array",maxItems:100,items:{type:"string",minLength:1,maxLength:100}}},platform:{name:"platform",in:"query",required:false,description:"Return only the aliases on these platforms (repeatable).",schema:{type:"array",items:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"]}}},mentionAliasId:{name:"mentionAliasId",in:"path",description:"Mention alias ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},schemas:{MentionAlias:{$schema:"http://json-schema.org/draft-07/schema#",title:"Mention Alias Schema",description:`Server-returned mention alias: how one tagged entity (a person, company,
54
+ page or community, written \`@entity\` in a message) is named on one
55
+ platform, as a member of the organization confirmed it. An organization
56
+ keeps at most one alias per (entity, platform), with \`entity\` compared
57
+ ignoring case, so a confirmed answer is remembered across every later
58
+ message that tags the same entity. Writing the same key again replaces the
59
+ alias rather than adding a second one. Aliases belong to the organization
60
+ of the authenticated session; any member holding the content item keys
61
+ may read and change them.
62
+ `,type:"object",additionalProperties:false,required:["id","organizationId","entity","platform","handle","createdAt","updatedAt"],properties:{id:{description:"Server-generated mention alias ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},entity:{type:"string",description:"The tag as written after `@`, without the `@` (`kate`). Compared ignoring case: `Kate` and `kate` are the same entity, and the alias keeps the casing of the write that last stored it. The pattern is the tag grammar a message is read with: letters, digits, `_`, `.` and `-`, starting and ending with a letter, digit or `_`.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$","x-oapi-codegen-extra-tags":{db:"entity"},"x-order":3},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"],"x-oapi-codegen-extra-tags":{db:"platform"},"x-order":4},handle:{type:"string",description:"The entity's form on `platform`, stored as confirmed: `@kate_ops` on X, `@kate.example.org` on Bluesky, `u/kate` or `r/kate` on Reddit, a member ID such as `U012AB3CD` on Slack, or a plain-text name on LinkedIn. An empty string is a confirmed answer, not a missing one: it means the entity is sent as its name in plain text on that platform. The server checks length and surrounding whitespace only; whether a value is a valid handle on its platform is the client's check.\n",minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$","x-oapi-codegen-extra-tags":{db:"handle"},"x-order":5},confirmedBy:{description:`ID of the user whose session last wrote the alias. Derived from the authenticated session on every write, never client-settable. Omitted when that user was later purged.
63
+ `,"x-go-name":"ConfirmedBy","x-oapi-codegen-extra-tags":{db:"confirmed_by",json:"confirmedBy,omitempty"},"x-order":6,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"Timestamp the alias was first confirmed.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:`Timestamp the alias was last confirmed. Every write of the alias's key advances it, including one that stores the same handle again.
64
+ `,"x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},MentionAliasPlatform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"]},MentionAliasPage:{type:"object",description:"Paginated collection of mention aliases.",required:["page","pageSize","totalCount","mentionAliases"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},mentionAliases:{type:"array",items:{"x-go-type":"MentionAlias",$schema:"http://json-schema.org/draft-07/schema#",title:"Mention Alias Schema",description:`Server-returned mention alias: how one tagged entity (a person, company,
65
+ page or community, written \`@entity\` in a message) is named on one
66
+ platform, as a member of the organization confirmed it. An organization
67
+ keeps at most one alias per (entity, platform), with \`entity\` compared
68
+ ignoring case, so a confirmed answer is remembered across every later
69
+ message that tags the same entity. Writing the same key again replaces the
70
+ alias rather than adding a second one. Aliases belong to the organization
71
+ of the authenticated session; any member holding the content item keys
72
+ may read and change them.
73
+ `,type:"object",additionalProperties:false,required:["id","organizationId","entity","platform","handle","createdAt","updatedAt"],properties:{id:{description:"Server-generated mention alias ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"Owning organization ID. Derived from the authenticated session, never client-settable.","x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},entity:{type:"string",description:"The tag as written after `@`, without the `@` (`kate`). Compared ignoring case: `Kate` and `kate` are the same entity, and the alias keeps the casing of the write that last stored it. The pattern is the tag grammar a message is read with: letters, digits, `_`, `.` and `-`, starting and ending with a letter, digit or `_`.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$","x-oapi-codegen-extra-tags":{db:"entity"},"x-order":3},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"],"x-oapi-codegen-extra-tags":{db:"platform"},"x-order":4},handle:{type:"string",description:"The entity's form on `platform`, stored as confirmed: `@kate_ops` on X, `@kate.example.org` on Bluesky, `u/kate` or `r/kate` on Reddit, a member ID such as `U012AB3CD` on Slack, or a plain-text name on LinkedIn. An empty string is a confirmed answer, not a missing one: it means the entity is sent as its name in plain text on that platform. The server checks length and surrounding whitespace only; whether a value is a valid handle on its platform is the client's check.\n",minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$","x-oapi-codegen-extra-tags":{db:"handle"},"x-order":5},confirmedBy:{description:`ID of the user whose session last wrote the alias. Derived from the authenticated session on every write, never client-settable. Omitted when that user was later purged.
74
+ `,"x-go-name":"ConfirmedBy","x-oapi-codegen-extra-tags":{db:"confirmed_by",json:"confirmedBy,omitempty"},"x-order":6,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"Timestamp the alias was first confirmed.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:`Timestamp the alias was last confirmed. Every write of the alias's key advances it, including one that stores the same handle again.
75
+ `,"x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":8,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},description:"Mention aliases included on this page of results."}}},MentionAliasPayload:{type:"object",description:"One confirmed alias to write. Contains only client-settable fields: the alias is keyed by (`entity`, `platform`), so there is no `id`; the owning `organizationId` comes from the session; `confirmedBy` is the caller; and the timestamps are server-generated.\n",required:["entity","platform","handle"],properties:{entity:{type:"string",description:"The tag as written after `@`, without the `@`. Compared ignoring case; the stored alias keeps this casing.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$"},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"]},handle:{type:"string",description:'The entity\'s form on `platform`. Required, because the write replaces the stored handle: an empty string is the confirmed answer "send the name as plain text", never "keep what is stored".\n',minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$"}}},MentionAliasesPayload:{type:"object",description:"The confirmed aliases to write in one all-or-nothing request.",required:["mentionAliases"],properties:{mentionAliases:{type:"array",description:"Aliases to write, at most one per (`entity`, `platform`) key with `entity` compared ignoring case. A key named twice refuses the whole request with 400.\n",minItems:1,maxItems:250,items:{"x-go-type":"MentionAliasPayload",type:"object",description:"One confirmed alias to write. Contains only client-settable fields: the alias is keyed by (`entity`, `platform`), so there is no `id`; the owning `organizationId` comes from the session; `confirmedBy` is the caller; and the timestamps are server-generated.\n",required:["entity","platform","handle"],properties:{entity:{type:"string",description:"The tag as written after `@`, without the `@`. Compared ignoring case; the stored alias keeps this casing.\n",minLength:1,maxLength:100,pattern:"^[A-Za-z0-9_](?:[A-Za-z0-9_.-]*[A-Za-z0-9_])?$"},platform:{type:"string",description:"A platform whose messages can tag an entity: `linkedin`, `x`, `bluesky`, `reddit` or `slack`. A server refuses any other value with 400. A platform joins by adding a value here.\n",enum:["linkedin","x","bluesky","reddit","slack"],"x-ts-const":"MentionAliasPlatforms","x-enum-varnames":["MentionAliasPlatformLinkedin","MentionAliasPlatformX","MentionAliasPlatformBluesky","MentionAliasPlatformReddit","MentionAliasPlatformSlack"]},handle:{type:"string",description:'The entity\'s form on `platform`. Required, because the write replaces the stored handle: an empty string is the confirmed answer "send the name as plain text", never "keep what is stored".\n',minLength:0,maxLength:200,pattern:"^(\\S(.*\\S)?)?$"}}}}}}}}},t=e;export{t as default};
@@ -8,22 +8,22 @@ export type webhooks = Record<string, never>;
8
8
  export interface components {
9
9
  schemas: {
10
10
  /**
11
- * Risk Profile Schema
12
- * @description The Risk Profile preset value. Wherever the value is carried, the
13
- * workload runs that preset end to end - pace, share of each built-in cap,
14
- * quiet hours and the pause after a sign-in challenge - instead of the
15
- * preset the surrounding resolution (profile x platform, configuration,
11
+ * Posture Schema
12
+ * @description The Posture preset value. Wherever the value is carried, the workload
13
+ * runs that preset end to end - pace, share of each built-in cap, quiet
14
+ * hours and the pause after a sign-in challenge - instead of the preset
15
+ * the surrounding resolution (profile x platform, configuration,
16
16
  * environment, account preference, defaults) would otherwise produce;
17
17
  * omitting the value inherits that resolution unchanged. The value is a
18
18
  * preset name, never `custom`: custom is a reported state of a profile
19
19
  * whose dials sit outside its preset, not a choice anything can make.
20
- * Referenced by the optional `riskProfile` property on the schedule
20
+ * Referenced by the optional `posture` property on the schedule
21
21
  * construct's `Schedule` and `SchedulePayload` components
22
22
  * (`v1beta3/schedule`). A new carrier references this component rather
23
23
  * than restating the enum.
24
24
  * @enum {string}
25
25
  */
26
- RiskProfile: "cautious" | "standard" | "brisk";
26
+ Posture: "cautious" | "standard" | "brisk";
27
27
  };
28
28
  responses: never;
29
29
  parameters: never;
@@ -0,0 +1 @@
1
+ 'use strict';
File without changes
@@ -0,0 +1,2 @@
1
+ declare const PostureSchema: Record<string, unknown>;
2
+ export default PostureSchema;
@@ -0,0 +1,22 @@
1
+ 'use strict';var e={openapi:"3.0.0",info:{title:"Posture",description:`OpenAPI schema for Postures: the named presets that decide how a
2
+ workload runs - its pace, its share of each built-in cap, its quiet
3
+ hours and the pause it takes after a sign-in challenge. A Posture is a
4
+ product-level concept, not a property of any one construct: the same
5
+ preset value is referenced wherever a preset is chosen or resolved - a
6
+ profile's per-platform binding, an account default, and a schedule's
7
+ optional \`posture\` override (Blowhorn #1009). The component has no
8
+ endpoints of its own; referencing constructs declare the property, so
9
+ the paths stay with them.
10
+ `,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},paths:{},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{Posture:{$schema:"http://json-schema.org/draft-07/schema#",title:"Posture Schema",description:`The Posture preset value. Wherever the value is carried, the workload
11
+ runs that preset end to end - pace, share of each built-in cap, quiet
12
+ hours and the pause after a sign-in challenge - instead of the preset
13
+ the surrounding resolution (profile x platform, configuration,
14
+ environment, account preference, defaults) would otherwise produce;
15
+ omitting the value inherits that resolution unchanged. The value is a
16
+ preset name, never \`custom\`: custom is a reported state of a profile
17
+ whose dials sit outside its preset, not a choice anything can make.
18
+ Referenced by the optional \`posture\` property on the schedule
19
+ construct's \`Schedule\` and \`SchedulePayload\` components
20
+ (\`v1beta3/schedule\`). A new carrier references this component rather
21
+ than restating the enum.
22
+ `,type:"string",enum:["cautious","standard","brisk"]}}}},t=e;module.exports=t;
@@ -0,0 +1,22 @@
1
+ var e={openapi:"3.0.0",info:{title:"Posture",description:`OpenAPI schema for Postures: the named presets that decide how a
2
+ workload runs - its pace, its share of each built-in cap, its quiet
3
+ hours and the pause it takes after a sign-in challenge. A Posture is a
4
+ product-level concept, not a property of any one construct: the same
5
+ preset value is referenced wherever a preset is chosen or resolved - a
6
+ profile's per-platform binding, an account default, and a schedule's
7
+ optional \`posture\` override (Blowhorn #1009). The component has no
8
+ endpoints of its own; referencing constructs declare the property, so
9
+ the paths stay with them.
10
+ `,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},paths:{},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{Posture:{$schema:"http://json-schema.org/draft-07/schema#",title:"Posture Schema",description:`The Posture preset value. Wherever the value is carried, the workload
11
+ runs that preset end to end - pace, share of each built-in cap, quiet
12
+ hours and the pause after a sign-in challenge - instead of the preset
13
+ the surrounding resolution (profile x platform, configuration,
14
+ environment, account preference, defaults) would otherwise produce;
15
+ omitting the value inherits that resolution unchanged. The value is a
16
+ preset name, never \`custom\`: custom is a reported state of a profile
17
+ whose dials sit outside its preset, not a choice anything can make.
18
+ Referenced by the optional \`posture\` property on the schedule
19
+ construct's \`Schedule\` and \`SchedulePayload\` components
20
+ (\`v1beta3/schedule\`). A new carrier references this component rather
21
+ than restating the enum.
22
+ `,type:"string",enum:["cautious","standard","brisk"]}}}},t=e;export{t as default};