mirror of
https://github.com/simple-login/app.git
synced 2024-10-01 06:01:29 +02:00
Merge pull request #927 from simple-login/return-disable-alias
add new parameter disabled in /GET /api/v2/aliases
This commit is contained in:
commit
f5a5a06e19
@ -79,6 +79,7 @@ def get_aliases_v2():
|
|||||||
Input:
|
Input:
|
||||||
page_id: in query
|
page_id: in query
|
||||||
pinned: in query
|
pinned: in query
|
||||||
|
disabled: in query
|
||||||
Output:
|
Output:
|
||||||
- aliases: list of alias:
|
- aliases: list of alias:
|
||||||
- id
|
- id
|
||||||
@ -110,6 +111,14 @@ def get_aliases_v2():
|
|||||||
return jsonify(error="page_id must be provided in request query"), 400
|
return jsonify(error="page_id must be provided in request query"), 400
|
||||||
|
|
||||||
pinned = "pinned" in request.args
|
pinned = "pinned" in request.args
|
||||||
|
disabled = "disabled" in request.args
|
||||||
|
|
||||||
|
if pinned:
|
||||||
|
alias_filter = "pinned"
|
||||||
|
elif disabled:
|
||||||
|
alias_filter = "disabled"
|
||||||
|
else:
|
||||||
|
alias_filter = None
|
||||||
|
|
||||||
query = None
|
query = None
|
||||||
data = request.get_json(silent=True)
|
data = request.get_json(silent=True)
|
||||||
@ -117,7 +126,7 @@ def get_aliases_v2():
|
|||||||
query = data.get("query")
|
query = data.get("query")
|
||||||
|
|
||||||
alias_infos: [AliasInfo] = get_alias_infos_with_pagination_v3(
|
alias_infos: [AliasInfo] = get_alias_infos_with_pagination_v3(
|
||||||
user, page_id=page_id, query=query, alias_filter="pinned" if pinned else None
|
user, page_id=page_id, query=query, alias_filter=alias_filter
|
||||||
)
|
)
|
||||||
|
|
||||||
return (
|
return (
|
||||||
|
@ -312,6 +312,8 @@ Input:
|
|||||||
- `page_id` in query. Used for the pagination. The endpoint returns maximum 20 aliases for each page. `page_id` starts
|
- `page_id` in query. Used for the pagination. The endpoint returns maximum 20 aliases for each page. `page_id` starts
|
||||||
at 0.
|
at 0.
|
||||||
- (Optional) `pinned` in query. If set, only pinned aliases are returned.
|
- (Optional) `pinned` in query. If set, only pinned aliases are returned.
|
||||||
|
- (Optional) `disabled` in query. If set, only disabled aliases are returned.
|
||||||
|
Please note `pinned` and `disabled` can't be both present.
|
||||||
- (Optional) query: included in request body. Some frameworks might prevent GET request having a non-empty body, in this
|
- (Optional) query: included in request body. Some frameworks might prevent GET request having a non-empty body, in this
|
||||||
case this endpoint also supports POST.
|
case this endpoint also supports POST.
|
||||||
|
|
||||||
|
@ -195,6 +195,25 @@ def test_get_pinned_aliases_v2(flask_client):
|
|||||||
assert r.json["aliases"][0]["id"] == a0.id
|
assert r.json["aliases"][0]["id"] == a0.id
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_disabled_aliases_v2(flask_client):
|
||||||
|
user = login(flask_client)
|
||||||
|
|
||||||
|
a0 = Alias.create_new(user, "prefix0")
|
||||||
|
a0.enabled = False
|
||||||
|
Session.commit()
|
||||||
|
|
||||||
|
r = flask_client.get("/api/v2/aliases?page_id=0")
|
||||||
|
assert r.status_code == 200
|
||||||
|
# the default alias (created when user is created) and a0 are returned
|
||||||
|
assert len(r.json["aliases"]) == 2
|
||||||
|
|
||||||
|
r = flask_client.get("/api/v2/aliases?page_id=0&disabled=true")
|
||||||
|
assert r.status_code == 200
|
||||||
|
# only a0 is returned
|
||||||
|
assert len(r.json["aliases"]) == 1
|
||||||
|
assert r.json["aliases"][0]["id"] == a0.id
|
||||||
|
|
||||||
|
|
||||||
def test_delete_alias(flask_client):
|
def test_delete_alias(flask_client):
|
||||||
user = login(flask_client)
|
user = login(flask_client)
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user