Actually add them

This commit is contained in:
Sebastian H. Gabrielli 2023-12-23 11:15:58 +01:00
parent 66c880fd62
commit 7947b5234b
13 changed files with 1112 additions and 0 deletions

View File

@ -0,0 +1,858 @@
_id: spc_df2177e61a724e24bc4fc1796d631d51
type: ApiSpec
parentId: wrk_0627d19078e64bb7877a6c1703c0fab8
modified: 1703326273885
created: 1703261567280
fileName: member-spec-sample.yaml
contents: "openapi: 3.0.0
info:
\ description: \"This is a sample/Proof of concept OmegaV v2 server API
specification.\"
\ version: 0.0.1
\ title: OmegaV v2 API demo
\ contact:
\ email: edb@omegav.no
\ license:
\ name: Apache 2.0
\ url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
\ - url: \"api.omegav.no\"
\ description: \"OmegaV API server\"
tags:
\ - name: member
\ description: \"Operations about a member\"
\ - name: money
\ description: \"Operations about money\"
\ - name: RFID
\ description: \"Operations about a member's RFID card\"
paths:
\ /members:
\ get:
\ tags:
\ - member
\ summary: \"Get a list of all members\"
\ description: \"Get a list of all members\"
\ operationId: getMembers
\ responses:
\ '200':
\ description: \"Success\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/members'
\ /member:
\ post:
\ tags:
\ - member
\ summary: \"Add a new member\"
\ description: \"Add a new member\"
\ operationId: addMember
\ requestBody:
\ description: \"Create a new member\"
\ content:
\ application/json:
\ schema:
\ $ref: \"#/components/schemas/minimalMember\"
\ required: true
\ responses:
\ '200':
\ description: \"Success\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/minimalMember'
\ \
\ /member/{memberId}:
\ get:
\ tags:
\ - member
\ summary: \"Get a member\"
\ description: \"Get a single member\"
\ operationId: getMember
\ parameters:
\ - name: memberId
\ in: path
\ description: \"ID of the user's who's balance will be fetched\"
\ required: true
\ schema:
\ type: integer
\ format: uint64
\ responses:
\ '200':
\ description: \"Success\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/members'
\ '404':
\ description: \"Member not found\"
\ \
\ put:
\ tags:
\ - member
\ summary: \"Update a member's details\"
\ description: \"Update a member's details\"
\ operationId: updateMember
\ parameters:
\ - name: memberId
\ in: path
\ description: \"ID of the user's who's balance will be fetched\"
\ required: true
\ schema:
\ type: integer
\ format: uint64
\ requestBody:
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/minimalMember'
\ responses:
\ '200':
\ description: \"Success\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/members'
\ '404':
\ description: \"Member not found\"
\ \
\ \
\ \
\ /member/{memberId}/balance:
\ get:
\ tags:
\ - member
\ - money
\ summary: \"Get a member's balance\"
\ description: \"Get a member's balance\"
\ operationId: getBalance
\ parameters:
\ - name: memberId
\ in: path
\ description: \"ID of the user's who's balance will be fetched\"
\ required: true
\ schema:
\ type: integer
\ format: uint64
\ \
\ responses:
\ '200':
\ description: \"Success\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/balance'
\ '404':
\ description: \"Member not found\"
\ \
\ put:
\ tags:
\ - member
\ - money
\ summary: \"Change a member's balance\"
\ description: \"Add to a member's balance\"
\ operationId: putBalance
\ parameters:
\ - name: memberId
\ in: path
\ description: \"ID of the user's who's balance will be added to\"
\ required: true
\ schema:
\ type: integer
\ format: uint64
\ requestBody:
\ description: \"The values to be added to the member's balance\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/balance'
\ \
\ responses:
\ '200':
\ description: \"Success, returnes the new balance\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/balance'
\ '400':
\ description: \"Malformed request\"
\ '404':
\ description: \"Member not found\"
\ \
\ /member/{memberId}/imagePreference:
\ get:
\ tags:
\ - member
\ summary: \"Get a member's image preference\"
\ description: \"Get a member's image preference\"
\ operationId: getImagePreference
\ parameters:
\ - name: memberId
\ in: path
\ description: \"ID of the user's who's info will be fetched\"
\ required: true
\ schema:
\ type: integer
\ format: uint64
\ \
\ responses:
\ '200':
\ description: \"Success\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/imagePreference'
\ '404':
\ description: \"Member not found\"
\ \
\ put:
\ tags:
\ - member
\ summary: \"Change a member's image preference\"
\ description: \"Add to a member's image preference\"
\ operationId: changeImagePreference
\ parameters:
\ - name: memberId
\ in: path
\ description: \"ID of the user's who's info will be changed\"
\ required: true
\ schema:
\ type: integer
\ format: uint64
\ requestBody:
\ description: \"The image preference to set for the member\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/imagePreference'
\ \
\ responses:
\ '200':
\ description: \"Success, returnes the new image preference\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/imagePreference'
\ '400':
\ description: \"Malformed request\"
\ '404':
\ description: \"Member not found\"
\ \
\ /member/{memberId}/rfid:
\ get:
\ tags:
\ - member
\ - RFID
\ summary: \"Get a member's RFID cards\"
\ description: \"Get all of a member's RFID cards\"
\ operationId: getRfids
\ parameters:
\ - name: memberId
\ in: path
\ description: \"ID of the user's who's info will be fetched\"
\ required: true
\ schema:
\ type: integer
\ format: uint64
\ \
\ responses:
\ '200':
\ description: \"Success\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/rfidCards'
\ '404':
\ description: \"Member not found\"
\ \
\ post:
\ tags:
\ - member
\ - RFID
\ summary: \"Add RFID card\"
\ description: \"Add an RFID card to a member\"
\ operationId: addRfid
\ parameters:
\ - name: memberId
\ in: path
\ description: \"ID of the user's who's info will be added to\"
\ required: true
\ schema:
\ type: integer
\ format: uint64
\ requestBody:
\ description: \"Info about the RFID card to add\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/rfidCard'
\ \
\ responses:
\ '200':
\ description: \"Success, returns the new RFID card info\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/rfidCard'
\ '400':
\ description: \"Malformed request\"
\ '404':
\ description: \"Member not found\"
\ \
components:
\ schemas:
\ members:
\ type: object
\ description: \"An array containing multimple `member` objects\"
\ properties:
\ members:
\ type: array
\ items:
\ $ref: '#/components/schemas/member'
\ \
\ minimalMember:
\ type: object
\ description: \"The minimal values needed to create a member\"
\ properties:
\ id:
\ type: integer
\ description: \"The internal member ID of the user\"
\ format: uint64
\ example: 1337
\ ntnuBrukernavn:
\ type: string
\ description: \"The NTNU username of the member\"
\ example: \"sebasthg\"
\ firstName:
\ type: string
\ description: \"First name of the member\"
\ example: \"Sebastian\"
\ lastName:
\ type: string
\ description: \"Last name of the member\"
\ example: \"Gabrielli\"
\ email:
\ type: string
\ description: \"The member's non-ntnu e-mail\"
\ example: \"sebastian@fastmail.mx\"
\ \
\ member:
\ type: object
\ description: \"A collection of all the values associated with a
member\"
\ properties:
\ id:
\ type: integer
\ description: \"The internal member ID of the user\"
\ format: uint64
\ example: 1337
\ ntnuBrukernavn:
\ type: string
\ description: \"The NTNU username of the member\"
\ example: \"sebasthg\"
\ firstName:
\ type: string
\ description: \"First name of the member\"
\ example: \"Sebastian\"
\ lastName:
\ type: string
\ description: \"Last name of the member\"
\ example: \"Gabrielli\"
\ email:
\ type: string
\ description: \"The member's non-ntnu e-mail\"
\ example: \"sebastian@fastmail.mx\"
\ balance:
\ type: integer
\ description: \"The balance on the member's OBS account\"
\ format: int64
\ example: 1337
\ imagePreference:
\ type: string
\ description: \"The image series shown upon an OBS purchase\"
\ example: \"Sexy stallman\"
\ enum:
\ - \"Sexy stallman\"
\ - \"Propaganda\"
\ - \"Money\"
\ rfidCards:
\ type: array
\ items:
\ $ref: '#/components/schemas/rfidCard' \
\ rfidCards:
\ type: object
\ description: \"An array of rfidCard objects\"
\ properties:
\ rfidCards:
\ type: array
\ items:
\ $ref: '#/components/schemas/rfidCard'
\ rfidCard:
\ type: object
\ description: \"An RFID card\"
\ properties:
\ cardId:
\ type: string
\ example: \"0364249683\"
\ cardDomment:
\ type: string
\ example: \"Studentkort\"
\ \
\ imagePreference:
\ type: object
\ description: \"A member's image preference\"
\ properties:
\ imagePreference:
\ type: string
\ description: \"The image series shown upon an OBS purchase\"
\ example: \"Sexy stallman\"
\ enum:
\ - \"Sexy stallman\"
\ - \"Propaganda\"
\ - \"Money\"
\ \
\ balance:
\ type: object
\ description: \"A member's balance\"
\ properties:
\ balance:
\ type: integer
\ format: int64
\ example: 1337
\ \
\ requestBodies:
\ minimalMember:
\ description: \"Add a member\"
\ content:
\ application/json:
\ schema:
\ $ref: '#/components/schemas/minimalMember'
\ "
contentType: yaml

