| openapi: 3.0.2 |
| info: |
| title: '' |
| version: '' |
| paths: |
| /api/users/: |
| get: |
| operationId: listUsers |
| description: API endpoint that allows users to be viewed or edited. |
| parameters: [] |
| responses: |
| '200': |
| content: |
| application/json: |
| schema: |
| type: array |
| items: |
| $ref: '#/components/schemas/User' |
| description: '' |
| tags: |
| - api |
| post: |
| operationId: createUser |
| description: API endpoint that allows users to be viewed or edited. |
| parameters: [] |
| requestBody: |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/User' |
| application/x-www-form-urlencoded: |
| schema: |
| $ref: '#/components/schemas/User' |
| multipart/form-data: |
| schema: |
| $ref: '#/components/schemas/User' |
| responses: |
| '201': |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/User' |
| description: '' |
| tags: |
| - api |
| /api/users/{id}/: |
| get: |
| operationId: retrieveUser |
| description: API endpoint that allows users to be viewed or edited. |
| parameters: |
| - name: id |
| in: path |
| required: true |
| description: A unique integer value identifying this user. |
| schema: |
| type: string |
| responses: |
| '200': |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/User' |
| description: '' |
| tags: |
| - api |
| put: |
| operationId: updateUser |
| description: API endpoint that allows users to be viewed or edited. |
| parameters: |
| - name: id |
| in: path |
| required: true |
| description: A unique integer value identifying this user. |
| schema: |
| type: string |
| requestBody: |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/User' |
| application/x-www-form-urlencoded: |
| schema: |
| $ref: '#/components/schemas/User' |
| multipart/form-data: |
| schema: |
| $ref: '#/components/schemas/User' |
| responses: |
| '200': |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/User' |
| description: '' |
| tags: |
| - api |
| patch: |
| operationId: partialUpdateUser |
| description: API endpoint that allows users to be viewed or edited. |
| parameters: |
| - name: id |
| in: path |
| required: true |
| description: A unique integer value identifying this user. |
| schema: |
| type: string |
| requestBody: |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/User' |
| application/x-www-form-urlencoded: |
| schema: |
| $ref: '#/components/schemas/User' |
| multipart/form-data: |
| schema: |
| $ref: '#/components/schemas/User' |
| responses: |
| '200': |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/User' |
| description: '' |
| tags: |
| - api |
| delete: |
| operationId: destroyUser |
| description: API endpoint that allows users to be viewed or edited. |
| parameters: |
| - name: id |
| in: path |
| required: true |
| description: A unique integer value identifying this user. |
| schema: |
| type: string |
| responses: |
| '204': |
| description: '' |
| tags: |
| - api |
| /api/groups/: |
| get: |
| operationId: listGroups |
| description: API endpoint that allows groups to be viewed or edited. |
| parameters: [] |
| responses: |
| '200': |
| content: |
| application/json: |
| schema: |
| type: array |
| items: |
| $ref: '#/components/schemas/Group' |
| description: '' |
| tags: |
| - api |
| post: |
| operationId: createGroup |
| description: API endpoint that allows groups to be viewed or edited. |
| parameters: [] |
| requestBody: |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/Group' |
| application/x-www-form-urlencoded: |
| schema: |
| $ref: '#/components/schemas/Group' |
| multipart/form-data: |
| schema: |
| $ref: '#/components/schemas/Group' |
| responses: |
| '201': |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/Group' |
| description: '' |
| tags: |
| - api |
| /api/groups/{id}/: |
| get: |
| operationId: retrieveGroup |
| description: API endpoint that allows groups to be viewed or edited. |
| parameters: |
| - name: id |
| in: path |
| required: true |
| description: A unique integer value identifying this group. |
| schema: |
| type: string |
| responses: |
| '200': |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/Group' |
| description: '' |
| tags: |
| - api |
| put: |
| operationId: updateGroup |
| description: API endpoint that allows groups to be viewed or edited. |
| parameters: |
| - name: id |
| in: path |
| required: true |
| description: A unique integer value identifying this group. |
| schema: |
| type: string |
| requestBody: |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/Group' |
| application/x-www-form-urlencoded: |
| schema: |
| $ref: '#/components/schemas/Group' |
| multipart/form-data: |
| schema: |
| $ref: '#/components/schemas/Group' |
| responses: |
| '200': |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/Group' |
| description: '' |
| tags: |
| - api |
| patch: |
| operationId: partialUpdateGroup |
| description: API endpoint that allows groups to be viewed or edited. |
| parameters: |
| - name: id |
| in: path |
| required: true |
| description: A unique integer value identifying this group. |
| schema: |
| type: string |
| requestBody: |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/Group' |
| application/x-www-form-urlencoded: |
| schema: |
| $ref: '#/components/schemas/Group' |
| multipart/form-data: |
| schema: |
| $ref: '#/components/schemas/Group' |
| responses: |
| '200': |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/Group' |
| description: '' |
| tags: |
| - api |
| delete: |
| operationId: destroyGroup |
| description: API endpoint that allows groups to be viewed or edited. |
| parameters: |
| - name: id |
| in: path |
| required: true |
| description: A unique integer value identifying this group. |
| schema: |
| type: string |
| responses: |
| '204': |
| description: '' |
| tags: |
| - api |
| /api/scorecard/: |
| get: |
| operationId: listScorecardViewSets |
| description: List all german data, or create a new GermanDataModel. |
| parameters: [] |
| responses: |
| '200': |
| content: |
| application/json: |
| schema: |
| type: array |
| items: {} |
| description: '' |
| tags: |
| - api |
| /api/scorecard/{id}/: |
| get: |
| operationId: retrieveScorecardViewSet |
| description: List all german data, or create a new GermanDataModel. |
| parameters: |
| - name: id |
| in: path |
| required: true |
| description: '' |
| schema: |
| type: string |
| responses: |
| '200': |
| content: |
| application/json: |
| schema: {} |
| description: '' |
| tags: |
| - api |
| /api/scorecard/{id}/predict/: |
| post: |
| operationId: predictScorecardViewSet |
| description: List all german data, or create a new GermanDataModel. |
| parameters: |
| - name: id |
| in: path |
| required: true |
| description: '' |
| schema: |
| type: string |
| requestBody: |
| content: |
| application/json: |
| schema: {} |
| application/x-www-form-urlencoded: |
| schema: {} |
| multipart/form-data: |
| schema: {} |
| responses: |
| '201': |
| content: |
| application/json: |
| schema: {} |
| description: '' |
| tags: |
| - api |
| components: |
| schemas: |
| User: |
| type: object |
| properties: |
| url: |
| type: string |
| readOnly: true |
| username: |
| type: string |
| description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ |
| only. |
| pattern: ^[\w.@+-]+\z |
| maxLength: 150 |
| email: |
| type: string |
| format: email |
| maxLength: 254 |
| groups: |
| type: array |
| items: |
| type: string |
| description: The groups this user belongs to. A user will get all permissions |
| granted to each of their groups. |
| required: |
| - username |
| Group: |
| type: object |
| properties: |
| url: |
| type: string |
| readOnly: true |
| name: |
| type: string |
| maxLength: 150 |
| required: |
| - name |