Skip to content

Commit be196ec

Browse files
vitormattosvitormattos
committed
chore: update OpenAPI specs for DocMDP endpoint
Regenerate OpenAPI documentation files to include setDocMdpConfig endpoint: - openapi-administration.json - openapi-full.json - TypeScript type definitions Generated from updated PHPDoc annotations. Signed-off-by: Vitor Mattos <[email protected]>
1 parent 2a1c7c1 commit be196ec

4 files changed

Lines changed: 558 additions & 0 deletions

File tree

‎openapi-administration.json‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2815,6 +2815,189 @@
28152815
}
28162816
}
28172817
},
2818+
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/docmdp/config": {
2819+
"post": {
2820+
"operationId": "admin-set-doc-mdp-config",
2821+
"summary": "Set DocMDP configuration",
2822+
"description": "This endpoint requires admin access",
2823+
"tags": [
2824+
"admin"
2825+
],
2826+
"security": [
2827+
{
2828+
"bearer_auth": []
2829+
},
2830+
{
2831+
"basic_auth": []
2832+
}
2833+
],
2834+
"requestBody": {
2835+
"required": true,
2836+
"content": {
2837+
"application/json": {
2838+
"schema": {
2839+
"type": "object",
2840+
"required": [
2841+
"enabled",
2842+
"defaultLevel"
2843+
],
2844+
"properties": {
2845+
"enabled": {
2846+
"type": "boolean",
2847+
"description": "Enable or disable DocMDP certification"
2848+
},
2849+
"defaultLevel": {
2850+
"type": "integer",
2851+
"format": "int64",
2852+
"description": "Default DocMDP level (0-3): 0=none, 1=no changes, 2=form fill, 3=form fill + annotations"
2853+
}
2854+
}
2855+
}
2856+
}
2857+
}
2858+
},
2859+
"parameters": [
2860+
{
2861+
"name": "apiVersion",
2862+
"in": "path",
2863+
"required": true,
2864+
"schema": {
2865+
"type": "string",
2866+
"enum": [
2867+
"v1"
2868+
],
2869+
"default": "v1"
2870+
}
2871+
},
2872+
{
2873+
"name": "OCS-APIRequest",
2874+
"in": "header",
2875+
"description": "Required to be true for the API request to pass",
2876+
"required": true,
2877+
"schema": {
2878+
"type": "boolean",
2879+
"default": true
2880+
}
2881+
}
2882+
],
2883+
"responses": {
2884+
"200": {
2885+
"description": "Configuration saved successfully",
2886+
"content": {
2887+
"application/json": {
2888+
"schema": {
2889+
"type": "object",
2890+
"required": [
2891+
"ocs"
2892+
],
2893+
"properties": {
2894+
"ocs": {
2895+
"type": "object",
2896+
"required": [
2897+
"meta",
2898+
"data"
2899+
],
2900+
"properties": {
2901+
"meta": {
2902+
"$ref": "#/components/schemas/OCSMeta"
2903+
},
2904+
"data": {
2905+
"type": "object",
2906+
"required": [
2907+
"message"
2908+
],
2909+
"properties": {
2910+
"message": {
2911+
"type": "string"
2912+
}
2913+
}
2914+
}
2915+
}
2916+
}
2917+
}
2918+
}
2919+
}
2920+
}
2921+
},
2922+
"400": {
2923+
"description": "Invalid DocMDP level provided",
2924+
"content": {
2925+
"application/json": {
2926+
"schema": {
2927+
"type": "object",
2928+
"required": [
2929+
"ocs"
2930+
],
2931+
"properties": {
2932+
"ocs": {
2933+
"type": "object",
2934+
"required": [
2935+
"meta",
2936+
"data"
2937+
],
2938+
"properties": {
2939+
"meta": {
2940+
"$ref": "#/components/schemas/OCSMeta"
2941+
},
2942+
"data": {
2943+
"type": "object",
2944+
"required": [
2945+
"error"
2946+
],
2947+
"properties": {
2948+
"error": {
2949+
"type": "string"
2950+
}
2951+
}
2952+
}
2953+
}
2954+
}
2955+
}
2956+
}
2957+
}
2958+
}
2959+
},
2960+
"500": {
2961+
"description": "Internal server error",
2962+
"content": {
2963+
"application/json": {
2964+
"schema": {
2965+
"type": "object",
2966+
"required": [
2967+
"ocs"
2968+
],
2969+
"properties": {
2970+
"ocs": {
2971+
"type": "object",
2972+
"required": [
2973+
"meta",
2974+
"data"
2975+
],
2976+
"properties": {
2977+
"meta": {
2978+
"$ref": "#/components/schemas/OCSMeta"
2979+
},
2980+
"data": {
2981+
"type": "object",
2982+
"required": [
2983+
"error"
2984+
],
2985+
"properties": {
2986+
"error": {
2987+
"type": "string"
2988+
}
2989+
}
2990+
}
2991+
}
2992+
}
2993+
}
2994+
}
2995+
}
2996+
}
2997+
}
2998+
}
2999+
}
3000+
},
28183001
"/ocs/v2.php/apps/libresign/api/{apiVersion}/crl/list": {
28193002
"get": {
28203003
"operationId": "crl_api-list",

‎openapi-full.json‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11292,6 +11292,189 @@
1129211292
}
1129311293
}
1129411294
},
11295+
"/ocs/v2.php/apps/libresign/api/{apiVersion}/admin/docmdp/config": {
11296+
"post": {
11297+
"operationId": "admin-set-doc-mdp-config",
11298+
"summary": "Set DocMDP configuration",
11299+
"description": "This endpoint requires admin access",
11300+
"tags": [
11301+
"admin"
11302+
],
11303+
"security": [
11304+
{
11305+
"bearer_auth": []
11306+
},
11307+
{
11308+
"basic_auth": []
11309+
}
11310+
],
11311+
"requestBody": {
11312+
"required": true,
11313+
"content": {
11314+
"application/json": {
11315+
"schema": {
11316+
"type": "object",
11317+
"required": [
11318+
"enabled",
11319+
"defaultLevel"
11320+
],
11321+
"properties": {
11322+
"enabled": {
11323+
"type": "boolean",
11324+
"description": "Enable or disable DocMDP certification"
11325+
},
11326+
"defaultLevel": {
11327+
"type": "integer",
11328+
"format": "int64",
11329+
"description": "Default DocMDP level (0-3): 0=none, 1=no changes, 2=form fill, 3=form fill + annotations"
11330+
}
11331+
}
11332+
}
11333+
}
11334+
}
11335+
},
11336+
"parameters": [
11337+
{
11338+
"name": "apiVersion",
11339+
"in": "path",
11340+
"required": true,
11341+
"schema": {
11342+
"type": "string",
11343+
"enum": [
11344+
"v1"
11345+
],
11346+
"default": "v1"
11347+
}
11348+
},
11349+
{
11350+
"name": "OCS-APIRequest",
11351+
"in": "header",
11352+
"description": "Required to be true for the API request to pass",
11353+
"required": true,
11354+
"schema": {
11355+
"type": "boolean",
11356+
"default": true
11357+
}
11358+
}
11359+
],
11360+
"responses": {
11361+
"200": {
11362+
"description": "Configuration saved successfully",
11363+
"content": {
11364+
"application/json": {
11365+
"schema": {
11366+
"type": "object",
11367+
"required": [
11368+
"ocs"
11369+
],
11370+
"properties": {
11371+
"ocs": {
11372+
"type": "object",
11373+
"required": [
11374+
"meta",
11375+
"data"
11376+
],
11377+
"properties": {
11378+
"meta": {
11379+
"$ref": "#/components/schemas/OCSMeta"
11380+
},
11381+
"data": {
11382+
"type": "object",
11383+
"required": [
11384+
"message"
11385+
],
11386+
"properties": {
11387+
"message": {
11388+
"type": "string"
11389+
}
11390+
}
11391+
}
11392+
}
11393+
}
11394+
}
11395+
}
11396+
}
11397+
}
11398+
},
11399+
"400": {
11400+
"description": "Invalid DocMDP level provided",
11401+
"content": {
11402+
"application/json": {
11403+
"schema": {
11404+
"type": "object",
11405+
"required": [
11406+
"ocs"
11407+
],
11408+
"properties": {
11409+
"ocs": {
11410+
"type": "object",
11411+
"required": [
11412+
"meta",
11413+
"data"
11414+
],
11415+
"properties": {
11416+
"meta": {
11417+
"$ref": "#/components/schemas/OCSMeta"
11418+
},
11419+
"data": {
11420+
"type": "object",
11421+
"required": [
11422+
"error"
11423+
],
11424+
"properties": {
11425+
"error": {
11426+
"type": "string"
11427+
}
11428+
}
11429+
}
11430+
}
11431+
}
11432+
}
11433+
}
11434+
}
11435+
}
11436+
},
11437+
"500": {
11438+
"description": "Internal server error",
11439+
"content": {
11440+
"application/json": {
11441+
"schema": {
11442+
"type": "object",
11443+
"required": [
11444+
"ocs"
11445+
],
11446+
"properties": {
11447+
"ocs": {
11448+
"type": "object",
11449+
"required": [
11450+
"meta",
11451+
"data"
11452+
],
11453+
"properties": {
11454+
"meta": {
11455+
"$ref": "#/components/schemas/OCSMeta"
11456+
},
11457+
"data": {
11458+
"type": "object",
11459+
"required": [
11460+
"error"
11461+
],
11462+
"properties": {
11463+
"error": {
11464+
"type": "string"
11465+
}
11466+
}
11467+
}
11468+
}
11469+
}
11470+
}
11471+
}
11472+
}
11473+
}
11474+
}
11475+
}
11476+
}
11477+
},
1129511478
"/ocs/v2.php/apps/libresign/api/{apiVersion}/crl/list": {
1129611479
"get": {
1129711480
"operationId": "crl_api-list",

0 commit comments

Comments
 (0)