View File

@ -0,0 +1,11 @@
_id: env_0dde5a3d182f1ee61ac21763e91cf71ac1013f23
type: Environment
parentId: wrk_0627d19078e64bb7877a6c1703c0fab8
modified: 1703261562093
created: 1703261562093
name: Base Environment
data: {}
dataPropertyOrder: null
color: null
isPrivate: false
metaSortKey: 1703261562093

View File

@ -0,0 +1,15 @@
_id: env_dfe66b8a265d48a8873f458493612573
type: Environment
parentId: env_0dde5a3d182f1ee61ac21763e91cf71ac1013f23
modified: 1703325202636
created: 1703325202636
name: OpenAPI env null
data:
scheme:
- http
base_path: api.omegav.no
host: ""
dataPropertyOrder: null
color: null
isPrivate: false
metaSortKey: 1703325202636

View File

@ -0,0 +1,29 @@
_id: req_0dbc0849841c4537a7ba56051747ad9b
type: Request
parentId: fld_1f771e8034294c2a9c6396fd6787b6af
modified: 1703325211504
created: 1703325202646
url: "{{ _.base_url }}/members/{{ _.memberId }}/balance"
name: Change a member's balance
description: ""
method: PUT
body:
mimeType: application/json
text: |-
{
"balance": 1337
}
parameters: []
headers:
- name: Content-Type
disabled: false
value: application/json
authentication: {}
metaSortKey: -1703325202646
isPrivate: false
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global

