@crowi/api-contract 2.0.0-alpha.11 → 2.0.0-alpha.12

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.
@@ -729,6 +729,211 @@ interface paths {
729
729
  patch?: never;
730
730
  trace?: never;
731
731
  };
732
+ "/invite/accept": {
733
+ parameters: {
734
+ query?: never;
735
+ header?: never;
736
+ path?: never;
737
+ cookie?: never;
738
+ };
739
+ /** Preview an invite (returns the invited email) for the acceptance page */
740
+ get: {
741
+ parameters: {
742
+ query: {
743
+ token: string;
744
+ };
745
+ header?: never;
746
+ path?: never;
747
+ cookie?: never;
748
+ };
749
+ requestBody?: never;
750
+ responses: {
751
+ /** @description Invite is valid */
752
+ 200: {
753
+ headers: {
754
+ [name: string]: unknown;
755
+ };
756
+ content: {
757
+ "application/json": {
758
+ /** Format: email */
759
+ email: string;
760
+ };
761
+ };
762
+ };
763
+ /** @description Invite token is invalid or expired */
764
+ 401: {
765
+ headers: {
766
+ [name: string]: unknown;
767
+ };
768
+ content: {
769
+ "application/json": {
770
+ error: {
771
+ code: components["schemas"]["ErrorCode"];
772
+ message: string;
773
+ details?: unknown;
774
+ };
775
+ };
776
+ };
777
+ };
778
+ /** @description Invite already accepted */
779
+ 409: {
780
+ headers: {
781
+ [name: string]: unknown;
782
+ };
783
+ content: {
784
+ "application/json": {
785
+ error: {
786
+ code: components["schemas"]["ErrorCode"];
787
+ message: string;
788
+ details?: unknown;
789
+ };
790
+ };
791
+ };
792
+ };
793
+ /** @description Internal server error */
794
+ 500: {
795
+ headers: {
796
+ [name: string]: unknown;
797
+ };
798
+ content: {
799
+ "application/json": {
800
+ error: {
801
+ /** @enum {string} */
802
+ code: "INTERNAL_ERROR";
803
+ /** @enum {string} */
804
+ message: "Internal server error";
805
+ };
806
+ };
807
+ };
808
+ };
809
+ };
810
+ };
811
+ put?: never;
812
+ /** Accept an invite: set credentials, activate the account, sign in */
813
+ post: {
814
+ parameters: {
815
+ query?: never;
816
+ header?: never;
817
+ path?: never;
818
+ cookie?: never;
819
+ };
820
+ requestBody?: {
821
+ content: {
822
+ "application/json": {
823
+ token: string;
824
+ username: string;
825
+ name: string;
826
+ password: string;
827
+ };
828
+ };
829
+ };
830
+ responses: {
831
+ /** @description Invite accepted; account activated and signed in */
832
+ 200: {
833
+ headers: {
834
+ [name: string]: unknown;
835
+ };
836
+ content: {
837
+ "application/json": {
838
+ accessToken: string;
839
+ refreshToken: string;
840
+ expiresIn: number;
841
+ user: {
842
+ id: string;
843
+ username: string;
844
+ /** Format: email */
845
+ email: string;
846
+ name: string;
847
+ image?: string;
848
+ admin?: boolean;
849
+ };
850
+ };
851
+ };
852
+ };
853
+ /** @description Validation failed */
854
+ 400: {
855
+ headers: {
856
+ [name: string]: unknown;
857
+ };
858
+ content: {
859
+ "application/json": {
860
+ error: {
861
+ code: components["schemas"]["ErrorCode"];
862
+ message: string;
863
+ details?: unknown;
864
+ };
865
+ };
866
+ };
867
+ };
868
+ /** @description Invite token is invalid or expired */
869
+ 401: {
870
+ headers: {
871
+ [name: string]: unknown;
872
+ };
873
+ content: {
874
+ "application/json": {
875
+ error: {
876
+ code: components["schemas"]["ErrorCode"];
877
+ message: string;
878
+ details?: unknown;
879
+ };
880
+ };
881
+ };
882
+ };
883
+ /** @description Invited user no longer exists */
884
+ 404: {
885
+ headers: {
886
+ [name: string]: unknown;
887
+ };
888
+ content: {
889
+ "application/json": {
890
+ error: {
891
+ code: components["schemas"]["ErrorCode"];
892
+ message: string;
893
+ details?: unknown;
894
+ };
895
+ };
896
+ };
897
+ };
898
+ /** @description Invite already accepted, or username already taken */
899
+ 409: {
900
+ headers: {
901
+ [name: string]: unknown;
902
+ };
903
+ content: {
904
+ "application/json": {
905
+ error: {
906
+ code: components["schemas"]["ErrorCode"];
907
+ message: string;
908
+ details?: unknown;
909
+ };
910
+ };
911
+ };
912
+ };
913
+ /** @description Internal server error */
914
+ 500: {
915
+ headers: {
916
+ [name: string]: unknown;
917
+ };
918
+ content: {
919
+ "application/json": {
920
+ error: {
921
+ /** @enum {string} */
922
+ code: "INTERNAL_ERROR";
923
+ /** @enum {string} */
924
+ message: "Internal server error";
925
+ };
926
+ };
927
+ };
928
+ };
929
+ };
930
+ };
931
+ delete?: never;
932
+ options?: never;
933
+ head?: never;
934
+ patch?: never;
935
+ trace?: never;
936
+ };
732
937
  "/me": {
733
938
  parameters: {
734
939
  query?: never;
@@ -13172,6 +13377,91 @@ interface paths {
13172
13377
  patch?: never;
13173
13378
  trace?: never;
13174
13379
  };
13380
+ "/admin/plugins/readiness": {
13381
+ parameters: {
13382
+ query?: never;
13383
+ header?: never;
13384
+ path?: never;
13385
+ cookie?: never;
13386
+ };
13387
+ /** List active plugins missing required readiness config fields */
13388
+ get: {
13389
+ parameters: {
13390
+ query?: never;
13391
+ header?: never;
13392
+ path?: never;
13393
+ cookie?: never;
13394
+ };
13395
+ requestBody?: never;
13396
+ responses: {
13397
+ /** @description Readiness issues for active plugins (empty when everything is configured) */
13398
+ 200: {
13399
+ headers: {
13400
+ [name: string]: unknown;
13401
+ };
13402
+ content: {
13403
+ "application/json": {
13404
+ issues: {
13405
+ name: string;
13406
+ adminPlacement: {
13407
+ /** @enum {string} */
13408
+ section: "settings" | "shared" | "storage" | "mail" | "notification" | "auth" | "search" | "renderer" | "platform";
13409
+ label: string;
13410
+ icon?: string;
13411
+ };
13412
+ fields: {
13413
+ name: string;
13414
+ /** @enum {boolean} */
13415
+ configured: false;
13416
+ }[];
13417
+ }[];
13418
+ };
13419
+ };
13420
+ };
13421
+ /** @description Authentication required */
13422
+ 401: {
13423
+ headers: {
13424
+ [name: string]: unknown;
13425
+ };
13426
+ content: {
13427
+ "application/json": {
13428
+ error: {
13429
+ /** @enum {string} */
13430
+ code: "AUTHENTICATION_REQUIRED";
13431
+ /** @enum {string} */
13432
+ message: "Authentication is required";
13433
+ redirectTo?: string;
13434
+ };
13435
+ };
13436
+ };
13437
+ };
13438
+ /** @description Admin permission required */
13439
+ 403: {
13440
+ headers: {
13441
+ [name: string]: unknown;
13442
+ };
13443
+ content: {
13444
+ "application/json": {
13445
+ error: {
13446
+ /** @enum {string} */
13447
+ code: "ADMIN_REQUIRED";
13448
+ /** @enum {string} */
13449
+ message: "Admin permission required";
13450
+ redirectTo?: string;
13451
+ };
13452
+ };
13453
+ };
13454
+ };
13455
+ };
13456
+ };
13457
+ put?: never;
13458
+ post?: never;
13459
+ delete?: never;
13460
+ options?: never;
13461
+ head?: never;
13462
+ patch?: never;
13463
+ trace?: never;
13464
+ };
13175
13465
  "/admin/plugins/render-cache/clear-all": {
13176
13466
  parameters: {
13177
13467
  query?: never;
@@ -729,6 +729,211 @@ interface paths {
729
729
  patch?: never;
730
730
  trace?: never;
731
731
  };
732
+ "/invite/accept": {
733
+ parameters: {
734
+ query?: never;
735
+ header?: never;
736
+ path?: never;
737
+ cookie?: never;
738
+ };
739
+ /** Preview an invite (returns the invited email) for the acceptance page */
740
+ get: {
741
+ parameters: {
742
+ query: {
743
+ token: string;
744
+ };
745
+ header?: never;
746
+ path?: never;
747
+ cookie?: never;
748
+ };
749
+ requestBody?: never;
750
+ responses: {
751
+ /** @description Invite is valid */
752
+ 200: {
753
+ headers: {
754
+ [name: string]: unknown;
755
+ };
756
+ content: {
757
+ "application/json": {
758
+ /** Format: email */
759
+ email: string;
760
+ };
761
+ };
762
+ };
763
+ /** @description Invite token is invalid or expired */
764
+ 401: {
765
+ headers: {
766
+ [name: string]: unknown;
767
+ };
768
+ content: {
769
+ "application/json": {
770
+ error: {
771
+ code: components["schemas"]["ErrorCode"];
772
+ message: string;
773
+ details?: unknown;
774
+ };
775
+ };
776
+ };
777
+ };
778
+ /** @description Invite already accepted */
779
+ 409: {
780
+ headers: {
781
+ [name: string]: unknown;
782
+ };
783
+ content: {
784
+ "application/json": {
785
+ error: {
786
+ code: components["schemas"]["ErrorCode"];
787
+ message: string;
788
+ details?: unknown;
789
+ };
790
+ };
791
+ };
792
+ };
793
+ /** @description Internal server error */
794
+ 500: {
795
+ headers: {
796
+ [name: string]: unknown;
797
+ };
798
+ content: {
799
+ "application/json": {
800
+ error: {
801
+ /** @enum {string} */
802
+ code: "INTERNAL_ERROR";
803
+ /** @enum {string} */
804
+ message: "Internal server error";
805
+ };
806
+ };
807
+ };
808
+ };
809
+ };
810
+ };
811
+ put?: never;
812
+ /** Accept an invite: set credentials, activate the account, sign in */
813
+ post: {
814
+ parameters: {
815
+ query?: never;
816
+ header?: never;
817
+ path?: never;
818
+ cookie?: never;
819
+ };
820
+ requestBody?: {
821
+ content: {
822
+ "application/json": {
823
+ token: string;
824
+ username: string;
825
+ name: string;
826
+ password: string;
827
+ };
828
+ };
829
+ };
830
+ responses: {
831
+ /** @description Invite accepted; account activated and signed in */
832
+ 200: {
833
+ headers: {
834
+ [name: string]: unknown;
835
+ };
836
+ content: {
837
+ "application/json": {
838
+ accessToken: string;
839
+ refreshToken: string;
840
+ expiresIn: number;
841
+ user: {
842
+ id: string;
843
+ username: string;
844
+ /** Format: email */
845
+ email: string;
846
+ name: string;
847
+ image?: string;
848
+ admin?: boolean;
849
+ };
850
+ };
851
+ };
852
+ };
853
+ /** @description Validation failed */
854
+ 400: {
855
+ headers: {
856
+ [name: string]: unknown;
857
+ };
858
+ content: {
859
+ "application/json": {
860
+ error: {
861
+ code: components["schemas"]["ErrorCode"];
862
+ message: string;
863
+ details?: unknown;
864
+ };
865
+ };
866
+ };
867
+ };
868
+ /** @description Invite token is invalid or expired */
869
+ 401: {
870
+ headers: {
871
+ [name: string]: unknown;
872
+ };
873
+ content: {
874
+ "application/json": {
875
+ error: {
876
+ code: components["schemas"]["ErrorCode"];
877
+ message: string;
878
+ details?: unknown;
879
+ };
880
+ };
881
+ };
882
+ };
883
+ /** @description Invited user no longer exists */
884
+ 404: {
885
+ headers: {
886
+ [name: string]: unknown;
887
+ };
888
+ content: {
889
+ "application/json": {
890
+ error: {
891
+ code: components["schemas"]["ErrorCode"];
892
+ message: string;
893
+ details?: unknown;
894
+ };
895
+ };
896
+ };
897
+ };
898
+ /** @description Invite already accepted, or username already taken */
899
+ 409: {
900
+ headers: {
901
+ [name: string]: unknown;
902
+ };
903
+ content: {
904
+ "application/json": {
905
+ error: {
906
+ code: components["schemas"]["ErrorCode"];
907
+ message: string;
908
+ details?: unknown;
909
+ };
910
+ };
911
+ };
912
+ };
913
+ /** @description Internal server error */
914
+ 500: {
915
+ headers: {
916
+ [name: string]: unknown;
917
+ };
918
+ content: {
919
+ "application/json": {
920
+ error: {
921
+ /** @enum {string} */
922
+ code: "INTERNAL_ERROR";
923
+ /** @enum {string} */
924
+ message: "Internal server error";
925
+ };
926
+ };
927
+ };
928
+ };
929
+ };
930
+ };
931
+ delete?: never;
932
+ options?: never;
933
+ head?: never;
934
+ patch?: never;
935
+ trace?: never;
936
+ };
732
937
  "/me": {
733
938
  parameters: {
734
939
  query?: never;
@@ -13172,6 +13377,91 @@ interface paths {
13172
13377
  patch?: never;
13173
13378
  trace?: never;
13174
13379
  };
13380
+ "/admin/plugins/readiness": {
13381
+ parameters: {
13382
+ query?: never;
13383
+ header?: never;
13384
+ path?: never;
13385
+ cookie?: never;
13386
+ };
13387
+ /** List active plugins missing required readiness config fields */
13388
+ get: {
13389
+ parameters: {
13390
+ query?: never;
13391
+ header?: never;
13392
+ path?: never;
13393
+ cookie?: never;
13394
+ };
13395
+ requestBody?: never;
13396
+ responses: {
13397
+ /** @description Readiness issues for active plugins (empty when everything is configured) */
13398
+ 200: {
13399
+ headers: {
13400
+ [name: string]: unknown;
13401
+ };
13402
+ content: {
13403
+ "application/json": {
13404
+ issues: {
13405
+ name: string;
13406
+ adminPlacement: {
13407
+ /** @enum {string} */
13408
+ section: "settings" | "shared" | "storage" | "mail" | "notification" | "auth" | "search" | "renderer" | "platform";
13409
+ label: string;
13410
+ icon?: string;
13411
+ };
13412
+ fields: {
13413
+ name: string;
13414
+ /** @enum {boolean} */
13415
+ configured: false;
13416
+ }[];
13417
+ }[];
13418
+ };
13419
+ };
13420
+ };
13421
+ /** @description Authentication required */
13422
+ 401: {
13423
+ headers: {
13424
+ [name: string]: unknown;
13425
+ };
13426
+ content: {
13427
+ "application/json": {
13428
+ error: {
13429
+ /** @enum {string} */
13430
+ code: "AUTHENTICATION_REQUIRED";
13431
+ /** @enum {string} */
13432
+ message: "Authentication is required";
13433
+ redirectTo?: string;
13434
+ };
13435
+ };
13436
+ };
13437
+ };
13438
+ /** @description Admin permission required */
13439
+ 403: {
13440
+ headers: {
13441
+ [name: string]: unknown;
13442
+ };
13443
+ content: {
13444
+ "application/json": {
13445
+ error: {
13446
+ /** @enum {string} */
13447
+ code: "ADMIN_REQUIRED";
13448
+ /** @enum {string} */
13449
+ message: "Admin permission required";
13450
+ redirectTo?: string;
13451
+ };
13452
+ };
13453
+ };
13454
+ };
13455
+ };
13456
+ };
13457
+ put?: never;
13458
+ post?: never;
13459
+ delete?: never;
13460
+ options?: never;
13461
+ head?: never;
13462
+ patch?: never;
13463
+ trace?: never;
13464
+ };
13175
13465
  "/admin/plugins/render-cache/clear-all": {
13176
13466
  parameters: {
13177
13467
  query?: never;