|
380 | 380 | }
|
381 | 381 | }
|
382 | 382 | },
|
| 383 | + "/1/compositions": { |
| 384 | + "get": { |
| 385 | + "tags": [ |
| 386 | + "Compositions" |
| 387 | + ], |
| 388 | + "operationId": "listCompositions", |
| 389 | + "x-acl": [ |
| 390 | + "editSettings", |
| 391 | + "settings" |
| 392 | + ], |
| 393 | + "summary": "List compositions", |
| 394 | + "description": "Lists all compositions in the current Algolia application.\n", |
| 395 | + "parameters": [ |
| 396 | + { |
| 397 | + "$ref": "#/components/parameters/Page" |
| 398 | + }, |
| 399 | + { |
| 400 | + "$ref": "#/components/parameters/HitsPerPage" |
| 401 | + } |
| 402 | + ], |
| 403 | + "responses": { |
| 404 | + "200": { |
| 405 | + "description": "OK", |
| 406 | + "content": { |
| 407 | + "application/json": { |
| 408 | + "schema": { |
| 409 | + "$ref": "#/components/schemas/listCompositionsResponse" |
| 410 | + } |
| 411 | + } |
| 412 | + } |
| 413 | + }, |
| 414 | + "400": { |
| 415 | + "$ref": "#/components/responses/BadRequest" |
| 416 | + }, |
| 417 | + "402": { |
| 418 | + "$ref": "#/components/responses/FeatureNotEnabled" |
| 419 | + }, |
| 420 | + "403": { |
| 421 | + "$ref": "#/components/responses/MethodNotAllowed" |
| 422 | + }, |
| 423 | + "404": { |
| 424 | + "$ref": "#/components/responses/CompositionNotFound" |
| 425 | + } |
| 426 | + } |
| 427 | + } |
| 428 | + }, |
383 | 429 | "/1/compositions/{compositionID}": {
|
384 | 430 | "get": {
|
385 | 431 | "tags": [
|
|
1046 | 1092 | }
|
1047 | 1093 | }
|
1048 | 1094 | },
|
1049 |
| - "/1/compositions": { |
1050 |
| - "get": { |
1051 |
| - "tags": [ |
1052 |
| - "Compositions" |
1053 |
| - ], |
1054 |
| - "operationId": "listCompositions", |
1055 |
| - "x-acl": [ |
1056 |
| - "editSettings", |
1057 |
| - "settings" |
1058 |
| - ], |
1059 |
| - "summary": "List compositions", |
1060 |
| - "description": "Lists all compositions in the current Algolia application.\n", |
1061 |
| - "parameters": [ |
1062 |
| - { |
1063 |
| - "$ref": "#/components/parameters/Page" |
1064 |
| - }, |
1065 |
| - { |
1066 |
| - "$ref": "#/components/parameters/HitsPerPage" |
1067 |
| - } |
1068 |
| - ], |
1069 |
| - "responses": { |
1070 |
| - "200": { |
1071 |
| - "description": "OK", |
1072 |
| - "content": { |
1073 |
| - "application/json": { |
1074 |
| - "schema": { |
1075 |
| - "$ref": "#/components/schemas/listCompositionsResponse" |
1076 |
| - } |
1077 |
| - } |
1078 |
| - } |
1079 |
| - }, |
1080 |
| - "400": { |
1081 |
| - "$ref": "#/components/responses/BadRequest" |
1082 |
| - }, |
1083 |
| - "402": { |
1084 |
| - "$ref": "#/components/responses/FeatureNotEnabled" |
1085 |
| - }, |
1086 |
| - "403": { |
1087 |
| - "$ref": "#/components/responses/MethodNotAllowed" |
1088 |
| - }, |
1089 |
| - "404": { |
1090 |
| - "$ref": "#/components/responses/CompositionNotFound" |
1091 |
| - } |
1092 |
| - } |
1093 |
| - } |
1094 |
| - }, |
1095 | 1095 | "/setClientApiKey": {
|
1096 | 1096 | "get": {
|
1097 | 1097 | "x-helper": true,
|
|
1212 | 1212 | "$ref": "#/components/schemas/compositionObjectID"
|
1213 | 1213 | }
|
1214 | 1214 | },
|
1215 |
| - "ObjectIDRule": { |
1216 |
| - "in": "path", |
1217 |
| - "name": "objectID", |
1218 |
| - "description": "Unique identifier of a rule object.", |
1219 |
| - "required": true, |
1220 |
| - "schema": { |
1221 |
| - "$ref": "#/components/schemas/ruleID" |
1222 |
| - } |
1223 |
| - }, |
1224 | 1215 | "Page": {
|
1225 | 1216 | "in": "query",
|
1226 | 1217 | "name": "page",
|
|
1248 | 1239 | "type": "integer",
|
1249 | 1240 | "default": 100
|
1250 | 1241 | }
|
| 1242 | + }, |
| 1243 | + "ObjectIDRule": { |
| 1244 | + "in": "path", |
| 1245 | + "name": "objectID", |
| 1246 | + "description": "Unique identifier of a rule object.", |
| 1247 | + "required": true, |
| 1248 | + "schema": { |
| 1249 | + "$ref": "#/components/schemas/ruleID" |
| 1250 | + } |
1251 | 1251 | }
|
1252 | 1252 | },
|
1253 | 1253 | "schemas": {
|
|
3841 | 3841 | "name"
|
3842 | 3842 | ]
|
3843 | 3843 | },
|
| 3844 | + "listCompositionsResponse": { |
| 3845 | + "type": "object", |
| 3846 | + "additionalProperties": false, |
| 3847 | + "properties": { |
| 3848 | + "items": { |
| 3849 | + "type": "array", |
| 3850 | + "description": "All compositions in your Algolia application.", |
| 3851 | + "items": { |
| 3852 | + "$ref": "#/components/schemas/composition" |
| 3853 | + } |
| 3854 | + }, |
| 3855 | + "nbPages": { |
| 3856 | + "type": "integer", |
| 3857 | + "description": "Number of pages.", |
| 3858 | + "example": 100 |
| 3859 | + }, |
| 3860 | + "page": { |
| 3861 | + "type": "integer", |
| 3862 | + "description": "Current page.", |
| 3863 | + "example": 0 |
| 3864 | + }, |
| 3865 | + "hitsPerPage": { |
| 3866 | + "type": "integer", |
| 3867 | + "description": "Number of items per page.", |
| 3868 | + "example": 20 |
| 3869 | + }, |
| 3870 | + "nbHits": { |
| 3871 | + "type": "integer", |
| 3872 | + "description": "Number of items.", |
| 3873 | + "example": 200 |
| 3874 | + } |
| 3875 | + }, |
| 3876 | + "required": [ |
| 3877 | + "hitsPerPage", |
| 3878 | + "items", |
| 3879 | + "nbHits", |
| 3880 | + "nbPages", |
| 3881 | + "page" |
| 3882 | + ] |
| 3883 | + }, |
3844 | 3884 | "taskID": {
|
3845 | 3885 | "type": "integer",
|
3846 | 3886 | "format": "int64",
|
|
4056 | 4096 | "required": [
|
4057 | 4097 | "status"
|
4058 | 4098 | ]
|
4059 |
| - }, |
4060 |
| - "listCompositionsResponse": { |
4061 |
| - "type": "object", |
4062 |
| - "additionalProperties": false, |
4063 |
| - "properties": { |
4064 |
| - "items": { |
4065 |
| - "type": "array", |
4066 |
| - "description": "All compositions in your Algolia application.", |
4067 |
| - "items": { |
4068 |
| - "$ref": "#/components/schemas/composition" |
4069 |
| - } |
4070 |
| - }, |
4071 |
| - "nbPages": { |
4072 |
| - "type": "integer", |
4073 |
| - "description": "Number of pages.", |
4074 |
| - "example": 100 |
4075 |
| - }, |
4076 |
| - "page": { |
4077 |
| - "type": "integer", |
4078 |
| - "description": "Current page.", |
4079 |
| - "example": 0 |
4080 |
| - }, |
4081 |
| - "hitsPerPage": { |
4082 |
| - "type": "integer", |
4083 |
| - "description": "Number of items per page.", |
4084 |
| - "example": 20 |
4085 |
| - }, |
4086 |
| - "nbHits": { |
4087 |
| - "type": "integer", |
4088 |
| - "description": "Number of items.", |
4089 |
| - "example": 200 |
4090 |
| - } |
4091 |
| - }, |
4092 |
| - "required": [ |
4093 |
| - "hitsPerPage", |
4094 |
| - "items", |
4095 |
| - "nbHits", |
4096 |
| - "nbPages", |
4097 |
| - "page" |
4098 |
| - ] |
4099 | 4099 | }
|
4100 | 4100 | },
|
4101 | 4101 | "responses": {
|
|
0 commit comments