View File

@ -0,0 +1,29 @@
_id: req_0dd71a5c2af445c98f796348e4115d26
type: Request
parentId: fld_c049b55b905d41e69d7085647cfcecad
modified: 1703325202647
created: 1703325202647
url: "{{ _.base_url }}/members/{{ _.memberId }}/balance"
name: Change a member's balance
description: ""
method: PUT
body:
mimeType: application/json
text: |-
{
"balance": 1337
}
parameters: []
headers:
- name: Content-Type
disabled: false
value: application/json
authentication: {}
metaSortKey: -1703325202647
isPrivate: false
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global

View File

@ -0,0 +1,21 @@
_id: req_38c60dbc1949493fa350f316027aa30e
type: Request
parentId: fld_1f771e8034294c2a9c6396fd6787b6af
modified: 1703325202644
created: 1703325202644
url: "{{ _.base_url }}/members/{{ _.memberId }}/balance"
name: Get a member's balance
description: ""
method: GET
body: {}
parameters: []
headers: []
authentication: {}
metaSortKey: -1703325202644
isPrivate: false
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global

View File

@ -0,0 +1,21 @@
_id: req_6d5655cd78fd4d05a2c06b5bc443c3fa
type: Request
parentId: fld_1f771e8034294c2a9c6396fd6787b6af
modified: 1703325202640
created: 1703325202640
url: "{{ _.base_url }}/members"
name: Get a list of all members
description: ""
method: GET
body: {}
parameters: []
headers: []
authentication: {}
metaSortKey: -1703325202640
isPrivate: false
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global

