Skip to content

Commit

Permalink
Merge pull request #137 from bonbuo/SHARE-124
Browse files Browse the repository at this point in the history
SHARE-124 implemented new GET request to retrieve all users
  • Loading branch information
dmetzner authored Dec 15, 2023
2 parents be88fd9 + 004931b commit 4cce22c
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion catroweb.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.3
info:
title: "Catroweb API"
description: "API for the Catrobat Share Platform"
version: "v1.1.20"
version: "v1.2.0"
termsOfService: "https://share.catrob.at/pocketcode/termsOfUse"
contact:
name: "Catrobat"
Expand Down Expand Up @@ -494,6 +494,37 @@ paths:
$ref: '#/components/responses/BadRequest'
'406':
$ref: '#/components/responses/NotAcceptable'

/users:
get:
tags:
- "User"
summary: "Get users"
description: "Get all users with their corresponding data"
parameters:
- name: query
in: query
required: true
schema:
type: string
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
responses:
'200':
description: "OK"
content:
application/json:
schema:
$ref: '#/components/schemas/UsersDataResponse'
headers:
X-Response-Hash:
$ref: '#/components/headers/X-Response-Hash'
Content-Language:
$ref: '#/components/headers/Content-Language'
'400':
$ref: '#/components/responses/BadRequest'
'406':
$ref: '#/components/responses/NotAcceptable'

################################################
# Projects
Expand Down Expand Up @@ -1781,6 +1812,10 @@ components:
type: integer
example: 42
description: "Amount of users followed by this user"
ranking_score:
type: integer
example: 151
description: "Ranking score of this user"

ExtendedUserDataResponse:
allOf:
Expand Down

0 comments on commit 4cce22c

Please sign in to comment.