@scouterna/scoutnet-openapi 0.2.0 → 0.3.5

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # Changelog
 
+## [0.3.5](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-openapi-v0.3.4...scoutnet-openapi-v0.3.5) (2026-01-11)
+
+
+### Bug Fixes
+
+* dummy release ([a4f0044](https://github.com/Scouterna/scoutnet-api/commit/a4f00445b00ef8fb5e5ca93f4c61f8618f1a4023))
+
+## [0.3.4](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-openapi-v0.3.3...scoutnet-openapi-v0.3.4) (2026-01-11)
+
+
+### Bug Fixes
+
+* dummy release ([7f4784a](https://github.com/Scouterna/scoutnet-api/commit/7f4784af8a0678a9001b17baafc79edebff1f83f))
+
+## [0.3.3](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-openapi-v0.3.2...scoutnet-openapi-v0.3.3) (2026-01-11)
+
+
+### Bug Fixes
+
+* dummy release ([1d0be9f](https://github.com/Scouterna/scoutnet-api/commit/1d0be9ff1747ff90f3a1cf2a02e8425d4f13ddb7))
+
+## [0.3.2](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-openapi-v0.3.1...scoutnet-openapi-v0.3.2) (2026-01-11)
+
+
+### Bug Fixes
+
+* dummy release ([6aa4926](https://github.com/Scouterna/scoutnet-api/commit/6aa492658badd5c456a39027a174890bcd088be2))
+
+## [0.3.1](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-openapi-v0.3.0...scoutnet-openapi-v0.3.1) (2026-01-11)
+
+
+### Bug Fixes
+
+* dummy release ([73504aa](https://github.com/Scouterna/scoutnet-api/commit/73504aa4ab27c935d8c979a384642bf11c111ba4))
+
+## [0.3.0](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-openapi-v0.2.1...scoutnet-openapi-v0.3.0) (2026-01-11)
+
+
+### Features
+
+* add questions endpoint ([313d5c3](https://github.com/Scouterna/scoutnet-api/commit/313d5c30d9656dd69a2410a3f06e020455cc5839))
+
+## [0.2.1](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-openapi-v0.2.0...scoutnet-openapi-v0.2.1) (2025-07-23)
+
+
+### Bug Fixes
+
+* make optional properties nullable ([c57724b](https://github.com/Scouterna/scoutnet-api/commit/c57724bbbf21a89c69bd41d98ff576aa249c32ff))
+
 ## [0.2.0](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-openapi-v0.1.9...scoutnet-openapi-v0.2.0) (2025-07-23)
 
 

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 The Guides and Scouts of Sweden
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scouterna/scoutnet-openapi",
-  "version": "0.2.0",
+  "version": "0.3.5",
   "description": "The OpenAPI document for the Scoutnet API, neatly packaged for NPM.",
   "keywords": [
     "scouterna",

package/schema/components/body.yaml

@@ -1,4 +1,10 @@
 type: object
+required:
+  - body_key
+  - body_name
+  - body_type
+  - body_id
+  - organisation_id
 properties:
   body_key:
     type: string

package/schema/components/district.yaml

@@ -1,4 +1,7 @@
 type: object
+required:
+  - name
+  - groups
 properties:
   name:
     type: string

package/schema/components/form.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  title:
+    type: string
+    description: The title of the form.
+  id:
+    type: number
+    description: The form ID number.
+  form_type:
+    type: string
+    enum: [individual, group]
+    description: The type of form.
+  endpoint_url:
+    type: string
+    description: A direct, authenticated URL to access the full form data.

package/schema/components/group.yaml

@@ -1,4 +1,6 @@
 type: object
+required:
+  - group_no
 properties:
   name:
     type: string

package/schema/components/group_section.yaml

@@ -1,4 +1,7 @@
 type: object
+required:
+  - name
+  - id
 properties:
   name:
     type: string

package/schema/components/group_troop.yaml

@@ -1,4 +1,10 @@
 type: object
+required:
+  - name
+  - type
+  - min_age
+  - max_age
+  - section_id
 properties:
   name:
     type: string

package/schema/components/project_member.yaml

@@ -1,77 +1,77 @@
 type: object
 properties:
   checked_in:
-    type: [boolean, 'null']
+    type: boolean
   attended:
-    type: [boolean, 'null']
+    type: boolean
   cancelled:
-    type: [boolean, 'null']
+    type: boolean
   member_status:
-    type: [number, 'null']
+    type: number
   member_no:
-    type: [number, 'null']
+    type: number
   group_registration:
-    type: [boolean, 'null']
+    type: boolean
   first_name:
-    type: [string, 'null']
+    type: string
   last_name:
-    type: [string, 'null']
+    type: string
   ssno:
-    type: [string, 'null']
+    type: string
   registration_date:
-    type: [string, 'null']
+    type: string
   cancelled_date:
-    type: [string, 'null']
+    type: string
   primary_email:
-    type: [string, 'null']
+    type: string
   fee_id:
-    type: [number, 'null']
+    type: number
   primary_membership_info:
-    type: [object, array, 'null']
+    type: [object, array]
     properties:
       patrol_id:
-        type: [number, 'null']
+        type: number
       patrol_name:
-        type: [string, 'null']
+        type: string
       troop_id:
-        type: [number, 'null']
+        type: number
       troop_name:
-        type: [string, 'null']
+        type: string
       group_id:
-        type: [number, 'null']
+        type: number
       group_name:
-        type: [string, 'null']
+        type: string
       district_id:
-        type: [number, 'null']
+        type: number
       district_name:
-        type: [string, 'null']
+        type: string
       region_id:
-        type: [number, 'null']
+        type: number
       region_name:
-        type: [string, 'null']
+        type: string
       organisation_id:
-        type: [number, 'null']
+        type: number
       organisation_name:
-        type: [string, 'null']
+        type: string
   group_registration_info:
-    type: [object, array, 'null']
+    type: [object, array]
     properties:
       group_id:
-        type: [number, 'null']
+        type: number
       patrol_id:
-        type: [number, 'null']
+        type: number
       group_name:
-        type: [string, 'null']
+        type: string
       org_id:
-        type: [number, 'null']
+        type: number
       org_name:
-        type: [string, 'null']
+        type: string
       district_id:
-        type: [number, 'null']
+        type: number
       district_name:
-        type: [string, 'null']
+        type: string
       patrol_name:
-        type: [string, 'null']
+        type: string
   questions:
     type: {}
     description: NOT YET DOCUMENTED

package/schema/components/question.yaml

@@ -0,0 +1,25 @@
+type: object
+properties:
+  question:
+    type: string
+    description: The question name.
+  description:
+    type: string
+    description: The question description.
+  tab_id:
+    type: number
+    description: ID of the tab the question belongs to.
+  section_id:
+    type: number
+    description: ID of the section the question belongs to.
+  default_value:
+    type: string
+    description: The default value of the question.
+  type:
+    type: string
+    description: The type of question.
+  choices:
+    type: object
+    additionalProperties:
+      $ref: './question_choice.yaml'
+  

package/schema/components/question_choice.yaml

@@ -0,0 +1,11 @@
+type: object
+properties:
+  value:
+    type: number
+    description: The choice ID.
+  option:
+    type: string
+    description: The choice text.
+  description:
+    type: string
+    description: The choice description.

package/schema/paths/project_forms.yaml

@@ -0,0 +1,30 @@
+get:
+  summary: Get a list of forms associated with a project
+  operationId: getProjectFormts
+  tags:
+    - project
+  responses:
+    '200':
+      description: |
+        Keys of the response object are form IDs and values are form objects.
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              forms:
+                type: object
+                additionalProperties:
+                  $ref: ../components/form.yaml
+              form:
+                $ref: ../components/form.yaml
+              questions:
+                type: object
+                additionalProperties:
+                  $ref: ../components/question.yaml
+              messages:
+                type: array
+                items:
+                  type: string
+    '401':
+      $ref: ../responses/not_authorized.yaml

package/schema/scoutnet.yaml

@@ -8,7 +8,7 @@ info:
     Scoutnet is the member management system for the Guides and Scouts of
     Sweden. This API provides access to various resources related to projects,
     groups, and participants.
-  version: 0.2.0
+  version: 0.3.5
   license:
     name: MIT
     identifier: MIT
@@ -44,3 +44,5 @@ paths:
     $ref: ./paths/project_get_participants.yaml
   /project/checkin:
     $ref: ./paths/project_checkin.yaml
+  /project/get/questions:
+    $ref: ./paths/project_forms.yaml