Deployed 94c160e with MkDocs version: 1.4.2

api/swagger.yaml

@@ -0,0 +1,170 @@
+basePath: /v1
+definitions:
+  response.Error:
+    properties:
+      code:
+        $ref: '#/definitions/response.ErrorCode'
+      message:
+        $ref: '#/definitions/response.ErrorMessage'
+    type: object
+  response.ErrorCode:
+    enum:
+    - 1000
+    - 1001
+    - 1002
+    - 1003
+    type: integer
+    x-enum-varnames:
+    - CodeDefault
+    - CodeNotFound
+    - CodeBadCredentials
+    - CodeInsufficientPermissions
+  response.ErrorMessage:
+    enum:
+    - insufficient permissions
+    - unauthorized
+    - user identifier not found
+    - ticker identifier not found
+    - message identifier not found
+    - message not found
+    - files identifier not found
+    - upload limit exceeded
+    - user not found
+    - ticker not found
+    - setting not found
+    - messages couldn't fetched
+    - invalid form values
+    - failed to save
+    - uploads not found
+    - unable to connect to mastodon
+    - could not authenticate password
+    type: string
+    x-enum-varnames:
+    - InsufficientPermissions
+    - Unauthorized
+    - UserIdentifierMissing
+    - TickerIdentifierMissing
+    - MessageIdentierMissing
+    - MessageNotFound
+    - FilesIdentifierMissing
+    - TooMuchFiles
+    - UserNotFound
+    - TickerNotFound
+    - SettingNotFound
+    - MessageFetchError
+    - FormError
+    - StorageError
+    - UploadsNotFound
+    - MastodonError
+    - PasswordError
+  response.Response:
+    properties:
+      data:
+        additionalProperties:
+          type: string
+        type: object
+      error:
+        $ref: '#/definitions/response.Error'
+      status:
+        $ref: '#/definitions/response.Status'
+    type: object
+  response.Status:
+    enum:
+    - success
+    - error
+    type: string
+    x-enum-varnames:
+    - StatusSuccess
+    - StatusError
+host: localhost:8080
+info:
+  contact:
+    email: admin@systemli.org
+    name: Systemli Admin Team
+    url: https://www.systemli.org/en/contact/
+  description: Service to distribute short messages in support of events, demonstrations,
+    or other time-sensitive events.
+  license:
+    name: GPLv3
+    url: https://www.gnu.org/licenses/gpl-3.0.html
+  title: Ticker API
+  version: "1.0"
+paths:
+  /init:
+    get:
+      consumes:
+      - application/json
+      description: |-
+        The first request for retrieving information about the ticker. It is mandatory that the browser sends
+        the origin as a header. This can be overwritten with a query parameter.
+      parameters:
+      - description: Origin from the ticker, e.g. demoticker.org
+        in: query
+        name: origin
+        type: string
+      - description: Origin from the ticker, e.g. http://demoticker.org
+        in: header
+        name: origin
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/response.Response'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/response.Response'
+      summary: Retrieves the initial ticker configuration
+      tags:
+      - public
+  /timeline:
+    get:
+      consumes:
+      - application/json
+      description: |-
+        Endpoint to retrieve the messages from a ticker. The endpoint has a pagination to fetch newer or older
+        messages. It is mandatory that the browser sends the origin as a header. This can be overwritten with
+        a query parameter.
+      parameters:
+      - description: Origin from the ticker, e.g. demoticker.org
+        in: query
+        name: origin
+        type: string
+      - description: Origin from the ticker, e.g. http://demoticker.org
+        in: header
+        name: origin
+        type: string
+      - description: 'Limit for fetched messages, default: 10'
+        in: query
+        name: limit
+        type: integer
+      - description: ID of the message we look for older entries
+        in: query
+        name: before
+        type: integer
+      - description: ID of the message we look for newer entries
+        in: query
+        name: after
+        type: integer
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/response.Response'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/response.Response'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/response.Response'
+      summary: Fetch the messages for a ticker.
+      tags:
+      - public
+swagger: "2.0"