Last active
June 13, 2022 03:56
-
-
Save Lurkars/a469dfbad5bad1e2dc7c97658d11f3e8 to your computer and use it in GitHub Desktop.
OpenAPI 3 specification of the Work Adventure (https://github.com/thecodingmachine/workadventure) Admin API as defined in available source code.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| openapi: 3.0.0 | |
| info: | |
| title: Work Adventure Admin API | |
| version: 0.0.1-SNAPSHOT | |
| paths: | |
| /api/ban: | |
| get: | |
| summary: verifyBanUser | |
| operationId: verifyBanUserUsingGET | |
| security: | |
| - ADMIN_API_TOKEN: [] | |
| parameters: | |
| - name: ipAddress | |
| in: query | |
| description: ipAddress | |
| required: true | |
| style: form | |
| schema: | |
| type: string | |
| - name: token | |
| in: query | |
| description: token | |
| required: true | |
| style: form | |
| schema: | |
| type: string | |
| - name: roomUrl | |
| in: query | |
| description: roomUrl | |
| required: true | |
| style: form | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AdminBannedData' | |
| /api/map: | |
| get: | |
| summary: fetchMapDetails | |
| operationId: fetchMapDetailsUsingGET | |
| security: | |
| - ADMIN_API_TOKEN: [] | |
| parameters: | |
| - name: playUri | |
| in: query | |
| description: playUri | |
| required: true | |
| style: form | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/MapDetailsData' | |
| /api/report: | |
| post: | |
| summary: report | |
| operationId: reportUsingPOST | |
| security: | |
| - ADMIN_API_TOKEN: [] | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| properties: | |
| reportWorldSlug: | |
| type: string | |
| reportedUserComment: | |
| type: string | |
| reportedUserUuid: | |
| type: string | |
| reporterUserUuid: | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| /api/room/access: | |
| get: | |
| summary: fetchMemberDataByUuid | |
| operationId: fetchMemberDataByUuidUsingGET | |
| security: | |
| - ADMIN_API_TOKEN: [] | |
| parameters: | |
| - name: uuid | |
| in: query | |
| description: uuid | |
| required: true | |
| style: form | |
| schema: | |
| type: string | |
| - name: roomId | |
| in: query | |
| description: roomId | |
| required: true | |
| style: form | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/FetchMemberDataByUuidResponse' | |
| /api/room/check-user/{organizationMemberToken}: | |
| get: | |
| summary: fetchCheckUserByToken | |
| operationId: fetchCheckUserByTokenUsingGET | |
| security: | |
| - ADMIN_API_TOKEN: [] | |
| parameters: | |
| - name: organizationMemberToken | |
| in: path | |
| description: organizationMemberToken | |
| required: true | |
| style: simple | |
| schema: | |
| type: string | |
| - name: roomId | |
| in: query | |
| description: roomId | |
| required: true | |
| style: form | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AdminApiData' | |
| /api/room/login-url/{organizationMemberToken}: | |
| get: | |
| summary: fetchMemberDataByToken | |
| operationId: fetchMemberDataByTokenUsingGET | |
| security: | |
| - ADMIN_API_TOKEN: [] | |
| parameters: | |
| - name: organizationMemberToken | |
| in: path | |
| description: organizationMemberToken | |
| required: true | |
| style: simple | |
| schema: | |
| type: string | |
| - name: roomId | |
| in: query | |
| description: roomId | |
| required: true | |
| style: form | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AdminApiData' | |
| /api/room/sameWorld: | |
| get: | |
| summary: getUrlRoomsFromSameWorld | |
| operationId: getUrlRoomsFromSameWorldUsingGET | |
| security: | |
| - ADMIN_API_TOKEN: [] | |
| parameters: | |
| - name: roomUrl | |
| in: query | |
| description: roomUrl | |
| required: true | |
| style: form | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| components: | |
| securitySchemes: | |
| ADMIN_API_TOKEN: | |
| type: apiKey | |
| in: header | |
| name: Authorization | |
| schemas: | |
| AdminApiData: | |
| title: AdminApiData | |
| type: object | |
| properties: | |
| email: | |
| type: string | |
| mapUrlStart: | |
| type: string | |
| messages: | |
| type: array | |
| items: | |
| type: object | |
| policy_type: | |
| type: integer | |
| enum: | |
| - 1 (ANONYMOUS_POLICY) | |
| - 2 (MEMBERS_ONLY_POLICY) | |
| - 3 (USE_TAGS_POLICY) | |
| roomUrl: | |
| type: string | |
| tags: | |
| type: array | |
| items: | |
| type: string | |
| textures: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/CharacterTexture' | |
| userUuid: | |
| type: string | |
| AdminBannedData: | |
| title: AdminBannedData | |
| type: object | |
| properties: | |
| is_banned: | |
| type: boolean | |
| message: | |
| type: string | |
| CharacterTexture: | |
| title: CharacterTexture | |
| type: object | |
| properties: | |
| id: | |
| type: integer | |
| format: int32 | |
| level: | |
| type: integer | |
| format: int32 | |
| rights: | |
| type: string | |
| url: | |
| type: string | |
| MapDetailsData: | |
| title: MapDetailsData | |
| type: object | |
| properties: | |
| roomSlug: | |
| type: string | |
| mapUrl: | |
| type: string | |
| policy_type: | |
| type: integer | |
| enum: | |
| - 1 (ANONYMOUS_POLICY) | |
| - 2 (MEMBERS_ONLY_POLICY) | |
| - 3 (USE_TAGS_POLICY) | |
| tags: | |
| type: array | |
| items: | |
| type: string | |
| textures: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/CharacterTexture' | |
| contactPage: | |
| type: string | |
| authenticationMandatory: | |
| type: boolean | |
| FetchMemberDataByUuidResponse: | |
| title: FetchMemberDataByUuidResponse | |
| type: object | |
| properties: | |
| anonymous: | |
| type: boolean | |
| messages: | |
| type: array | |
| items: | |
| type: object | |
| tags: | |
| type: array | |
| items: | |
| type: string | |
| textures: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/CharacterTexture' | |
| userUuid: | |
| type: string | |
| visitCardUrl: | |
| type: string |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment