Merge pull request #334 from JarvusInnovations/develop

Release: v1.20.0

api-docs/_openapi.yaml

@@ -0,0 +1 @@
+openapi: 3.0.1

api-docs/components/parameters/accept.yaml

@@ -0,0 +1,9 @@
+name: Accept
+in: header
+description: Desired MIME type for response body
+schema:
+  type: string
+  enum:
+  - text/html
+  - application/json
+  - text/csv

api-docs/components/parameters/dir.yaml

@@ -0,0 +1,8 @@
+name: dir
+in: query
+description: Used with the `sort` parameter to set the direction to order
+schema:
+  type: string
+  enum:
+  - ASC
+  - DESC

api-docs/parameters/format.yml → api-docs/components/parameters/format.yaml

@@ -1,8 +1,9 @@
 name: format
 in: query
 description: Desired file format for response body
-type: string
-enum:
-- html
-- json
-- csv
+schema:
+  type: string
+  enum:
+  - html
+  - json
+  - csv

api-docs/components/parameters/identifier.yaml

@@ -0,0 +1,6 @@
+name: identifier
+in: path
+description: Unique numeric `ID` or string `Handle` identifier for a record
+required: true
+schema:
+  type: string

api-docs/components/parameters/include.yaml

@@ -0,0 +1,11 @@
+name: include
+in: query
+description: Name(s) of related objects to embed in response. Pass `*` to include
+  all available related objects. Nested objects may be requested using dot notation,
+  e.g. `include=Creator.Modifier`
+style: form
+explode: false
+schema:
+  type: array
+  items:
+    type: string

api-docs/parameters/limit.yml → api-docs/components/parameters/limit.yaml

@@ -1,5 +1,7 @@
 name: limit
 in: query
-type: integer
-default: 48
-description: Maximum number of records to return in each response. 0 to disable limiting
+description: Maximum number of records to return in each response. 0 to disable
+  limiting
+schema:
+  type: integer
+  default: 48

api-docs/components/parameters/offset.yaml

@@ -0,0 +1,5 @@
+name: offset
+in: query
+description: Number of records to skip for current page
+schema:
+  type: integer

api-docs/components/parameters/query.yaml

@@ -0,0 +1,5 @@
+name: q
+in: query
+description: Keyword search query
+schema:
+  type: string

api-docs/components/parameters/relatedTable.yaml

@@ -0,0 +1,12 @@
+name: relatedTable
+in: query
+description: Provide the names of one or more direct relationship of the requested records
+  and a consolidated array of all unique related records will be returned on the side. Each
+  array will be returned in a property matching the name of the relationship under the
+  top-level property `related`
+style: form
+explode: false
+schema:
+  type: array
+  items:
+    type: string

api-docs/components/parameters/sort.yaml

@@ -0,0 +1,6 @@
+name: sort
+in: query
+description: The name of a `sorter` or field declared on the record model
+  to order results with
+schema:
+  type: string

api-docs/components/schemas/Session.yaml

@@ -0,0 +1 @@
+x-activeRecord: Session

api-docs/definitions/SessionResponse.yml → api-docs/components/schemas/SessionResponse.yaml

@@ -1,8 +1,9 @@
+type: object
 properties:
   success:
     type: boolean
   data:
-    $ref: '#/definitions/Session'
+    $ref: '#/components/schemas/Session'
   returnURL:
     type: string
     description: URL that user should be sent to after login

api-docs/components/securitySchemes/SessionToken.yaml

@@ -0,0 +1,4 @@
+type: apiKey
+description: Session token prefixed with Token, e.g. `Token XXXXXXXXXXXXXXXXXXXXXX`
+name: Authorization
+in: header

api-docs/paths/blog.yaml

@@ -0,0 +1,8 @@
+x-recordsRequestHandler: Emergence\CMS\BlogRequestHandler
+get:
+  parameters:
+  - name: AuthorID
+    in: query
+    description: The `ID` of a person the match blog post authors to
+    schema:
+      type: integer

api-docs/paths/comments.yaml

@@ -0,0 +1 @@
+x-recordsRequestHandler: Emergence\Comments\CommentsRequestHandler

api-docs/paths/content-blocks.yaml

@@ -0,0 +1 @@
+x-recordsRequestHandler: Emergence\CMS\ContentBlocksRequestHandler

api-docs/paths/groups.yaml

@@ -0,0 +1,14 @@
+x-recordsRequestHandler: Emergence\People\Groups\GroupsRequestHandler
+get:
+  parameters:
+  - name: parentGroup
+    in: query
+    description: The ID of a parent group to filter groups to, or nothing to get all
+      top-level groups. To retrieve all groups regardless of hierarchy, pass `parentGroup=any`
+    schema:
+      oneOf:
+        - type: string
+          enum:
+            - any
+        - type: integer
+          default: null

api-docs/paths/login.yaml

@@ -0,0 +1,58 @@
+post:
+  tags:
+  - Session
+  summary: Create a new session
+  security: []
+  parameters:
+  - $ref: '#/components/parameters/include'
+  - $ref: '#/components/parameters/format'
+  - $ref: '#/components/parameters/accept'
+  requestBody:
+    required: true
+    content:
+      application/x-www-form-urlencoded:
+        schema:
+          type: object
+          required:
+          - _LOGIN[password]
+          - _LOGIN[username]
+          properties:
+            _LOGIN[username]:
+              type: string
+            _LOGIN[password]:
+              type: string
+              format: password
+            _LOGIN[returnMethod]:
+              type: string
+              description: Set to `POST` to return session in response to POST
+                request instead of redirecting to post-login URL
+              default: POST
+              enum:
+              - GET
+              - POST
+  responses:
+    200:
+      description: Login credentials accepted, session created
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/SessionResponse'
+    401:
+      description: Username or password invalid
+get:
+  tags:
+  - Session
+  summary: Get current Session
+  parameters:
+  - $ref: '#/components/parameters/include'
+  - $ref: '#/components/parameters/format'
+  - $ref: '#/components/parameters/accept'
+  responses:
+    200:
+      description: Session found
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/SessionResponse'
+    401:
+      description: Sesson not provided, not valid, or expired

api-docs/paths/pages.yaml

@@ -0,0 +1 @@
+x-recordsRequestHandler: Emergence\CMS\PagesRequestHandler

api-docs/paths/people.yaml

@@ -0,0 +1 @@
+x-recordsRequestHandler: PeopleRequestHandler

api-docs/paths/tags.yaml

@@ -0,0 +1,8 @@
+x-recordsRequestHandler: TagsRequestHandler
+get:
+  parameters:
+  - name: prefix
+    in: query
+    description: A handle prefix to match tags against, e.g. `tech` matches `tech.javascript`
+    schema:
+      type: string

api-docs/security.yaml

@@ -0,0 +1 @@
+- SessionToken: []