@meshery/schemas 1.3.102 → 1.3.104
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.
- package/dist/cloudApi.d.mts +4496 -4098
- package/dist/cloudApi.d.ts +4496 -4098
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/core/Core.d.ts +1 -1
- package/dist/constructs/v1alpha1/core/CoreSchema.js +1 -1
- package/dist/constructs/v1alpha1/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta1/diagnostics/Diagnostics.d.ts +536 -0
- package/dist/constructs/v1beta1/diagnostics/Diagnostics.js +1 -0
- package/dist/constructs/v1beta1/diagnostics/Diagnostics.mjs +0 -0
- package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.js +2 -0
- package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.mjs +2 -0
- package/dist/constructs/v1beta1/support/Support.d.ts +373 -0
- package/dist/constructs/v1beta1/support/SupportSchema.js +1 -1
- package/dist/constructs/v1beta1/support/SupportSchema.mjs +1 -1
- package/dist/constructs/v1beta2/core/Core.d.ts +26 -1
- package/dist/constructs/v1beta2/core/CoreSchema.js +1 -1
- package/dist/constructs/v1beta2/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.d.ts +186 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.js +1 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.mjs +0 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.js +25 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.mjs +25 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealth.d.ts +50 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.js +1 -1
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.mjs +1 -1
- package/dist/constructs/v1beta3/claim/Claim.d.ts +150 -0
- package/dist/constructs/v1beta3/claim/ClaimSchema.js +2 -2
- package/dist/constructs/v1beta3/claim/ClaimSchema.mjs +2 -2
- package/dist/constructs/v1beta3/connection/Connection.d.ts +100 -0
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
- package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +150 -0
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +5 -5
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +5 -5
- package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.js +1 -1
- package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.mjs +1 -1
- package/dist/constructs/v1beta3/design/DesignSchema.js +5 -5
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +5 -5
- package/dist/constructs/v1beta3/event/Event.d.ts +275 -0
- package/dist/constructs/v1beta3/event/EventSchema.js +3 -3
- package/dist/constructs/v1beta3/event/EventSchema.mjs +3 -3
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.js +1 -1
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.mjs +1 -1
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.js +1 -1
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.mjs +1 -1
- package/dist/constructs/v1beta3/github/GithubSchema.js +1 -1
- package/dist/constructs/v1beta3/github/GithubSchema.mjs +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/ledger/Ledger.d.ts +175 -0
- package/dist/constructs/v1beta3/ledger/LedgerSchema.js +5 -5
- package/dist/constructs/v1beta3/ledger/LedgerSchema.mjs +5 -5
- package/dist/constructs/v1beta3/profile/Profile.d.ts +225 -0
- package/dist/constructs/v1beta3/profile/ProfileSchema.js +1 -1
- package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +1 -1
- package/dist/constructs/v1beta3/provider_capability/ProviderCapability.d.ts +50 -0
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.js +1 -1
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.mjs +1 -1
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +225 -0
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +8 -8
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +8 -8
- package/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- package/package.json +1 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var e={openapi:"3.0.0",info:{title:"Core Schema Elements",description:"Reusable core schema elements for Meshery OpenAPI specifications.",version:"v1beta2",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:{schemas:{InputString:{type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$",description:"A string starting with an alphanumeric character. Spaces and hyphens allowed."},VersionString:{type:"string",minLength:2,maxLength:100,description:'API version of the object, optionally prefixed with an API group (e.g. "group.example.io/v1beta1" or bare "v1beta1").',pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+(alpha[0-9]*|beta[0-9]*|rc[0-9]*)?)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},SemverString:{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 100 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1'."},Uuid:{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"}},Id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},Username:{type:"string","x-go-type-skip-optional-pointer":true},Provider:{type:"string",description:"One of (x-oapi-codegen-extra-tags-cloud, github, google)","x-go-type-skip-optional-pointer":true},Time:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},SqlNullTime:{type:"string",format:"date-time","x-go-type":"sql.NullTime","x-go-type-import":{path:"database/sql"},"x-go-type-skip-optional-pointer":true},Email:{type:"string",format:"email",description:"email","x-go-type-skip-optional-pointer":true},Text:{type:"string","x-go-type-skip-optional-pointer":true},Visibility:{type:"string",description:"Visibility level of a resource. Controls who can see and access it.\n- `private`: Only the owner and explicitly shared users can access.\n- `public`: Anyone in the organization (or anonymous, depending on resource) can discover and access.\n- `published`: Promoted to the catalog for broad discovery beyond the owning organization.\n",enum:["private","public","published"],"x-go-type-skip-optional-pointer":true},Number:{type:"integer","x-go-type-skip-optional-pointer":true},AvatarUrl:{type:"string",description:"Link for profile picture","x-go-type-skip-optional-pointer":true},MapObject:{type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},Status:{type:"string","x-go-type-skip-optional-pointer":true},Bio:{type:"string","x-go-type-skip-optional-pointer":true},AcceptedTermsAt:{type:"string","x-go-type-skip-optional-pointer":true},Emails:{type:"array",items:{type:"string",format:"email",description:"email","x-go-type-skip-optional-pointer":true},"x-go-type-skip-optional-pointer":true},UserIds:{type:"array",items:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},"x-go-type-skip-optional-pointer":true},Price:{type:"integer",format:"int32","x-go-type-skip-optional-pointer":true},Endpoint:{description:"endpoint",format:"uri",pattern:"^https?://","x-go-type-skip-optional-pointer":true,type:"string"},RoleNames:{type:"array",items:{type:"string","x-go-type-skip-optional-pointer":true},"x-go-type-skip-optional-pointer":true},RecordsPage:{discriminator:{propertyName:"recordType"},properties:{page:{type:"integer","x-go-type-skip-optional-pointer":true,description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer","x-go-type-skip-optional-pointer":true,description:"Number of items per page.",minimum:1},recordsTotal:{type:"integer","x-go-type-skip-optional-pointer":true,description:"The records total of the recordspage.",minimum:0},recordType:{type:"string","x-go-type-skip-optional-pointer":true,description:"The record type of the recordspage.",maxLength:500}},"x-go-type-skip-optional-pointer":true},ResultsPage:{discriminator:{propertyName:"resultType"},properties:{page:{type:"integer","x-go-type-skip-optional-pointer":true,description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer","x-go-type-skip-optional-pointer":true,description:"Number of items per page.",minimum:1},totalCount:{type:"integer","x-go-type-skip-optional-pointer":true,description:"Total number of items available.",minimum:0},resultType:{type:"string","x-go-type-skip-optional-pointer":true,description:"The result type of the resultspage.",maxLength:500}},"x-go-type-skip-optional-pointer":true},Empty:{description:"Body for empty request",type:"object",properties:{},"x-go-type-skip-optional-pointer":true},EmailPreference:{type:"object",properties:{welcomeEmail:{type:"boolean","x-go-type-skip-optional-pointer":true,description:"The welcome email of the emailpreference."},notifyRoleChange:{type:"boolean","x-go-type-skip-optional-pointer":true,description:"The notify role change of the emailpreference."}},"x-go-type-skip-optional-pointer":true},UserUuid:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId"},"x-go-name":"UserID","x-go-type-skip-optional-pointer":true},OrganizationId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"org_id",json:"orgId"},"x-go-type-name":"OrganizationId","x-go-type-skip-optional-pointer":true},GeneralId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-go-type-name":"GeneralId","x-go-type-skip-optional-pointer":true},EnvironmentId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"environment_id",json:"environmentId"},"x-go-type-name":"EnvironmentId","x-go-type-skip-optional-pointer":true},WorkspaceId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},"x-go-type-name":"WorkspaceId","x-go-type-skip-optional-pointer":true},ViewId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"view_id",json:"viewId"},"x-go-type-name":"ViewId","x-go-type-skip-optional-pointer":true},TeamId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"team_id",json:"teamId"},"x-go-type-name":"TeamId","x-go-type-skip-optional-pointer":true},DesignId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"design_id",json:"designId"},"x-go-type-name":"DesignId","x-go-type-skip-optional-pointer":true},CredentialUuid:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"credential_id",json:"credentialId"},"x-go-name":"CredentialID","x-go-type-skip-optional-pointer":true},MesheryInstanceUuid:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"meshery_instance_id",json:"mesheryInstanceId"},"x-go-name":"MesheryInstanceID","x-go-type-skip-optional-pointer":true},KubernetesServerUuid:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"kubernetes_server_id",json:"kubernetesServerId"},"x-go-name":"KubernetesServerID","x-go-type-skip-optional-pointer":true},SystemId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"system_id"},"x-go-name":"SystemID","x-go-type-skip-optional-pointer":true},OperationId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"operation_id"},"x-go-name":"OperationID","x-go-type-skip-optional-pointer":true},UserId:{type:"string","x-go-name":"UserIdOrEmail",description:"user's email or username","x-go-type-skip-optional-pointer":true},CreatedAt:{description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},UpdatedAt:{description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},DeletedAt:{description:"Timestamp when the resource was deleted.","x-go-type":"NullTime",type:"string",format:"date-time","x-go-name":"DeletedAt","x-oapi-codegen-extra-tags":{db:"deleted_at",yaml:"deleted_at"},"x-go-type-skip-optional-pointer":true},NullTime:{description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true},Styles:{type:"object",description:"Common styles for all entities",additionalProperties:true,required:["primaryColor","svgColor","svgWhite","svgComplete"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.",maxLength:500},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.",maxLength:500},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.",maxLength:500},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.",maxLength:500},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.",maxLength:500},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:500},textOpacity:{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},fontFamily:{type:"string",description:"A comma-separated list of font names to use on the label text.",maxLength:500},fontSize:{type:"string",description:"The size of the label text.",maxLength:500},fontStyle:{type:"string",description:"A CSS font style to be applied to the label text.",maxLength:500},fontWeight:{type:"string",description:"A CSS font weight to be applied to the label text.",maxLength:500},textTransform:{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",description:"The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children.",minimum:0,maximum:1},zIndex:{type:"integer",description:"An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index.",minimum:0},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},animation:{type:"object",description:"The animation to apply to the element. example ripple,bounce,etc"}}},Shape:{type:"string",description:"The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)",enum:["ellipse","triangle","round-triangle","rectangle","round-rectangle","bottom-round-rectangle","cut-rectangle","barrel","rhomboid","diamond","round-diamond","pentagon","round-pentagon","hexagon","round-hexagon","concave-hexagon","heptagon","round-heptagon","octagon","round-octagon","star","tag","round-tag","vee","polygon"]},EdgeStyles:{type:"object",description:"Visualization styles for a relationship",allOf:[{type:"object",description:"Common styles for all entities",additionalProperties:true,required:["primaryColor","svgColor","svgWhite","svgComplete"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.",maxLength:500},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.",maxLength:500},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.",maxLength:500},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.",maxLength:500},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.",maxLength:500},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:500},textOpacity:{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},fontFamily:{type:"string",description:"A comma-separated list of font names to use on the label text.",maxLength:500},fontSize:{type:"string",description:"The size of the label text.",maxLength:500},fontStyle:{type:"string",description:"A CSS font style to be applied to the label text.",maxLength:500},fontWeight:{type:"string",description:"A CSS font weight to be applied to the label text.",maxLength:500},textTransform:{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",description:"The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children.",minimum:0,maximum:1},zIndex:{type:"integer",description:"An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index.",minimum:0},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},animation:{type:"object",description:"The animation to apply to the element. example ripple,bounce,etc"}}},{type:"object",properties:{edgeAnimation:{type:"string",description:"The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc .",maxLength:100},curveStyle:{type:"string",description:"The curving method used to separate two or more edges between two nodes; may be haystack (very fast, bundled straight edges for which loops and compounds are unsupported), straight (straight edges with all arrows supported), bezier (bundled curved edges), unbundled-bezier (curved edges for use with manual control points), segments (a series of straight lines), taxi (right-angled lines, hierarchically bundled). Note that haystack edges work best with ellipse, rectangle, or similar nodes. Smaller node shapes, like triangle, will not be as aesthetically pleasing. Also note that edge endpoint arrows are unsupported for haystack edges.",default:"straight",enum:["straight","haystack","bezier","unbundled-bezier","segments","taxi"]},lineColor:{type:"string",description:"The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},lineStyle:{type:"string",description:"The style of the edge's line.",enum:["solid","dotted","dashed"]},lineCap:{type:"string",description:"The cap style of the edge's line; may be butt (default), round, or square. The cap may or may not be visible, depending on the shape of the node and the relative size of the node and edge. Caps other than butt extend beyond the specified endpoint of the edge.",enum:["butt","round","square"],default:"butt"},lineOpacity:{type:"number",minimum:0,maximum:1,default:1,description:"The opacity of the edge's line and arrow. Useful if you wish to have a separate opacity for the edge label versus the edge line. Note that the opacity value of the edge element affects the effective opacity of its line and label subcomponents."},targetArrowColor:{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},targetArrowShape:{type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},targetArrowFill:{type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},midTargetArrowColor:{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},midTargetArrowShape:{type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},midTargetArrowFill:{type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},arrowScale:{type:"number",description:"Scaling for the arrow size.",minimum:0},sourceLabel:{type:"string",description:"The text to display for an edge's source label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},targetLabel:{type:"string",description:"The text to display for an edge's target label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500}}}]},ComponentStyles:{type:"object",description:"Visualization styles for a component",required:["shape","primaryColor","svgColor","svgWhite","svgComplete"],allOf:[{type:"object",description:"Common styles for all entities",additionalProperties:true,required:["primaryColor","svgColor","svgWhite","svgComplete"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.",maxLength:500},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.",maxLength:500},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.",maxLength:500},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.",maxLength:500},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.",maxLength:500},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:500},textOpacity:{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},fontFamily:{type:"string",description:"A comma-separated list of font names to use on the label text.",maxLength:500},fontSize:{type:"string",description:"The size of the label text.",maxLength:500},fontStyle:{type:"string",description:"A CSS font style to be applied to the label text.",maxLength:500},fontWeight:{type:"string",description:"A CSS font weight to be applied to the label text.",maxLength:500},textTransform:{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",description:"The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children.",minimum:0,maximum:1},zIndex:{type:"integer",description:"An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index.",minimum:0},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},animation:{type:"object",description:"The animation to apply to the element. example ripple,bounce,etc"}}},{type:"object",properties:{shape:{type:"string",description:"The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)",enum:["ellipse","triangle","round-triangle","rectangle","round-rectangle","bottom-round-rectangle","cut-rectangle","barrel","rhomboid","diamond","round-diamond","pentagon","round-pentagon","hexagon","round-hexagon","concave-hexagon","heptagon","round-heptagon","octagon","round-octagon","star","tag","round-tag","vee","polygon"]},position:{type:"object",additionalProperties:false,required:["x","y"],description:"The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position.",properties:{x:{type:"number",description:"The x-coordinate of the node.",minimum:-1e6,maximum:1e6,"x-go-type":"float64"},y:{type:"number",description:"The y-coordinate of the node.",minimum:-1e6,maximum:1e6,"x-go-type":"float64"}}},bodyText:{type:"string",description:"The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},bodyTextWrap:{type:"string",description:"How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.",enum:["none","wrap","ellipsis"]},bodyTextMaxWidth:{type:"string",description:"The maximum width for wrapping text in the node.",maxLength:50},bodyTextOpacity:{type:"number",description:"The opacity of the node's body text, including its outline.",minimum:0,maximum:1},bodyTextBackgroundColor:{type:"string",description:"The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},bodyTextFontSize:{type:"number",description:"The size of the node's body text.",minimum:0},bodyTextColor:{type:"string",description:"The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},bodyTextFontWeight:{type:"string",description:"A CSS font weight to be applied to the node's body text.",maxLength:50},bodyTextHorizontalAlign:{type:"string",description:"A CSS horizontal alignment to be applied to the node's body text.",maxLength:50},bodyTextDecoration:{type:"string",description:"A CSS text decoration to be applied to the node's body text.",maxLength:100},bodyTextVerticalAlign:{type:"string",description:"A CSS vertical alignment to be applied to the node's body text.",maxLength:50},width:{type:"number",description:"The width of the node's body or the width of an edge's line.",minimum:0},height:{type:"number",description:"The height of the node's body",minimum:0},backgroundImage:{type:"string",format:"uri",description:"The URL that points to the image to show in the node.",maxLength:2048},backgroundColor:{type:"string",description:"The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},backgroundBlacken:{type:"number",description:"Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1.",maximum:1,minimum:-1},backgroundOpacity:{type:"number",description:"The opacity level of the node's background colour",maximum:1,minimum:0},backgroundPositionX:{type:"string",description:"The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px)",maxLength:50},backgroundPositionY:{type:"string",description:"The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px)",maxLength:50},backgroundOffsetX:{type:"string",description:"The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px)",maxLength:50},backgroundOffsetY:{type:"string",description:"The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px)",maxLength:50},backgroundFit:{type:"string",description:"How the background image is fit to the node. Can be 'none', 'contain', or 'cover'.",enum:["none","contain","cover"]},backgroundClip:{type:"string",description:"How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.",enum:["none","node","node-border"]},backgroundWidthRelativeTo:{type:"string",description:"How the background image's width is determined. Can be 'none', 'inner', or 'outer'.",enum:["none","inner","outer"]},backgroundHeightRelativeTo:{type:"string",description:"How the background image's height is determined. Can be 'none', 'inner', or 'outer'.",enum:["none","inner","outer"]},borderWidth:{type:"number",description:"The size of the node's border.",minimum:0},borderStyle:{type:"string",description:"The style of the node's border",enum:["solid","dotted","dashed","double"]},borderColor:{type:"string",description:"The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},borderOpacity:{type:"number",description:"The opacity of the node's border",minimum:0,maximum:1},padding:{type:"number",description:"The amount of padding around all sides of the node.",minimum:0},textHalign:{type:"string",description:"The horizontal alignment of a node's label",enum:["left","center","right"]},textValign:{type:"string",description:"The vertical alignment of a node's label",enum:["top","center","bottom"]},ghost:{type:"string",description:"Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.",default:"no",enum:["yes","no"]},activeBgColor:{type:"string",description:"The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},activeBgOpacity:{type:"string",description:"The opacity of the active background indicator. Selector needs to be *core*.",maxLength:50},activeBgSize:{type:"string",description:"The opacity of the active background indicator. Selector needs to be *core*.",maxLength:50},selectionBoxColor:{type:"string",description:"The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},selectionBoxBorderWidth:{type:"number",description:"The size of the border on the selection box. Selector needs to be *core*",minimum:0},selectionBoxOpacity:{type:"number",description:"The opacity of the selection box. Selector needs to be *core*",minimum:0,maximum:1},outsideTextureBgColor:{type:"string",description:"The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},outsideTextureBgOpacity:{type:"number",description:"The opacity of the area outside the viewport texture. Selector needs to be *core*",minimum:0,maximum:1},shapePolygonPoints:{type:"string",description:"An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 )",maxLength:2e3},menuBackgroundColor:{type:"string",description:"The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},menuBackgroundOpacity:{type:"number",description:"The opacity of the background of the component menu.",minimum:0,maximum:1},menuForgroundColor:{type:"string",description:"The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100}}}]},RelationshipStyles:{oneOf:[{type:"object",description:"Visualization styles for a relationship",allOf:[{type:"object",description:"Common styles for all entities",additionalProperties:true,required:["primaryColor","svgColor","svgWhite","svgComplete"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.",maxLength:500},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.",maxLength:500},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.",maxLength:500},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.",maxLength:500},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.",maxLength:500},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:500},textOpacity:{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},fontFamily:{type:"string",description:"A comma-separated list of font names to use on the label text.",maxLength:500},fontSize:{type:"string",description:"The size of the label text.",maxLength:500},fontStyle:{type:"string",description:"A CSS font style to be applied to the label text.",maxLength:500},fontWeight:{type:"string",description:"A CSS font weight to be applied to the label text.",maxLength:500},textTransform:{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",description:"The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children.",minimum:0,maximum:1},zIndex:{type:"integer",description:"An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index.",minimum:0},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},animation:{type:"object",description:"The animation to apply to the element. example ripple,bounce,etc"}}},{type:"object",properties:{edgeAnimation:{type:"string",description:"The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc .",maxLength:100},curveStyle:{type:"string",description:"The curving method used to separate two or more edges between two nodes; may be haystack (very fast, bundled straight edges for which loops and compounds are unsupported), straight (straight edges with all arrows supported), bezier (bundled curved edges), unbundled-bezier (curved edges for use with manual control points), segments (a series of straight lines), taxi (right-angled lines, hierarchically bundled). Note that haystack edges work best with ellipse, rectangle, or similar nodes. Smaller node shapes, like triangle, will not be as aesthetically pleasing. Also note that edge endpoint arrows are unsupported for haystack edges.",default:"straight",enum:["straight","haystack","bezier","unbundled-bezier","segments","taxi"]},lineColor:{type:"string",description:"The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},lineStyle:{type:"string",description:"The style of the edge's line.",enum:["solid","dotted","dashed"]},lineCap:{type:"string",description:"The cap style of the edge's line; may be butt (default), round, or square. The cap may or may not be visible, depending on the shape of the node and the relative size of the node and edge. Caps other than butt extend beyond the specified endpoint of the edge.",enum:["butt","round","square"],default:"butt"},lineOpacity:{type:"number",minimum:0,maximum:1,default:1,description:"The opacity of the edge's line and arrow. Useful if you wish to have a separate opacity for the edge label versus the edge line. Note that the opacity value of the edge element affects the effective opacity of its line and label subcomponents."},targetArrowColor:{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},targetArrowShape:{type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},targetArrowFill:{type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},midTargetArrowColor:{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},midTargetArrowShape:{type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},midTargetArrowFill:{type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},arrowScale:{type:"number",description:"Scaling for the arrow size.",minimum:0},sourceLabel:{type:"string",description:"The text to display for an edge's source label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},targetLabel:{type:"string",description:"The text to display for an edge's target label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500}}}]},{allOf:[{type:"object",description:"Common styles for all entities",additionalProperties:true,required:["primaryColor","svgColor","svgWhite","svgComplete"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.",maxLength:500},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.",maxLength:500},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.",maxLength:500},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.",maxLength:500},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.",maxLength:500},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:500},textOpacity:{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},fontFamily:{type:"string",description:"A comma-separated list of font names to use on the label text.",maxLength:500},fontSize:{type:"string",description:"The size of the label text.",maxLength:500},fontStyle:{type:"string",description:"A CSS font style to be applied to the label text.",maxLength:500},fontWeight:{type:"string",description:"A CSS font weight to be applied to the label text.",maxLength:500},textTransform:{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",description:"The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children.",minimum:0,maximum:1},zIndex:{type:"integer",description:"An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index.",minimum:0},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},animation:{type:"object",description:"The animation to apply to the element. example ripple,bounce,etc"}}},{additionalProperties:true}],description:"Extension point for additional styles"}]},NonResolvedAlias:{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationshipId:{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"}},aliasComponentId:{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"}},immediateParentId:{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"}},immediateRefFieldPath:{type:"array",items:{type:"string"},description:"The immediate ref field path of the nonresolvedalias."}},required:["relationshipId","aliasComponentId","immediateParentId","immediateRefFieldPath"]},ResolvedAlias:{description:"An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also",allOf:[{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationshipId:{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"}},aliasComponentId:{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"}},immediateParentId:{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"}},immediateRefFieldPath:{type:"array",items:{type:"string"},description:"The immediate ref field path of the nonresolvedalias."}},required:["relationshipId","aliasComponentId","immediateParentId","immediateRefFieldPath"]},{type:"object",properties:{resolvedParentId:{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"}},resolvedRefFieldPath:{type:"array",description:"Fully resolved field path targeted by the alias.",items:{type:"string"}}},required:["resolvedParentId","resolvedRefFieldPath"]}]},IaCFileTypes:{type:"string",description:"The type of the IaC file",enum:["meshery-design","helm-chart","k8s-manifest","docker-compose","k8s-kustomize"]},MeshkitError:{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`, `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:{id:{name:"id",in:"path",description:"Unique identifier",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},required:true},all:{name:"all",in:"query",description:"Get all possible entries",schema:{type:"boolean"}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},userId:{name:"userId",in:"query",description:"Filter catalog items by user ID. Pass multiple user IDs to fetch content for several users simultaneously.",schema:{type:"string"}},metrics:{name:"metrics",in:"query",description:"Include metrics associated with the designs.",schema:{type:"string"}},class:{name:"class",in:"query",description:"Filter catalog items based on their support class. Specify one or more classes per request as needed. Example: 'official' and 'verified'",schema:{type:"string"}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"integer"}},pagesizeWithAll:{name:"pagesize",in:"query",description:"Get responses by pagesize (pass all to get all responses)",schema:{type:"string"}},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}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},visibility:{name:"visibility",in:"query",description:"Get responses based on visibility - private, public or published",schema:{type:"string",description:"Visibility level of a resource. Controls who can see and access it.\n- `private`: Only the owner and explicitly shared users can access.\n- `public`: Anyone in the organization (or anonymous, depending on resource) can discover and access.\n- `published`: Promoted to the catalog for broad discovery beyond the owning organization.\n",enum:["private","public","published"],"x-go-type-skip-optional-pointer":true}},populate:{name:"populate",in:"query",description:"Populate the response with additional data like pattern_file",schema:{type:"string"}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},filter:{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}},isOAuth:{name:"isOAuth",in:"query",description:"To get OAuth tokens as well",schema:{type:"string"}},name:{name:"name",in:"query",description:"Name of the resource",schema:{type:"string"}},purpose:{name:"purpose",in:"query",description:"Purpose for which token is generated",schema:{type:"string"}},cumulative:{name:"cumulative",in:"query",description:"Cumulative events",schema:{type:"string"}},mesheryVersion:{name:"meshery-version",in:"path",description:"meshery version",schema:{type:"string"},required:true},os:{name:"os",in:"query",description:"user's os",schema:{type:"string"}},playground:{name:"playground",in:"query",description:"Is playground mode",schema:{type:"string"}},namespace:{name:"namespace",in:"query",description:"Namespace",schema:{type:"string"}},type:{name:"type",in:"query",description:"Type",schema:{type:"string"}},actorType:{name:"actorType",in:"path",description:"Type of actor e.g user, team, system, registrant",schema:{type:"string"},required:true},resourceType:{name:"resourceType",in:"path",description:"Type of resource e.g design, filter, view, environment, workspace",schema:{type:"string"},required:true},contentType:{in:"query",required:false,name:"type",description:"Filter catalog data based on type of content e.g (deployment, workloads, scaling...) multiple params can be passed",schema:{type:"string"}},contentTechnology:{in:"query",required:false,name:"technology",description:"Filter catalog data based on technology(compatibility) of content e.g (kubernetes, istio...) multiple params can be passed",schema:{type:"string"}}},responses:{200:{description:"ok",content:{"text/plain":{schema:{type:"string"}}}},201:{description:"",content:{"text/plain":{schema:{type:"string"}}}},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"}}}},409:{description:"Publish request already exists",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}},502:{description:"Bad gateway - an upstream service the operation depends on could not be reached or rejected the request",content:{"text/plain":{schema:{type:"string"}}}},MeshkitError400:{description:"Invalid request body or request param",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`, `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"}}}}}}},MeshkitError403:{description:"Forbidden",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`, `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"}}}}}}},MeshkitError404:{description:"Result not found",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`, `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"}}}}}}},MeshkitError409:{description:"Conflict",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`, `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"}}}}}}},MeshkitError500:{description:"Internal server error",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`, `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"}}}}}}},MeshkitError502:{description:"Bad gateway - an upstream service the operation depends on could not be reached or rejected the request",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`, `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"}}}}}}}}}},t=e;
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Core Schema Elements",description:"Reusable core schema elements for Meshery OpenAPI specifications.",version:"v1beta2",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:{schemas:{InputString:{type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$",description:"A string starting with an alphanumeric character. Spaces and hyphens allowed."},VersionString:{type:"string",minLength:2,maxLength:100,description:'API version of the object, optionally prefixed with an API group (e.g. "group.example.io/v1beta1" or bare "v1beta1").',pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+(alpha[0-9]*|beta[0-9]*|rc[0-9]*)?)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},SemverString:{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 100 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1'."},Uuid:{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"}},Id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},Username:{type:"string","x-go-type-skip-optional-pointer":true},Provider:{type:"string",description:"One of (x-oapi-codegen-extra-tags-cloud, github, google)","x-go-type-skip-optional-pointer":true},Time:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},SqlNullTime:{type:"string",format:"date-time","x-go-type":"sql.NullTime","x-go-type-import":{path:"database/sql"},"x-go-type-skip-optional-pointer":true},Email:{type:"string",format:"email",description:"email","x-go-type-skip-optional-pointer":true},Text:{type:"string","x-go-type-skip-optional-pointer":true},Visibility:{type:"string",description:"Visibility level of a resource. Controls who can see and access it.\n- `private`: Only the owner and explicitly shared users can access.\n- `public`: Anyone in the organization (or anonymous, depending on resource) can discover and access.\n- `published`: Promoted to the catalog for broad discovery beyond the owning organization.\n",enum:["private","public","published"],"x-go-type-skip-optional-pointer":true},Number:{type:"integer","x-go-type-skip-optional-pointer":true},AvatarUrl:{type:"string",description:"Link for profile picture","x-go-type-skip-optional-pointer":true},MapObject:{type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},Status:{type:"string","x-go-type-skip-optional-pointer":true},Bio:{type:"string","x-go-type-skip-optional-pointer":true},AcceptedTermsAt:{type:"string","x-go-type-skip-optional-pointer":true},Emails:{type:"array",items:{type:"string",format:"email",description:"email","x-go-type-skip-optional-pointer":true},"x-go-type-skip-optional-pointer":true},UserIds:{type:"array",items:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},"x-go-type-skip-optional-pointer":true},Price:{type:"integer",format:"int32","x-go-type-skip-optional-pointer":true},Endpoint:{description:"endpoint",format:"uri",pattern:"^https?://","x-go-type-skip-optional-pointer":true,type:"string"},RoleNames:{type:"array",items:{type:"string","x-go-type-skip-optional-pointer":true},"x-go-type-skip-optional-pointer":true},RecordsPage:{discriminator:{propertyName:"recordType"},properties:{page:{type:"integer","x-go-type-skip-optional-pointer":true,description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer","x-go-type-skip-optional-pointer":true,description:"Number of items per page.",minimum:1},recordsTotal:{type:"integer","x-go-type-skip-optional-pointer":true,description:"The records total of the recordspage.",minimum:0},recordType:{type:"string","x-go-type-skip-optional-pointer":true,description:"The record type of the recordspage.",maxLength:500}},"x-go-type-skip-optional-pointer":true},ResultsPage:{discriminator:{propertyName:"resultType"},properties:{page:{type:"integer","x-go-type-skip-optional-pointer":true,description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer","x-go-type-skip-optional-pointer":true,description:"Number of items per page.",minimum:1},totalCount:{type:"integer","x-go-type-skip-optional-pointer":true,description:"Total number of items available.",minimum:0},resultType:{type:"string","x-go-type-skip-optional-pointer":true,description:"The result type of the resultspage.",maxLength:500}},"x-go-type-skip-optional-pointer":true},Empty:{description:"Body for empty request",type:"object",properties:{},"x-go-type-skip-optional-pointer":true},EmailPreference:{type:"object",properties:{welcomeEmail:{type:"boolean","x-go-type-skip-optional-pointer":true,description:"The welcome email of the emailpreference."},notifyRoleChange:{type:"boolean","x-go-type-skip-optional-pointer":true,description:"The notify role change of the emailpreference."}},"x-go-type-skip-optional-pointer":true},UserUuid:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId"},"x-go-name":"UserID","x-go-type-skip-optional-pointer":true},OrganizationId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"org_id",json:"orgId"},"x-go-type-name":"OrganizationId","x-go-type-skip-optional-pointer":true},GeneralId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-go-type-name":"GeneralId","x-go-type-skip-optional-pointer":true},EnvironmentId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"environment_id",json:"environmentId"},"x-go-type-name":"EnvironmentId","x-go-type-skip-optional-pointer":true},WorkspaceId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},"x-go-type-name":"WorkspaceId","x-go-type-skip-optional-pointer":true},ViewId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"view_id",json:"viewId"},"x-go-type-name":"ViewId","x-go-type-skip-optional-pointer":true},TeamId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"team_id",json:"teamId"},"x-go-type-name":"TeamId","x-go-type-skip-optional-pointer":true},DesignId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"design_id",json:"designId"},"x-go-type-name":"DesignId","x-go-type-skip-optional-pointer":true},CredentialUuid:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"credential_id",json:"credentialId"},"x-go-name":"CredentialID","x-go-type-skip-optional-pointer":true},MesheryInstanceUuid:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"meshery_instance_id",json:"mesheryInstanceId"},"x-go-name":"MesheryInstanceID","x-go-type-skip-optional-pointer":true},KubernetesServerUuid:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"kubernetes_server_id",json:"kubernetesServerId"},"x-go-name":"KubernetesServerID","x-go-type-skip-optional-pointer":true},SystemId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"system_id"},"x-go-name":"SystemID","x-go-type-skip-optional-pointer":true},OperationId:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"operation_id"},"x-go-name":"OperationID","x-go-type-skip-optional-pointer":true},UserId:{type:"string","x-go-name":"UserIdOrEmail",description:"user's email or username","x-go-type-skip-optional-pointer":true},CreatedAt:{description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},UpdatedAt:{description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},DeletedAt:{description:"Timestamp when the resource was deleted.","x-go-type":"NullTime",type:"string",format:"date-time","x-go-name":"DeletedAt","x-oapi-codegen-extra-tags":{db:"deleted_at",yaml:"deleted_at"},"x-go-type-skip-optional-pointer":true},NullTime:{description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true},Styles:{type:"object",description:"Common styles for all entities",additionalProperties:true,required:["primaryColor","svgColor","svgWhite","svgComplete"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.",maxLength:500},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.",maxLength:500},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.",maxLength:500},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.",maxLength:500},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.",maxLength:500},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:500},textOpacity:{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},fontFamily:{type:"string",description:"A comma-separated list of font names to use on the label text.",maxLength:500},fontSize:{type:"string",description:"The size of the label text.",maxLength:500},fontStyle:{type:"string",description:"A CSS font style to be applied to the label text.",maxLength:500},fontWeight:{type:"string",description:"A CSS font weight to be applied to the label text.",maxLength:500},textTransform:{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",description:"The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children.",minimum:0,maximum:1},zIndex:{type:"integer",description:"An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index.",minimum:0},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},animation:{type:"object",description:"The animation to apply to the element. example ripple,bounce,etc"}}},Shape:{type:"string",description:"The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)",enum:["ellipse","triangle","round-triangle","rectangle","round-rectangle","bottom-round-rectangle","cut-rectangle","barrel","rhomboid","diamond","round-diamond","pentagon","round-pentagon","hexagon","round-hexagon","concave-hexagon","heptagon","round-heptagon","octagon","round-octagon","star","tag","round-tag","vee","polygon"]},EdgeStyles:{type:"object",description:"Visualization styles for a relationship",allOf:[{type:"object",description:"Common styles for all entities",additionalProperties:true,required:["primaryColor","svgColor","svgWhite","svgComplete"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.",maxLength:500},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.",maxLength:500},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.",maxLength:500},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.",maxLength:500},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.",maxLength:500},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:500},textOpacity:{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},fontFamily:{type:"string",description:"A comma-separated list of font names to use on the label text.",maxLength:500},fontSize:{type:"string",description:"The size of the label text.",maxLength:500},fontStyle:{type:"string",description:"A CSS font style to be applied to the label text.",maxLength:500},fontWeight:{type:"string",description:"A CSS font weight to be applied to the label text.",maxLength:500},textTransform:{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",description:"The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children.",minimum:0,maximum:1},zIndex:{type:"integer",description:"An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index.",minimum:0},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},animation:{type:"object",description:"The animation to apply to the element. example ripple,bounce,etc"}}},{type:"object",properties:{edgeAnimation:{type:"string",description:"The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc .",maxLength:100},curveStyle:{type:"string",description:"The curving method used to separate two or more edges between two nodes; may be haystack (very fast, bundled straight edges for which loops and compounds are unsupported), straight (straight edges with all arrows supported), bezier (bundled curved edges), unbundled-bezier (curved edges for use with manual control points), segments (a series of straight lines), taxi (right-angled lines, hierarchically bundled). Note that haystack edges work best with ellipse, rectangle, or similar nodes. Smaller node shapes, like triangle, will not be as aesthetically pleasing. Also note that edge endpoint arrows are unsupported for haystack edges.",default:"straight",enum:["straight","haystack","bezier","unbundled-bezier","segments","taxi"]},lineColor:{type:"string",description:"The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},lineStyle:{type:"string",description:"The style of the edge's line.",enum:["solid","dotted","dashed"]},lineCap:{type:"string",description:"The cap style of the edge's line; may be butt (default), round, or square. The cap may or may not be visible, depending on the shape of the node and the relative size of the node and edge. Caps other than butt extend beyond the specified endpoint of the edge.",enum:["butt","round","square"],default:"butt"},lineOpacity:{type:"number",minimum:0,maximum:1,default:1,description:"The opacity of the edge's line and arrow. Useful if you wish to have a separate opacity for the edge label versus the edge line. Note that the opacity value of the edge element affects the effective opacity of its line and label subcomponents."},targetArrowColor:{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},targetArrowShape:{type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},targetArrowFill:{type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},midTargetArrowColor:{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},midTargetArrowShape:{type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},midTargetArrowFill:{type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},arrowScale:{type:"number",description:"Scaling for the arrow size.",minimum:0},sourceLabel:{type:"string",description:"The text to display for an edge's source label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},targetLabel:{type:"string",description:"The text to display for an edge's target label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500}}}]},ComponentStyles:{type:"object",description:"Visualization styles for a component",required:["shape","primaryColor","svgColor","svgWhite","svgComplete"],allOf:[{type:"object",description:"Common styles for all entities",additionalProperties:true,required:["primaryColor","svgColor","svgWhite","svgComplete"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.",maxLength:500},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.",maxLength:500},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.",maxLength:500},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.",maxLength:500},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.",maxLength:500},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:500},textOpacity:{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},fontFamily:{type:"string",description:"A comma-separated list of font names to use on the label text.",maxLength:500},fontSize:{type:"string",description:"The size of the label text.",maxLength:500},fontStyle:{type:"string",description:"A CSS font style to be applied to the label text.",maxLength:500},fontWeight:{type:"string",description:"A CSS font weight to be applied to the label text.",maxLength:500},textTransform:{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",description:"The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children.",minimum:0,maximum:1},zIndex:{type:"integer",description:"An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index.",minimum:0},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},animation:{type:"object",description:"The animation to apply to the element. example ripple,bounce,etc"}}},{type:"object",properties:{shape:{type:"string",description:"The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)",enum:["ellipse","triangle","round-triangle","rectangle","round-rectangle","bottom-round-rectangle","cut-rectangle","barrel","rhomboid","diamond","round-diamond","pentagon","round-pentagon","hexagon","round-hexagon","concave-hexagon","heptagon","round-heptagon","octagon","round-octagon","star","tag","round-tag","vee","polygon"]},position:{type:"object",additionalProperties:false,required:["x","y"],description:"The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position.",properties:{x:{type:"number",description:"The x-coordinate of the node.",minimum:-1e6,maximum:1e6,"x-go-type":"float64"},y:{type:"number",description:"The y-coordinate of the node.",minimum:-1e6,maximum:1e6,"x-go-type":"float64"}}},bodyText:{type:"string",description:"The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},bodyTextWrap:{type:"string",description:"How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.",enum:["none","wrap","ellipsis"]},bodyTextMaxWidth:{type:"string",description:"The maximum width for wrapping text in the node.",maxLength:50},bodyTextOpacity:{type:"number",description:"The opacity of the node's body text, including its outline.",minimum:0,maximum:1},bodyTextBackgroundColor:{type:"string",description:"The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},bodyTextFontSize:{type:"number",description:"The size of the node's body text.",minimum:0},bodyTextColor:{type:"string",description:"The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},bodyTextFontWeight:{type:"string",description:"A CSS font weight to be applied to the node's body text.",maxLength:50},bodyTextHorizontalAlign:{type:"string",description:"A CSS horizontal alignment to be applied to the node's body text.",maxLength:50},bodyTextDecoration:{type:"string",description:"A CSS text decoration to be applied to the node's body text.",maxLength:100},bodyTextVerticalAlign:{type:"string",description:"A CSS vertical alignment to be applied to the node's body text.",maxLength:50},width:{type:"number",description:"The width of the node's body or the width of an edge's line.",minimum:0},height:{type:"number",description:"The height of the node's body",minimum:0},backgroundImage:{type:"string",format:"uri",description:"The URL that points to the image to show in the node.",maxLength:2048},backgroundColor:{type:"string",description:"The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},backgroundBlacken:{type:"number",description:"Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1.",maximum:1,minimum:-1},backgroundOpacity:{type:"number",description:"The opacity level of the node's background colour",maximum:1,minimum:0},backgroundPositionX:{type:"string",description:"The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px)",maxLength:50},backgroundPositionY:{type:"string",description:"The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px)",maxLength:50},backgroundOffsetX:{type:"string",description:"The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px)",maxLength:50},backgroundOffsetY:{type:"string",description:"The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px)",maxLength:50},backgroundFit:{type:"string",description:"How the background image is fit to the node. Can be 'none', 'contain', or 'cover'.",enum:["none","contain","cover"]},backgroundClip:{type:"string",description:"How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.",enum:["none","node","node-border"]},backgroundWidthRelativeTo:{type:"string",description:"How the background image's width is determined. Can be 'none', 'inner', or 'outer'.",enum:["none","inner","outer"]},backgroundHeightRelativeTo:{type:"string",description:"How the background image's height is determined. Can be 'none', 'inner', or 'outer'.",enum:["none","inner","outer"]},borderWidth:{type:"number",description:"The size of the node's border.",minimum:0},borderStyle:{type:"string",description:"The style of the node's border",enum:["solid","dotted","dashed","double"]},borderColor:{type:"string",description:"The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},borderOpacity:{type:"number",description:"The opacity of the node's border",minimum:0,maximum:1},padding:{type:"number",description:"The amount of padding around all sides of the node.",minimum:0},textHalign:{type:"string",description:"The horizontal alignment of a node's label",enum:["left","center","right"]},textValign:{type:"string",description:"The vertical alignment of a node's label",enum:["top","center","bottom"]},ghost:{type:"string",description:"Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.",default:"no",enum:["yes","no"]},activeBgColor:{type:"string",description:"The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},activeBgOpacity:{type:"string",description:"The opacity of the active background indicator. Selector needs to be *core*.",maxLength:50},activeBgSize:{type:"string",description:"The opacity of the active background indicator. Selector needs to be *core*.",maxLength:50},selectionBoxColor:{type:"string",description:"The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},selectionBoxBorderWidth:{type:"number",description:"The size of the border on the selection box. Selector needs to be *core*",minimum:0},selectionBoxOpacity:{type:"number",description:"The opacity of the selection box. Selector needs to be *core*",minimum:0,maximum:1},outsideTextureBgColor:{type:"string",description:"The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},outsideTextureBgOpacity:{type:"number",description:"The opacity of the area outside the viewport texture. Selector needs to be *core*",minimum:0,maximum:1},shapePolygonPoints:{type:"string",description:"An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 )",maxLength:2e3},menuBackgroundColor:{type:"string",description:"The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},menuBackgroundOpacity:{type:"number",description:"The opacity of the background of the component menu.",minimum:0,maximum:1},menuForgroundColor:{type:"string",description:"The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100}}}]},RelationshipStyles:{oneOf:[{type:"object",description:"Visualization styles for a relationship",allOf:[{type:"object",description:"Common styles for all entities",additionalProperties:true,required:["primaryColor","svgColor","svgWhite","svgComplete"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.",maxLength:500},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.",maxLength:500},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.",maxLength:500},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.",maxLength:500},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.",maxLength:500},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:500},textOpacity:{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},fontFamily:{type:"string",description:"A comma-separated list of font names to use on the label text.",maxLength:500},fontSize:{type:"string",description:"The size of the label text.",maxLength:500},fontStyle:{type:"string",description:"A CSS font style to be applied to the label text.",maxLength:500},fontWeight:{type:"string",description:"A CSS font weight to be applied to the label text.",maxLength:500},textTransform:{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",description:"The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children.",minimum:0,maximum:1},zIndex:{type:"integer",description:"An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index.",minimum:0},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},animation:{type:"object",description:"The animation to apply to the element. example ripple,bounce,etc"}}},{type:"object",properties:{edgeAnimation:{type:"string",description:"The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc .",maxLength:100},curveStyle:{type:"string",description:"The curving method used to separate two or more edges between two nodes; may be haystack (very fast, bundled straight edges for which loops and compounds are unsupported), straight (straight edges with all arrows supported), bezier (bundled curved edges), unbundled-bezier (curved edges for use with manual control points), segments (a series of straight lines), taxi (right-angled lines, hierarchically bundled). Note that haystack edges work best with ellipse, rectangle, or similar nodes. Smaller node shapes, like triangle, will not be as aesthetically pleasing. Also note that edge endpoint arrows are unsupported for haystack edges.",default:"straight",enum:["straight","haystack","bezier","unbundled-bezier","segments","taxi"]},lineColor:{type:"string",description:"The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},lineStyle:{type:"string",description:"The style of the edge's line.",enum:["solid","dotted","dashed"]},lineCap:{type:"string",description:"The cap style of the edge's line; may be butt (default), round, or square. The cap may or may not be visible, depending on the shape of the node and the relative size of the node and edge. Caps other than butt extend beyond the specified endpoint of the edge.",enum:["butt","round","square"],default:"butt"},lineOpacity:{type:"number",minimum:0,maximum:1,default:1,description:"The opacity of the edge's line and arrow. Useful if you wish to have a separate opacity for the edge label versus the edge line. Note that the opacity value of the edge element affects the effective opacity of its line and label subcomponents."},targetArrowColor:{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},targetArrowShape:{type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},targetArrowFill:{type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},midTargetArrowColor:{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:100},midTargetArrowShape:{type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},midTargetArrowFill:{type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},arrowScale:{type:"number",description:"Scaling for the arrow size.",minimum:0},sourceLabel:{type:"string",description:"The text to display for an edge's source label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},targetLabel:{type:"string",description:"The text to display for an edge's target label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500}}}]},{allOf:[{type:"object",description:"Common styles for all entities",additionalProperties:true,required:["primaryColor","svgColor","svgWhite","svgComplete"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.",maxLength:500},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.",maxLength:500},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.",maxLength:500},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.",maxLength:500},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.",maxLength:500},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.",maxLength:500},textOpacity:{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},fontFamily:{type:"string",description:"A comma-separated list of font names to use on the label text.",maxLength:500},fontSize:{type:"string",description:"The size of the label text.",maxLength:500},fontStyle:{type:"string",description:"A CSS font style to be applied to the label text.",maxLength:500},fontWeight:{type:"string",description:"A CSS font weight to be applied to the label text.",maxLength:500},textTransform:{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",description:"The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children.",minimum:0,maximum:1},zIndex:{type:"integer",description:"An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index.",minimum:0},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id",maxLength:500},animation:{type:"object",description:"The animation to apply to the element. example ripple,bounce,etc"}}},{additionalProperties:true}],description:"Extension point for additional styles"}]},NonResolvedAlias:{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationshipId:{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"}},aliasComponentId:{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"}},immediateParentId:{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"}},immediateRefFieldPath:{type:"array",items:{type:"string"},description:"The immediate ref field path of the nonresolvedalias."}},required:["relationshipId","aliasComponentId","immediateParentId","immediateRefFieldPath"]},ResolvedAlias:{description:"An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also",allOf:[{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationshipId:{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"}},aliasComponentId:{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"}},immediateParentId:{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"}},immediateRefFieldPath:{type:"array",items:{type:"string"},description:"The immediate ref field path of the nonresolvedalias."}},required:["relationshipId","aliasComponentId","immediateParentId","immediateRefFieldPath"]},{type:"object",properties:{resolvedParentId:{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"}},resolvedRefFieldPath:{type:"array",description:"Fully resolved field path targeted by the alias.",items:{type:"string"}}},required:["resolvedParentId","resolvedRefFieldPath"]}]},IaCFileTypes:{type:"string",description:"The type of the IaC file",enum:["meshery-design","helm-chart","k8s-manifest","docker-compose","k8s-kustomize"]},MeshkitError:{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:{id:{name:"id",in:"path",description:"Unique identifier",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},required:true},all:{name:"all",in:"query",description:"Get all possible entries",schema:{type:"boolean"}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},userId:{name:"userId",in:"query",description:"Filter catalog items by user ID. Pass multiple user IDs to fetch content for several users simultaneously.",schema:{type:"string"}},metrics:{name:"metrics",in:"query",description:"Include metrics associated with the designs.",schema:{type:"string"}},class:{name:"class",in:"query",description:"Filter catalog items based on their support class. Specify one or more classes per request as needed. Example: 'official' and 'verified'",schema:{type:"string"}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"integer"}},pagesizeWithAll:{name:"pagesize",in:"query",description:"Get responses by pagesize (pass all to get all responses)",schema:{type:"string"}},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}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},visibility:{name:"visibility",in:"query",description:"Get responses based on visibility - private, public or published",schema:{type:"string",description:"Visibility level of a resource. Controls who can see and access it.\n- `private`: Only the owner and explicitly shared users can access.\n- `public`: Anyone in the organization (or anonymous, depending on resource) can discover and access.\n- `published`: Promoted to the catalog for broad discovery beyond the owning organization.\n",enum:["private","public","published"],"x-go-type-skip-optional-pointer":true}},populate:{name:"populate",in:"query",description:"Populate the response with additional data like pattern_file",schema:{type:"string"}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},filter:{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}},isOAuth:{name:"isOAuth",in:"query",description:"To get OAuth tokens as well",schema:{type:"string"}},name:{name:"name",in:"query",description:"Name of the resource",schema:{type:"string"}},purpose:{name:"purpose",in:"query",description:"Purpose for which token is generated",schema:{type:"string"}},cumulative:{name:"cumulative",in:"query",description:"Cumulative events",schema:{type:"string"}},mesheryVersion:{name:"meshery-version",in:"path",description:"meshery version",schema:{type:"string"},required:true},os:{name:"os",in:"query",description:"user's os",schema:{type:"string"}},playground:{name:"playground",in:"query",description:"Is playground mode",schema:{type:"string"}},namespace:{name:"namespace",in:"query",description:"Namespace",schema:{type:"string"}},type:{name:"type",in:"query",description:"Type",schema:{type:"string"}},actorType:{name:"actorType",in:"path",description:"Type of actor e.g user, team, system, registrant",schema:{type:"string"},required:true},resourceType:{name:"resourceType",in:"path",description:"Type of resource e.g design, filter, view, environment, workspace",schema:{type:"string"},required:true},contentType:{in:"query",required:false,name:"type",description:"Filter catalog data based on type of content e.g (deployment, workloads, scaling...) multiple params can be passed",schema:{type:"string"}},contentTechnology:{in:"query",required:false,name:"technology",description:"Filter catalog data based on technology(compatibility) of content e.g (kubernetes, istio...) multiple params can be passed",schema:{type:"string"}}},responses:{200:{description:"ok",content:{"text/plain":{schema:{type:"string"}}}},201:{description:"",content:{"text/plain":{schema:{type:"string"}}}},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"}}}},409:{description:"Publish request already exists",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}},502:{description:"Bad gateway - an upstream service the operation depends on could not be reached or rejected the request",content:{"text/plain":{schema:{type:"string"}}}},MeshkitError400:{description:"Invalid request body or request param",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"}}}}}}},MeshkitError403:{description:"Forbidden",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"}}}}}}},MeshkitError404:{description:"Result not found",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"}}}}}}},MeshkitError409:{description:"Conflict",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"}}}}}}},MeshkitError500:{description:"Internal server error",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"}}}}}}},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"}}}}}}},MeshkitError502:{description:"Bad gateway - an upstream service the operation depends on could not be reached or rejected the request",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"}}}}}}}}}},t=e;
|
|
2
2
|
export{t as default};
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export type paths = Record<string, never>;
|
|
7
|
+
export type webhooks = Record<string, never>;
|
|
8
|
+
export interface components {
|
|
9
|
+
schemas: {
|
|
10
|
+
/**
|
|
11
|
+
* Activity Metrics Schema
|
|
12
|
+
* @description Server-returned per-activity reception figures for one post, as recorded
|
|
13
|
+
* in the `metadata` of an event on the events service (category `blowhorn`,
|
|
14
|
+
* action `activity_metrics`); the event construct carries the envelope and
|
|
15
|
+
* this construct names the metadata's own shape, which Event leaves open.
|
|
16
|
+
* One row is one activity as one export read it, identified by
|
|
17
|
+
* (organizationId, platform, activityRef, readingDate): a later export adds a
|
|
18
|
+
* reading rather than replacing an earlier one, so the rows are a time series
|
|
19
|
+
* and the reading with the latest readingDate is an activity's current
|
|
20
|
+
* figures. The events service appends and enforces no uniqueness, so
|
|
21
|
+
* re-importing an export records the same key twice: readers take, for each
|
|
22
|
+
* key, the most recently recorded event and must not sum duplicates. The figures come from a
|
|
23
|
+
* LinkedIn page content export's "All posts" sheet, whose header sits under
|
|
24
|
+
* a disclaimer row; readingDate is that export's date, the day the figures
|
|
25
|
+
* were true as of. `matched` records whether the row's link resolved to a
|
|
26
|
+
* stored content activity at import (through `content.promotion_link`,
|
|
27
|
+
* per-profile entries of an `all` row included); an unmatched row is kept,
|
|
28
|
+
* not dropped - the post was made outside Blowhorn and is still the page's
|
|
29
|
+
* reception. Every figure is nullable: a blank figure in the source export
|
|
30
|
+
* is not a zero.
|
|
31
|
+
*/
|
|
32
|
+
ActivityMetrics: {
|
|
33
|
+
/**
|
|
34
|
+
* Format: uuid
|
|
35
|
+
* @description Owning organization ID.
|
|
36
|
+
*/
|
|
37
|
+
organizationId: string;
|
|
38
|
+
/** @description The platform the activity was posted to (today only `linkedin` produces these exports). */
|
|
39
|
+
platform: string;
|
|
40
|
+
/** @description The activity's platform identifier, normalized to its URN (`urn:li:activity:<id>`, `urn:li:share:<id>` or `urn:li:ugcPost:<id>`) so the encoded and plain spellings of one link agree. The URN kind is kept, so one post reached as both an activity URN and a share URN is two activityRefs; the exports name each post by one link, so readings of the same post line up across exports. */
|
|
41
|
+
activityRef: string;
|
|
42
|
+
/**
|
|
43
|
+
* Format: date
|
|
44
|
+
* @description The export's date - the day the figures were read as of, as an ISO calendar date.
|
|
45
|
+
*/
|
|
46
|
+
readingDate: string;
|
|
47
|
+
/** @description The page the export belongs to, named as the source export names it. */
|
|
48
|
+
subject: string;
|
|
49
|
+
/** @description The post link as the export spelled it, before normalization to `activityRef`. */
|
|
50
|
+
link: string;
|
|
51
|
+
/** @description The post's title as the export gives it; null when the export names none. */
|
|
52
|
+
title?: string | null;
|
|
53
|
+
/** @description The post's type as the export gives it (for example `Organic`); null when the export names none. */
|
|
54
|
+
postType?: string | null;
|
|
55
|
+
/** @description Who the export says posted the activity; null when the export names none. */
|
|
56
|
+
postedBy?: string | null;
|
|
57
|
+
/**
|
|
58
|
+
* Format: date
|
|
59
|
+
* @description The day the activity was created, as an ISO calendar date; null when the export names none.
|
|
60
|
+
*/
|
|
61
|
+
createdDate?: string | null;
|
|
62
|
+
/** @description The audience the export names for the activity; null when it names none. */
|
|
63
|
+
audience?: string | null;
|
|
64
|
+
/** @description The content type the export names for the activity; null when it names none. */
|
|
65
|
+
contentType?: string | null;
|
|
66
|
+
/** @description Impressions the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
67
|
+
impressions?: number | null;
|
|
68
|
+
/** @description Views the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
69
|
+
views?: number | null;
|
|
70
|
+
/** @description Offsite views the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
71
|
+
offsiteViews?: number | null;
|
|
72
|
+
/** @description Clicks the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
73
|
+
clicks?: number | null;
|
|
74
|
+
/**
|
|
75
|
+
* Format: double
|
|
76
|
+
* @description Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank.
|
|
77
|
+
*/
|
|
78
|
+
clickThroughRate?: number | null;
|
|
79
|
+
/** @description Likes the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
80
|
+
likes?: number | null;
|
|
81
|
+
/** @description Comments the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
82
|
+
comments?: number | null;
|
|
83
|
+
/** @description Reposts the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
84
|
+
reposts?: number | null;
|
|
85
|
+
/** @description Follows the activity had produced by the reading date; null when the export's cell is blank. */
|
|
86
|
+
follows?: number | null;
|
|
87
|
+
/**
|
|
88
|
+
* Format: double
|
|
89
|
+
* @description Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank.
|
|
90
|
+
*/
|
|
91
|
+
engagementRate?: number | null;
|
|
92
|
+
/** @description Whether the activity's link resolved to a stored content activity at import. */
|
|
93
|
+
matched: boolean;
|
|
94
|
+
/** @description The content row the activity matched, when it matched; null for an unmatched activity. */
|
|
95
|
+
contentRow?: number | null;
|
|
96
|
+
/** @description The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched. */
|
|
97
|
+
contentProfile?: string | null;
|
|
98
|
+
/** @description The export file the row was read from; empty when the row did not come from a file export. */
|
|
99
|
+
sourceFile: string;
|
|
100
|
+
};
|
|
101
|
+
/**
|
|
102
|
+
* Activity Metrics Payload Schema
|
|
103
|
+
* @description Payload for recording one activity's reception figures as of one export,
|
|
104
|
+
* sent as the `metadata` of a create-event call. Contains only
|
|
105
|
+
* client-settable fields; the row has no server-generated fields, because
|
|
106
|
+
* the events service stores and returns event metadata verbatim, so the
|
|
107
|
+
* payload and the recorded row (ActivityMetrics) share one field set.
|
|
108
|
+
*/
|
|
109
|
+
ActivityMetricsPayload: {
|
|
110
|
+
/**
|
|
111
|
+
* Format: uuid
|
|
112
|
+
* @description Owning organization ID.
|
|
113
|
+
*/
|
|
114
|
+
organizationId: string;
|
|
115
|
+
/** @description The platform the activity was posted to (today only `linkedin` produces these exports). */
|
|
116
|
+
platform: string;
|
|
117
|
+
/** @description The activity's platform identifier, normalized to its URN (`urn:li:activity:<id>`, `urn:li:share:<id>` or `urn:li:ugcPost:<id>`) so the encoded and plain spellings of one link agree. The URN kind is kept, so one post reached as both an activity URN and a share URN is two activityRefs; the exports name each post by one link, so readings of the same post line up across exports. */
|
|
118
|
+
activityRef: string;
|
|
119
|
+
/**
|
|
120
|
+
* Format: date
|
|
121
|
+
* @description The export's date - the day the figures were read as of, as an ISO calendar date.
|
|
122
|
+
*/
|
|
123
|
+
readingDate: string;
|
|
124
|
+
/** @description The page the export belongs to, named as the source export names it. */
|
|
125
|
+
subject: string;
|
|
126
|
+
/** @description The post link as the export spelled it, before normalization to `activityRef`. */
|
|
127
|
+
link: string;
|
|
128
|
+
/** @description The post's title as the export gives it; null when the export names none. */
|
|
129
|
+
title?: string | null;
|
|
130
|
+
/** @description The post's type as the export gives it (for example `Organic`); null when the export names none. */
|
|
131
|
+
postType?: string | null;
|
|
132
|
+
/** @description Who the export says posted the activity; null when the export names none. */
|
|
133
|
+
postedBy?: string | null;
|
|
134
|
+
/**
|
|
135
|
+
* Format: date
|
|
136
|
+
* @description The day the activity was created, as an ISO calendar date; null when the export names none.
|
|
137
|
+
*/
|
|
138
|
+
createdDate?: string | null;
|
|
139
|
+
/** @description The audience the export names for the activity; null when it names none. */
|
|
140
|
+
audience?: string | null;
|
|
141
|
+
/** @description The content type the export names for the activity; null when it names none. */
|
|
142
|
+
contentType?: string | null;
|
|
143
|
+
/** @description Impressions the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
144
|
+
impressions?: number | null;
|
|
145
|
+
/** @description Views the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
146
|
+
views?: number | null;
|
|
147
|
+
/** @description Offsite views the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
148
|
+
offsiteViews?: number | null;
|
|
149
|
+
/** @description Clicks the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
150
|
+
clicks?: number | null;
|
|
151
|
+
/**
|
|
152
|
+
* Format: double
|
|
153
|
+
* @description Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank.
|
|
154
|
+
*/
|
|
155
|
+
clickThroughRate?: number | null;
|
|
156
|
+
/** @description Likes the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
157
|
+
likes?: number | null;
|
|
158
|
+
/** @description Comments the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
159
|
+
comments?: number | null;
|
|
160
|
+
/** @description Reposts the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
161
|
+
reposts?: number | null;
|
|
162
|
+
/** @description Follows the activity had produced by the reading date; null when the export's cell is blank. */
|
|
163
|
+
follows?: number | null;
|
|
164
|
+
/**
|
|
165
|
+
* Format: double
|
|
166
|
+
* @description Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank.
|
|
167
|
+
*/
|
|
168
|
+
engagementRate?: number | null;
|
|
169
|
+
/** @description Whether the activity's link resolved to a stored content activity at import. */
|
|
170
|
+
matched: boolean;
|
|
171
|
+
/** @description The content row the activity matched, when it matched; null for an unmatched activity. */
|
|
172
|
+
contentRow?: number | null;
|
|
173
|
+
/** @description The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched. */
|
|
174
|
+
contentProfile?: string | null;
|
|
175
|
+
/** @description The export file the row was read from; empty when the row did not come from a file export. */
|
|
176
|
+
sourceFile: string;
|
|
177
|
+
};
|
|
178
|
+
};
|
|
179
|
+
responses: never;
|
|
180
|
+
parameters: never;
|
|
181
|
+
requestBodies: never;
|
|
182
|
+
headers: never;
|
|
183
|
+
pathItems: never;
|
|
184
|
+
}
|
|
185
|
+
export type $defs = Record<string, never>;
|
|
186
|
+
export type operations = Record<string, never>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
'use strict';
|
|
File without changes
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"Activity Metrics",description:"OpenAPI schema for per-activity reception figures for one post,\nconsumed by Blowhorn's analytics store. The rows have no endpoints of\ntheir own: they are recorded and read back as the `metadata` of events\non the events service (category `blowhorn`, action `activity_metrics`;\nsee the event construct), so this file declares the components only and\nthe paths stay with the event construct.\n",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:{ActivityMetrics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Activity Metrics Schema",description:`Server-returned per-activity reception figures for one post, as recorded
|
|
2
|
+
in the \`metadata\` of an event on the events service (category \`blowhorn\`,
|
|
3
|
+
action \`activity_metrics\`); the event construct carries the envelope and
|
|
4
|
+
this construct names the metadata's own shape, which Event leaves open.
|
|
5
|
+
One row is one activity as one export read it, identified by
|
|
6
|
+
(organizationId, platform, activityRef, readingDate): a later export adds a
|
|
7
|
+
reading rather than replacing an earlier one, so the rows are a time series
|
|
8
|
+
and the reading with the latest readingDate is an activity's current
|
|
9
|
+
figures. The events service appends and enforces no uniqueness, so
|
|
10
|
+
re-importing an export records the same key twice: readers take, for each
|
|
11
|
+
key, the most recently recorded event and must not sum duplicates. The figures come from a
|
|
12
|
+
LinkedIn page content export's "All posts" sheet, whose header sits under
|
|
13
|
+
a disclaimer row; readingDate is that export's date, the day the figures
|
|
14
|
+
were true as of. \`matched\` records whether the row's link resolved to a
|
|
15
|
+
stored content activity at import (through \`content.promotion_link\`,
|
|
16
|
+
per-profile entries of an \`all\` row included); an unmatched row is kept,
|
|
17
|
+
not dropped - the post was made outside Blowhorn and is still the page's
|
|
18
|
+
reception. Every figure is nullable: a blank figure in the source export
|
|
19
|
+
is not a zero.
|
|
20
|
+
`,type:"object",additionalProperties:false,required:["organizationId","platform","activityRef","readingDate","subject","link","matched","sourceFile"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",maxLength:64,description:"The platform the activity was posted to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},activityRef:{type:"string",maxLength:255,description:"The activity's platform identifier, normalized to its URN (`urn:li:activity:<id>`, `urn:li:share:<id>` or `urn:li:ugcPost:<id>`) so the encoded and plain spellings of one link agree. The URN kind is kept, so one post reached as both an activity URN and a share URN is two activityRefs; the exports name each post by one link, so readings of the same post line up across exports.","x-oapi-codegen-extra-tags":{db:"activity_ref"},"x-order":3},readingDate:{type:"string",format:"date",description:"The export's date - the day the figures were read as of, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},subject:{type:"string",maxLength:255,description:"The page the export belongs to, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":5},link:{type:"string",maxLength:2048,description:"The post link as the export spelled it, before normalization to `activityRef`.","x-oapi-codegen-extra-tags":{db:"link"},"x-order":6},title:{type:"string",maxLength:3e3,nullable:true,description:"The post's title as the export gives it; null when the export names none.","x-oapi-codegen-extra-tags":{db:"title"},"x-order":7},postType:{type:"string",maxLength:64,nullable:true,description:"The post's type as the export gives it (for example `Organic`); null when the export names none.","x-oapi-codegen-extra-tags":{db:"post_type"},"x-order":8},postedBy:{type:"string",maxLength:255,nullable:true,description:"Who the export says posted the activity; null when the export names none.","x-oapi-codegen-extra-tags":{db:"posted_by"},"x-order":9},createdDate:{type:"string",format:"date",nullable:true,description:"The day the activity was created, as an ISO calendar date; null when the export names none.","x-oapi-codegen-extra-tags":{db:"created_date"},"x-order":10},audience:{type:"string",maxLength:255,nullable:true,description:"The audience the export names for the activity; null when it names none.","x-oapi-codegen-extra-tags":{db:"audience"},"x-order":11},contentType:{type:"string",maxLength:64,nullable:true,description:"The content type the export names for the activity; null when it names none.","x-oapi-codegen-extra-tags":{db:"content_type"},"x-order":12},impressions:{type:"integer",nullable:true,minimum:0,description:"Impressions the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"impressions"},"x-order":13},views:{type:"integer",nullable:true,minimum:0,description:"Views the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"views"},"x-order":14},offsiteViews:{type:"integer",nullable:true,minimum:0,description:"Offsite views the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"offsite_views"},"x-order":15},clicks:{type:"integer",nullable:true,minimum:0,description:"Clicks the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"clicks"},"x-order":16},clickThroughRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"click_through_rate"},"x-order":17},likes:{type:"integer",nullable:true,minimum:0,description:"Likes the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"likes"},"x-order":18},comments:{type:"integer",nullable:true,minimum:0,description:"Comments the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"comments"},"x-order":19},reposts:{type:"integer",nullable:true,minimum:0,description:"Reposts the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reposts"},"x-order":20},follows:{type:"integer",nullable:true,minimum:0,description:"Follows the activity had produced by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"follows"},"x-order":21},engagementRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"engagement_rate"},"x-order":22},matched:{type:"boolean",description:"Whether the activity's link resolved to a stored content activity at import.","x-oapi-codegen-extra-tags":{db:"matched"},"x-order":23},contentRow:{type:"integer",nullable:true,minimum:0,description:"The content row the activity matched, when it matched; null for an unmatched activity.","x-oapi-codegen-extra-tags":{db:"content_row"},"x-order":24},contentProfile:{type:"string",maxLength:255,nullable:true,description:"The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched.","x-oapi-codegen-extra-tags":{db:"content_profile"},"x-order":25},sourceFile:{type:"string",maxLength:1024,description:"The export file the row was read from; empty when the row did not come from a file export.","x-oapi-codegen-extra-tags":{db:"source_file"},"x-order":26}}},ActivityMetricsPayload:{$schema:"http://json-schema.org/draft-07/schema#",title:"Activity Metrics Payload Schema",description:`Payload for recording one activity's reception figures as of one export,
|
|
21
|
+
sent as the \`metadata\` of a create-event call. Contains only
|
|
22
|
+
client-settable fields; the row has no server-generated fields, because
|
|
23
|
+
the events service stores and returns event metadata verbatim, so the
|
|
24
|
+
payload and the recorded row (ActivityMetrics) share one field set.
|
|
25
|
+
`,type:"object",additionalProperties:false,required:["organizationId","platform","activityRef","readingDate","subject","link","matched","sourceFile"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID"},platform:{type:"string",maxLength:64,description:"The platform the activity was posted to (today only `linkedin` produces these exports)."},activityRef:{type:"string",maxLength:255,description:"The activity's platform identifier, normalized to its URN (`urn:li:activity:<id>`, `urn:li:share:<id>` or `urn:li:ugcPost:<id>`) so the encoded and plain spellings of one link agree. The URN kind is kept, so one post reached as both an activity URN and a share URN is two activityRefs; the exports name each post by one link, so readings of the same post line up across exports."},readingDate:{type:"string",format:"date",description:"The export's date - the day the figures were read as of, as an ISO calendar date."},subject:{type:"string",maxLength:255,description:"The page the export belongs to, named as the source export names it."},link:{type:"string",maxLength:2048,description:"The post link as the export spelled it, before normalization to `activityRef`."},title:{type:"string",maxLength:3e3,nullable:true,description:"The post's title as the export gives it; null when the export names none."},postType:{type:"string",maxLength:64,nullable:true,description:"The post's type as the export gives it (for example `Organic`); null when the export names none."},postedBy:{type:"string",maxLength:255,nullable:true,description:"Who the export says posted the activity; null when the export names none."},createdDate:{type:"string",format:"date",nullable:true,description:"The day the activity was created, as an ISO calendar date; null when the export names none."},audience:{type:"string",maxLength:255,nullable:true,description:"The audience the export names for the activity; null when it names none."},contentType:{type:"string",maxLength:64,nullable:true,description:"The content type the export names for the activity; null when it names none."},impressions:{type:"integer",nullable:true,minimum:0,description:"Impressions the activity had gathered by the reading date; null when the export's cell is blank."},views:{type:"integer",nullable:true,minimum:0,description:"Views the activity had gathered by the reading date; null when the export's cell is blank."},offsiteViews:{type:"integer",nullable:true,minimum:0,description:"Offsite views the activity had gathered by the reading date; null when the export's cell is blank."},clicks:{type:"integer",nullable:true,minimum:0,description:"Clicks the activity had gathered by the reading date; null when the export's cell is blank."},clickThroughRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank."},likes:{type:"integer",nullable:true,minimum:0,description:"Likes the activity had gathered by the reading date; null when the export's cell is blank."},comments:{type:"integer",nullable:true,minimum:0,description:"Comments the activity had gathered by the reading date; null when the export's cell is blank."},reposts:{type:"integer",nullable:true,minimum:0,description:"Reposts the activity had gathered by the reading date; null when the export's cell is blank."},follows:{type:"integer",nullable:true,minimum:0,description:"Follows the activity had produced by the reading date; null when the export's cell is blank."},engagementRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank."},matched:{type:"boolean",description:"Whether the activity's link resolved to a stored content activity at import."},contentRow:{type:"integer",nullable:true,minimum:0,description:"The content row the activity matched, when it matched; null for an unmatched activity."},contentProfile:{type:"string",maxLength:255,nullable:true,description:"The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched."},sourceFile:{type:"string",maxLength:1024,description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;module.exports=t;
|