@meshery/schemas 0.8.58 → 0.8.59
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/index.d.mts +176 -0
- package/dist/index.d.ts +176 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -37791,6 +37791,182 @@ declare const schema: {
|
|
|
37791
37791
|
};
|
|
37792
37792
|
};
|
|
37793
37793
|
};
|
|
37794
|
+
post: {
|
|
37795
|
+
"x-internal": string[];
|
|
37796
|
+
operationId: string;
|
|
37797
|
+
tags: string[];
|
|
37798
|
+
summary: string;
|
|
37799
|
+
requestBody: {
|
|
37800
|
+
content: {
|
|
37801
|
+
"application/json": {
|
|
37802
|
+
schema: {
|
|
37803
|
+
type: string;
|
|
37804
|
+
required: string[];
|
|
37805
|
+
properties: {
|
|
37806
|
+
id: {
|
|
37807
|
+
ref: string;
|
|
37808
|
+
"x-go-name": string;
|
|
37809
|
+
description: string;
|
|
37810
|
+
};
|
|
37811
|
+
is_default: {
|
|
37812
|
+
type: string;
|
|
37813
|
+
description: string;
|
|
37814
|
+
};
|
|
37815
|
+
email: {
|
|
37816
|
+
type: string;
|
|
37817
|
+
format: string;
|
|
37818
|
+
description: string;
|
|
37819
|
+
};
|
|
37820
|
+
orgId: {
|
|
37821
|
+
type: string;
|
|
37822
|
+
description: string;
|
|
37823
|
+
};
|
|
37824
|
+
expiresAt: {
|
|
37825
|
+
type: string;
|
|
37826
|
+
format: string;
|
|
37827
|
+
description: string;
|
|
37828
|
+
};
|
|
37829
|
+
quota: {
|
|
37830
|
+
type: string;
|
|
37831
|
+
description: string;
|
|
37832
|
+
};
|
|
37833
|
+
usedQuota: {
|
|
37834
|
+
type: string;
|
|
37835
|
+
description: string;
|
|
37836
|
+
};
|
|
37837
|
+
roles: {
|
|
37838
|
+
type: string;
|
|
37839
|
+
items: {
|
|
37840
|
+
type: string;
|
|
37841
|
+
description: string;
|
|
37842
|
+
};
|
|
37843
|
+
};
|
|
37844
|
+
teams: {
|
|
37845
|
+
type: string;
|
|
37846
|
+
items: {
|
|
37847
|
+
type: string;
|
|
37848
|
+
description: string;
|
|
37849
|
+
};
|
|
37850
|
+
};
|
|
37851
|
+
status: {
|
|
37852
|
+
type: string;
|
|
37853
|
+
"x-go-type": string;
|
|
37854
|
+
enum: string[];
|
|
37855
|
+
description: string;
|
|
37856
|
+
};
|
|
37857
|
+
createdAt: {
|
|
37858
|
+
type: string;
|
|
37859
|
+
format: string;
|
|
37860
|
+
description: string;
|
|
37861
|
+
};
|
|
37862
|
+
updatedAt: {
|
|
37863
|
+
type: string;
|
|
37864
|
+
format: string;
|
|
37865
|
+
description: string;
|
|
37866
|
+
};
|
|
37867
|
+
deletedAt: {
|
|
37868
|
+
type: string;
|
|
37869
|
+
format: string;
|
|
37870
|
+
"x-go-type": string;
|
|
37871
|
+
description: string;
|
|
37872
|
+
};
|
|
37873
|
+
};
|
|
37874
|
+
};
|
|
37875
|
+
};
|
|
37876
|
+
};
|
|
37877
|
+
required: boolean;
|
|
37878
|
+
};
|
|
37879
|
+
responses: {
|
|
37880
|
+
"201": {
|
|
37881
|
+
content: {
|
|
37882
|
+
"application/json": {
|
|
37883
|
+
schema: {
|
|
37884
|
+
type: string;
|
|
37885
|
+
required: string[];
|
|
37886
|
+
properties: {
|
|
37887
|
+
id: {
|
|
37888
|
+
ref: string;
|
|
37889
|
+
"x-go-name": string;
|
|
37890
|
+
description: string;
|
|
37891
|
+
};
|
|
37892
|
+
is_default: {
|
|
37893
|
+
type: string;
|
|
37894
|
+
description: string;
|
|
37895
|
+
};
|
|
37896
|
+
email: {
|
|
37897
|
+
type: string;
|
|
37898
|
+
format: string;
|
|
37899
|
+
description: string;
|
|
37900
|
+
};
|
|
37901
|
+
orgId: {
|
|
37902
|
+
type: string;
|
|
37903
|
+
description: string;
|
|
37904
|
+
};
|
|
37905
|
+
expiresAt: {
|
|
37906
|
+
type: string;
|
|
37907
|
+
format: string;
|
|
37908
|
+
description: string;
|
|
37909
|
+
};
|
|
37910
|
+
quota: {
|
|
37911
|
+
type: string;
|
|
37912
|
+
description: string;
|
|
37913
|
+
};
|
|
37914
|
+
usedQuota: {
|
|
37915
|
+
type: string;
|
|
37916
|
+
description: string;
|
|
37917
|
+
};
|
|
37918
|
+
roles: {
|
|
37919
|
+
type: string;
|
|
37920
|
+
items: {
|
|
37921
|
+
type: string;
|
|
37922
|
+
description: string;
|
|
37923
|
+
};
|
|
37924
|
+
};
|
|
37925
|
+
teams: {
|
|
37926
|
+
type: string;
|
|
37927
|
+
items: {
|
|
37928
|
+
type: string;
|
|
37929
|
+
description: string;
|
|
37930
|
+
};
|
|
37931
|
+
};
|
|
37932
|
+
status: {
|
|
37933
|
+
type: string;
|
|
37934
|
+
"x-go-type": string;
|
|
37935
|
+
enum: string[];
|
|
37936
|
+
description: string;
|
|
37937
|
+
};
|
|
37938
|
+
createdAt: {
|
|
37939
|
+
type: string;
|
|
37940
|
+
format: string;
|
|
37941
|
+
description: string;
|
|
37942
|
+
};
|
|
37943
|
+
updatedAt: {
|
|
37944
|
+
type: string;
|
|
37945
|
+
format: string;
|
|
37946
|
+
description: string;
|
|
37947
|
+
};
|
|
37948
|
+
deletedAt: {
|
|
37949
|
+
type: string;
|
|
37950
|
+
format: string;
|
|
37951
|
+
"x-go-type": string;
|
|
37952
|
+
description: string;
|
|
37953
|
+
};
|
|
37954
|
+
};
|
|
37955
|
+
};
|
|
37956
|
+
};
|
|
37957
|
+
};
|
|
37958
|
+
};
|
|
37959
|
+
"400": {
|
|
37960
|
+
description: string;
|
|
37961
|
+
};
|
|
37962
|
+
"401": {
|
|
37963
|
+
description: string;
|
|
37964
|
+
};
|
|
37965
|
+
"500": {
|
|
37966
|
+
description: string;
|
|
37967
|
+
};
|
|
37968
|
+
};
|
|
37969
|
+
};
|
|
37794
37970
|
};
|
|
37795
37971
|
};
|
|
37796
37972
|
components: {
|
package/dist/index.d.ts
CHANGED
|
@@ -37791,6 +37791,182 @@ declare const schema: {
|
|
|
37791
37791
|
};
|
|
37792
37792
|
};
|
|
37793
37793
|
};
|
|
37794
|
+
post: {
|
|
37795
|
+
"x-internal": string[];
|
|
37796
|
+
operationId: string;
|
|
37797
|
+
tags: string[];
|
|
37798
|
+
summary: string;
|
|
37799
|
+
requestBody: {
|
|
37800
|
+
content: {
|
|
37801
|
+
"application/json": {
|
|
37802
|
+
schema: {
|
|
37803
|
+
type: string;
|
|
37804
|
+
required: string[];
|
|
37805
|
+
properties: {
|
|
37806
|
+
id: {
|
|
37807
|
+
ref: string;
|
|
37808
|
+
"x-go-name": string;
|
|
37809
|
+
description: string;
|
|
37810
|
+
};
|
|
37811
|
+
is_default: {
|
|
37812
|
+
type: string;
|
|
37813
|
+
description: string;
|
|
37814
|
+
};
|
|
37815
|
+
email: {
|
|
37816
|
+
type: string;
|
|
37817
|
+
format: string;
|
|
37818
|
+
description: string;
|
|
37819
|
+
};
|
|
37820
|
+
orgId: {
|
|
37821
|
+
type: string;
|
|
37822
|
+
description: string;
|
|
37823
|
+
};
|
|
37824
|
+
expiresAt: {
|
|
37825
|
+
type: string;
|
|
37826
|
+
format: string;
|
|
37827
|
+
description: string;
|
|
37828
|
+
};
|
|
37829
|
+
quota: {
|
|
37830
|
+
type: string;
|
|
37831
|
+
description: string;
|
|
37832
|
+
};
|
|
37833
|
+
usedQuota: {
|
|
37834
|
+
type: string;
|
|
37835
|
+
description: string;
|
|
37836
|
+
};
|
|
37837
|
+
roles: {
|
|
37838
|
+
type: string;
|
|
37839
|
+
items: {
|
|
37840
|
+
type: string;
|
|
37841
|
+
description: string;
|
|
37842
|
+
};
|
|
37843
|
+
};
|
|
37844
|
+
teams: {
|
|
37845
|
+
type: string;
|
|
37846
|
+
items: {
|
|
37847
|
+
type: string;
|
|
37848
|
+
description: string;
|
|
37849
|
+
};
|
|
37850
|
+
};
|
|
37851
|
+
status: {
|
|
37852
|
+
type: string;
|
|
37853
|
+
"x-go-type": string;
|
|
37854
|
+
enum: string[];
|
|
37855
|
+
description: string;
|
|
37856
|
+
};
|
|
37857
|
+
createdAt: {
|
|
37858
|
+
type: string;
|
|
37859
|
+
format: string;
|
|
37860
|
+
description: string;
|
|
37861
|
+
};
|
|
37862
|
+
updatedAt: {
|
|
37863
|
+
type: string;
|
|
37864
|
+
format: string;
|
|
37865
|
+
description: string;
|
|
37866
|
+
};
|
|
37867
|
+
deletedAt: {
|
|
37868
|
+
type: string;
|
|
37869
|
+
format: string;
|
|
37870
|
+
"x-go-type": string;
|
|
37871
|
+
description: string;
|
|
37872
|
+
};
|
|
37873
|
+
};
|
|
37874
|
+
};
|
|
37875
|
+
};
|
|
37876
|
+
};
|
|
37877
|
+
required: boolean;
|
|
37878
|
+
};
|
|
37879
|
+
responses: {
|
|
37880
|
+
"201": {
|
|
37881
|
+
content: {
|
|
37882
|
+
"application/json": {
|
|
37883
|
+
schema: {
|
|
37884
|
+
type: string;
|
|
37885
|
+
required: string[];
|
|
37886
|
+
properties: {
|
|
37887
|
+
id: {
|
|
37888
|
+
ref: string;
|
|
37889
|
+
"x-go-name": string;
|
|
37890
|
+
description: string;
|
|
37891
|
+
};
|
|
37892
|
+
is_default: {
|
|
37893
|
+
type: string;
|
|
37894
|
+
description: string;
|
|
37895
|
+
};
|
|
37896
|
+
email: {
|
|
37897
|
+
type: string;
|
|
37898
|
+
format: string;
|
|
37899
|
+
description: string;
|
|
37900
|
+
};
|
|
37901
|
+
orgId: {
|
|
37902
|
+
type: string;
|
|
37903
|
+
description: string;
|
|
37904
|
+
};
|
|
37905
|
+
expiresAt: {
|
|
37906
|
+
type: string;
|
|
37907
|
+
format: string;
|
|
37908
|
+
description: string;
|
|
37909
|
+
};
|
|
37910
|
+
quota: {
|
|
37911
|
+
type: string;
|
|
37912
|
+
description: string;
|
|
37913
|
+
};
|
|
37914
|
+
usedQuota: {
|
|
37915
|
+
type: string;
|
|
37916
|
+
description: string;
|
|
37917
|
+
};
|
|
37918
|
+
roles: {
|
|
37919
|
+
type: string;
|
|
37920
|
+
items: {
|
|
37921
|
+
type: string;
|
|
37922
|
+
description: string;
|
|
37923
|
+
};
|
|
37924
|
+
};
|
|
37925
|
+
teams: {
|
|
37926
|
+
type: string;
|
|
37927
|
+
items: {
|
|
37928
|
+
type: string;
|
|
37929
|
+
description: string;
|
|
37930
|
+
};
|
|
37931
|
+
};
|
|
37932
|
+
status: {
|
|
37933
|
+
type: string;
|
|
37934
|
+
"x-go-type": string;
|
|
37935
|
+
enum: string[];
|
|
37936
|
+
description: string;
|
|
37937
|
+
};
|
|
37938
|
+
createdAt: {
|
|
37939
|
+
type: string;
|
|
37940
|
+
format: string;
|
|
37941
|
+
description: string;
|
|
37942
|
+
};
|
|
37943
|
+
updatedAt: {
|
|
37944
|
+
type: string;
|
|
37945
|
+
format: string;
|
|
37946
|
+
description: string;
|
|
37947
|
+
};
|
|
37948
|
+
deletedAt: {
|
|
37949
|
+
type: string;
|
|
37950
|
+
format: string;
|
|
37951
|
+
"x-go-type": string;
|
|
37952
|
+
description: string;
|
|
37953
|
+
};
|
|
37954
|
+
};
|
|
37955
|
+
};
|
|
37956
|
+
};
|
|
37957
|
+
};
|
|
37958
|
+
};
|
|
37959
|
+
"400": {
|
|
37960
|
+
description: string;
|
|
37961
|
+
};
|
|
37962
|
+
"401": {
|
|
37963
|
+
description: string;
|
|
37964
|
+
};
|
|
37965
|
+
"500": {
|
|
37966
|
+
description: string;
|
|
37967
|
+
};
|
|
37968
|
+
};
|
|
37969
|
+
};
|
|
37794
37970
|
};
|
|
37795
37971
|
};
|
|
37796
37972
|
components: {
|
package/dist/index.js
CHANGED
|
@@ -362,5 +362,5 @@ copy: Copies a value from one location to another.
|
|
|
362
362
|
move: Moves a value from one location to another.
|
|
363
363
|
test: Tests that a value at the target location is equal to a specified value.`,$comment:`Array Indexing: When working with arrays, be aware that Kubernetes uses zero-based indexing in JSON patch paths.
|
|
364
364
|
Merge Patch vs. JSON Patch: Merge patches are less flexible than JSON patches and do not support all the same operations.
|
|
365
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}}}}}}}}}}},$schema:"http://json-schema.org/draft-04/schema#"},h=y;var u={openapi:"3.0.0",info:{title:"invitation",description:"OpenAPI schema for managing invitations",version:"v1beta1"},tags:[{name:"Invitation",description:"Operations related to invitation"}],paths:{"/api/organizations/invitations":{get:{"x-internal":["cloud"],operationId:"getInvitations",tags:["Invitation"],summary:"Get all invitations for the organization",responses:{200:{content:{"application/json":{schema:{type:"object",required:["items","totalCount"],properties:{data:{type:"array",items:{"x-go-type":"Invitation",type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}},description:"List of invitations"},totalCount:{type:"integer",description:"Total number of invitations available"}}}}}},400:{description:"Bad Request"},401:{description:"Unauthorized"},500:{description:"Internal Server Error"}}}}},components:{parameters:{organization_id:{name:"organizationId",in:"path",required:true,description:"The ID of the organization",schema:{type:"string"}}},responses:{400:{description:"Bad Request"},401:{description:"Unauthorized"},500:{description:"Internal Server Error"}},schemas:{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"}},InvitationsPage:{type:"object",required:["items","totalCount"],properties:{data:{type:"array",items:{"x-go-type":"Invitation",type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}},description:"List of invitations"},totalCount:{type:"integer",description:"Total number of invitations available"}}},InvitationStatus:{type:"string",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},Invitation:{type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}}}},$schema:"http://json-schema.org/draft-04/schema#"},f=u;
|
|
365
|
+
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}}}}}}}}}}},$schema:"http://json-schema.org/draft-04/schema#"},h=y;var u={openapi:"3.0.0",info:{title:"invitation",description:"OpenAPI schema for managing invitations",version:"v1beta1"},tags:[{name:"Invitation",description:"Operations related to invitation"}],paths:{"/api/organizations/invitations":{get:{"x-internal":["cloud"],operationId:"getInvitations",tags:["Invitation"],summary:"Get all invitations for the organization",responses:{200:{content:{"application/json":{schema:{type:"object",required:["items","totalCount"],properties:{data:{type:"array",items:{"x-go-type":"Invitation",type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}},description:"List of invitations"},totalCount:{type:"integer",description:"Total number of invitations available"}}}}}},400:{description:"Bad Request"},401:{description:"Unauthorized"},500:{description:"Internal Server Error"}}},post:{"x-internal":["cloud"],operationId:"createInvitation",tags:["Invitation"],summary:"Create a new invitation for the organization",requestBody:{content:{"application/json":{schema:{type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}}}},required:true},responses:{201:{content:{"application/json":{schema:{type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}}}}},400:{description:"Bad Request"},401:{description:"Unauthorized"},500:{description:"Internal Server Error"}}}}},components:{parameters:{organization_id:{name:"organizationId",in:"path",required:true,description:"The ID of the organization",schema:{type:"string"}}},responses:{400:{description:"Bad Request"},401:{description:"Unauthorized"},500:{description:"Internal Server Error"}},schemas:{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"}},InvitationsPage:{type:"object",required:["items","totalCount"],properties:{data:{type:"array",items:{"x-go-type":"Invitation",type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}},description:"List of invitations"},totalCount:{type:"integer",description:"Total number of invitations available"}}},InvitationStatus:{type:"string",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},Invitation:{type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}}}},$schema:"http://json-schema.org/draft-04/schema#"},f=u;
|
|
366
366
|
exports.CategoryDefinitionV1Beta1OpenApiSchema=a;exports.ComponentDefinitionV1Beta1OpenApiSchema=s;exports.DesignDefinitionV1Beta1OpenApiSchema=t;exports.EnvironmentDefinitionV1Beta1OpenApiSchema=l;exports.InvitationSchema=f;exports.ModelDefinitionV1Beta1OpenApiSchema=d;exports.RelationshipDefinitionV1Alpha3OpenApiSchema=h;exports.SubCategoryDefinitionV1Beta1OpenApiSchema=n;exports.WorkspaceDefinitionV1Beta1OpenApiSchema=g;
|
package/dist/index.mjs
CHANGED
|
@@ -362,5 +362,5 @@ copy: Copies a value from one location to another.
|
|
|
362
362
|
move: Moves a value from one location to another.
|
|
363
363
|
test: Tests that a value at the target location is equal to a specified value.`,$comment:`Array Indexing: When working with arrays, be aware that Kubernetes uses zero-based indexing in JSON patch paths.
|
|
364
364
|
Merge Patch vs. JSON Patch: Merge patches are less flexible than JSON patches and do not support all the same operations.
|
|
365
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}}}}}}}}}}},$schema:"http://json-schema.org/draft-04/schema#"},h=y;var u={openapi:"3.0.0",info:{title:"invitation",description:"OpenAPI schema for managing invitations",version:"v1beta1"},tags:[{name:"Invitation",description:"Operations related to invitation"}],paths:{"/api/organizations/invitations":{get:{"x-internal":["cloud"],operationId:"getInvitations",tags:["Invitation"],summary:"Get all invitations for the organization",responses:{200:{content:{"application/json":{schema:{type:"object",required:["items","totalCount"],properties:{data:{type:"array",items:{"x-go-type":"Invitation",type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}},description:"List of invitations"},totalCount:{type:"integer",description:"Total number of invitations available"}}}}}},400:{description:"Bad Request"},401:{description:"Unauthorized"},500:{description:"Internal Server Error"}}}}},components:{parameters:{organization_id:{name:"organizationId",in:"path",required:true,description:"The ID of the organization",schema:{type:"string"}}},responses:{400:{description:"Bad Request"},401:{description:"Unauthorized"},500:{description:"Internal Server Error"}},schemas:{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"}},InvitationsPage:{type:"object",required:["items","totalCount"],properties:{data:{type:"array",items:{"x-go-type":"Invitation",type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}},description:"List of invitations"},totalCount:{type:"integer",description:"Total number of invitations available"}}},InvitationStatus:{type:"string",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},Invitation:{type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}}}},$schema:"http://json-schema.org/draft-04/schema#"},f=u;
|
|
365
|
+
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}}}}}}}}}}},$schema:"http://json-schema.org/draft-04/schema#"},h=y;var u={openapi:"3.0.0",info:{title:"invitation",description:"OpenAPI schema for managing invitations",version:"v1beta1"},tags:[{name:"Invitation",description:"Operations related to invitation"}],paths:{"/api/organizations/invitations":{get:{"x-internal":["cloud"],operationId:"getInvitations",tags:["Invitation"],summary:"Get all invitations for the organization",responses:{200:{content:{"application/json":{schema:{type:"object",required:["items","totalCount"],properties:{data:{type:"array",items:{"x-go-type":"Invitation",type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}},description:"List of invitations"},totalCount:{type:"integer",description:"Total number of invitations available"}}}}}},400:{description:"Bad Request"},401:{description:"Unauthorized"},500:{description:"Internal Server Error"}}},post:{"x-internal":["cloud"],operationId:"createInvitation",tags:["Invitation"],summary:"Create a new invitation for the organization",requestBody:{content:{"application/json":{schema:{type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}}}},required:true},responses:{201:{content:{"application/json":{schema:{type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}}}}},400:{description:"Bad Request"},401:{description:"Unauthorized"},500:{description:"Internal Server Error"}}}}},components:{parameters:{organization_id:{name:"organizationId",in:"path",required:true,description:"The ID of the organization",schema:{type:"string"}}},responses:{400:{description:"Bad Request"},401:{description:"Unauthorized"},500:{description:"Internal Server Error"}},schemas:{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"}},InvitationsPage:{type:"object",required:["items","totalCount"],properties:{data:{type:"array",items:{"x-go-type":"Invitation",type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}},description:"List of invitations"},totalCount:{type:"integer",description:"Total number of invitations available"}}},InvitationStatus:{type:"string",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},Invitation:{type:"object",required:["id","default","email","orgId","expiresAt","quota","usedQuota","status","roles","teams","createdAt","updatedAt","deletedAt"],properties:{id:{ref:"#/components/schemas/uuid","x-go-name":"ID",description:"Unique identifier for the invitation , is also used as the invitation code"},is_default:{type:"boolean",description:"Indicates whether the invitation is a default invitation, which can be used to assign users when signing up from fqdn or custom domain, a organization can only have one default invitation"},email:{type:"string",format:"email",description:"Exact email address or the email address pattern for which the invitation is valid , null or empty string means the invitation is valid for all email addresses"},orgId:{type:"string",description:"ID of the organization to which the user is invited"},expiresAt:{type:"string",format:"date-time",description:"Timestamp when the invitation expires, if applicable , null or empty string means the invitation does not expire"},quota:{type:"integer",description:"Quota for the invitation, which can be used to limit the number of users that can accept the invitation, null or empty string means the invitation does not have a quota"},usedQuota:{type:"integer",description:"Number of times the invitation has been used, null or empty string means the invitation has not been used yet"},roles:{type:"array",items:{type:"string",description:"Roles that the user will have when accepting the invitation, null or empty string means the invitation does not specify any roles"}},teams:{type:"array",items:{type:"string",description:"Teams that the user will be added to when accepting the invitation, null or empty string means the invitation does not specify any teams"}},status:{type:"string","x-go-type":"InvitationStatus",enum:["enabled","disabled"],description:"Status of the invitation, where enabled means the invitation is active and can be used, disabled means the invitation is no longer valid and is temporarily inactive, disabled invitations can be re-enabled later."},createdAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was created"},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the invitation was last updated"},deletedAt:{type:"string",format:"date-time","x-go-type":"core.NullTime",description:"Timestamp when the invitation was deleted, if applicable"}}}}},$schema:"http://json-schema.org/draft-04/schema#"},f=u;
|
|
366
366
|
export{a as CategoryDefinitionV1Beta1OpenApiSchema,s as ComponentDefinitionV1Beta1OpenApiSchema,t as DesignDefinitionV1Beta1OpenApiSchema,l as EnvironmentDefinitionV1Beta1OpenApiSchema,f as InvitationSchema,d as ModelDefinitionV1Beta1OpenApiSchema,h as RelationshipDefinitionV1Alpha3OpenApiSchema,n as SubCategoryDefinitionV1Beta1OpenApiSchema,g as WorkspaceDefinitionV1Beta1OpenApiSchema};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@meshery/schemas",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.59",
|
|
4
4
|
"description": "<p style=\"text-align:center;\" align=\"center\"><a href=\"https://meshery.io\"><picture> <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-light-text-side.svg\"> <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg\"> <img src=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg\" alt=\"Meshery Logo\" width=\"70%\" /></picture></a><br /><br /></p> <p align=\"center\"> <a href=\"https://hub.docker.com/r/meshery/meshery\" alt=\"Docker pulls\"> <img src=\"https://img.shields.io/docker/pulls/meshery/meshery.svg\" /></a> <a href=\"https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+org%meshery+org%3Ameshery+org%3Aservice-mesh-performance+org%3Aservice-mesh-patterns+org%3A+label%3A%22help+wanted%22+\" alt=\"GitHub issues by-label\"> <img src=\"https://img.shields.io/github/issues/meshery/meshery/help%20wanted.svg?color=informational\" /></a> <a href=\"https://github.com/meshery/meshery/blob/master/LICENSE\" alt=\"LICENSE\"> <img src=\"https://img.shields.io/github/license/meshery/meshery?color=brightgreen\" /></a> <a href=\"https://artifacthub.io/packages/helm/meshery/meshery\" alt=\"Artifact Hub Meshery\"> <img src=\"https://img.shields.io/endpoint?color=brightgreen&label=Helm%20Chart&style=plastic&url=https%3A%2F%2Fartifacthub.io%2Fbadge%2Frepository%2Fartifact-hub\" /></a> <a href=\"https://goreportcard.com/report/github.com/meshery/meshery\" alt=\"Go Report Card\"> <img src=\"https://goreportcard.com/badge/github.com/meshery/meshery\" /></a> <a href=\"https://github.com/meshery/meshery/actions\" alt=\"Build Status\"> <img src=\"https://img.shields.io/github/actions/workflow/status/meshery/meshery/release-drafter.yml\" /></a> <a href=\"https://bestpractices.coreinfrastructure.org/projects/3564\" alt=\"CLI Best Practices\"> <img src=\"https://bestpractices.coreinfrastructure.org/projects/3564/badge\" /></a> <a href=\"http://discuss.meshery.io\" alt=\"Discuss Users\"> <img src=\"https://img.shields.io/discourse/users?label=discuss&logo=discourse&server=https%3A%2F%2Fdiscuss.meshery.io\" /></a> <a href=\"https://slack.meshery.io\" alt=\"Join Slack\"> <img src=\"https://img.shields.io/badge/Slack-@meshery.svg?logo=slack\" /></a> <a href=\"https://twitter.com/intent/follow?screen_name=mesheryio\" alt=\"Twitter Follow\"> <img src=\"https://img.shields.io/twitter/follow/mesheryio.svg?label=Follow+Meshery&style=social\" /></a> <a href=\"https://github.com/meshery/meshery/releases\" alt=\"Meshery Downloads\"> <img src=\"https://img.shields.io/github/downloads/meshery/meshery/total\" /></a> <!-- <a href=\"https://app.fossa.com/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery?ref=badge_shield\" alt=\"License Scan Report\"> <img src=\"https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery.svg?type=shield\"/></a> --> </p>",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|