View File

@ -0,0 +1,33 @@
_id: req_87b162ac1d564368a8933372f62f6437
type: Request
parentId: fld_1f771e8034294c2a9c6396fd6787b6af
modified: 1703325202641
created: 1703325202641
url: "{{ _.base_url }}/members"
name: Add a new member
description: ""
method: POST
body:
mimeType: application/json
text: |-
{
"id": 1337,
"ntnuBrukernavn": "sebasthg",
"firstName": "Sebastian",
"lastName": "Gabrielli",
"email": "sebastian@fastmail.mx"
}
parameters: []
headers:
- name: Content-Type
disabled: false
value: application/json
authentication: {}
metaSortKey: -1703325202641
isPrivate: false
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global

View File

@ -0,0 +1,21 @@
_id: req_98985848bfd3459c9961a645b9048841
type: Request
parentId: fld_1f771e8034294c2a9c6396fd6787b6af
modified: 1703325202643
created: 1703325202643
url: "{{ _.base_url }}/members/{{ _.memberId }}"
name: Get a member
description: ""
method: GET
body: {}
parameters: []
headers: []
authentication: {}
metaSortKey: -1703325202643
isPrivate: false
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global

View File

@ -0,0 +1,33 @@
_id: req_c599698644fa45dd8f6a72424695130c
type: Request
parentId: fld_1f771e8034294c2a9c6396fd6787b6af
modified: 1703325202644
created: 1703325202644
url: "{{ _.base_url }}/members/{{ _.memberId }}"
name: Update a member's details
description: ""
method: PUT
body:
mimeType: application/json
text: |-
{
"id": 1337,
"ntnuBrukernavn": "sebasthg",
"firstName": "Sebastian",
"lastName": "Gabrielli",
"email": "sebastian@fastmail.mx"
}
parameters: []
headers:
- name: Content-Type
disabled: false
value: application/json
authentication: {}
metaSortKey: -1703325202644
isPrivate: false
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global

View File

@ -0,0 +1,21 @@
_id: req_f640bde23d9e4008a8b81fb67b3462ae
type: Request
parentId: fld_c049b55b905d41e69d7085647cfcecad
modified: 1703325202645
created: 1703325202645
url: "{{ _.base_url }}/members/{{ _.memberId }}/balance"
name: Get a member's balance
description: ""
method: GET
body: {}
parameters: []
headers: []
authentication: {}
metaSortKey: -1703325202645
isPrivate: false
settingStoreCookies: true
settingSendCookies: true
settingDisableRenderRequestBody: false
settingEncodeUrl: true
settingRebuildPath: true
settingFollowRedirects: global

View File

@ -0,0 +1,10 @@
_id: fld_1f771e8034294c2a9c6396fd6787b6af
type: RequestGroup
parentId: wrk_0627d19078e64bb7877a6c1703c0fab8
modified: 1703325202638
created: 1703325202638
name: member
description: Operations about a member
environment: {}
environmentPropertyOrder: null
metaSortKey: -1703325202638

View File

@ -0,0 +1,10 @@
_id: fld_c049b55b905d41e69d7085647cfcecad
type: RequestGroup
parentId: wrk_0627d19078e64bb7877a6c1703c0fab8
modified: 1703325202639
created: 1703325202639
name: money
description: Operations about money
environment: {}
environmentPropertyOrder: null
metaSortKey: -1703325202639