Attachment 69545 Details for Bug 19410 – Bug 19410: (followup) Add reserved params definitions

[patch] Bug 19410: (followup) Add reserved params definitions

Bug-19410-followup-Add-reserved-params-definitions.patch (text/plain), 1.92 KB, created by Tomás Cohen Arazi (tcohen) on 2017-12-05 18:43:13 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Tomás Cohen Arazi (tcohen)

Created: 2017-12-05 18:43:13 UTC

Size: 1.92 KB

patch

obsolete

>From 8c4fb19cde7a3391fa011a7131d406fa931868c6 Mon Sep 17 00:00:00 2001
>From: Tomas Cohen Arazi <tomascohen@theke.io>
>Date: Tue, 5 Dec 2017 15:40:56 -0300
>Subject: [PATCH] Bug 19410: (followup) Add reserved params definitions
>
>This patch re-adds some parameters I left out during some rebasing tasks
>and ended up on a separate patchset (bug 18731).
>
>The introduced parameters definitions are only used on endpoint definitions
>that implement (at least) pagination. No need to test them here but easier
>adding them here than on a patch implementing a new enpoint, which would become
>a dependency for other endpoints.
>
>Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
>---
> api/v1/swagger/parameters.json | 40 +++++++++++++++++++++++++++++++++++++++-
> 1 file changed, 39 insertions(+), 1 deletion(-)
>
>diff --git a/api/v1/swagger/parameters.json b/api/v1/swagger/parameters.json
>index b8835d22d1..1da158c3f4 100644
>--- a/api/v1/swagger/parameters.json
>+++ b/api/v1/swagger/parameters.json
>@@ -13,5 +13,43 @@
>   },
>   "vendoridPathParam": {
>     "$ref": "parameters/vendor.json#/vendoridPathParam"
>-  }
>+  },
>+  "match": {
>+    "name": "_match",
>+    "in": "query",
>+    "required": false,
>+    "description": "Matching criteria",
>+    "type": "string",
>+    "enum": [
>+        "contains",
>+        "exact",
>+        "starts_with",
>+        "ends_with"
>+    ]
>+  },
>+  "order_by": {
>+    "name": "_order_by",
>+    "in": "query",
>+    "required": false,
>+    "description": "Sorting criteria",
>+    "type": "array",
>+    "collectionFormat": "pipes",
>+    "items": {
>+        "type": "string"
>+    }
>+  },
>+  "page": {
>+    "name": "_page",
>+    "in": "query",
>+    "required": false,
>+    "description": "Page number, for paginated object listing",
>+    "type": "integer"
>+  },
>+  "per_page": {
>+    "name": "_per_page",
>+    "in": "query",
>+    "required": false,
>+    "description": "Page size, for paginated object listing",
>+    "type": "integer"
>+   }
> }
>-- 
>2.14.1

Actions: View | Diff | Splinter Review

Attachments on bug 19410: 67613 | 67731 | 67732 | 67750 | 67751 | 67795 | 67798 | 69248 | 69253 | 69254 | 69255 | 69256 | 69257 | 69258 | 69259 | 69260 | 69261 | 69262 | 69282 | 69283 | 69284 | 69286 | 69287 | 69385 | 69386 | 69387 | 69388 | 69389 | 69397 | 69398 | 69399 | 69400 | 69401 | 69545 | 69703