openapi.yml

openapi: 3.0.2
info:
  title: OCA Repository
  description: ''
  version: 0.4.15
servers:
  - url: https://repository.oca.argo.colossi.network/api/
  - url: http://localhost:8000
tags:
  - name: Public API
    description: Endpoints to manage the OCA Bundles


paths:
  /oca-bundles:
    post:
      tags: [Public API]
      summary: Creates an OCA Bundle from OCAfile
      requestBody:
        content:
          text/plain:
            schema:
              type: string
            example: |
              ADD ATTRIBUTE d=Text i=Text passed=Boolean

              ADD META en PROPS name="Entrance credential" description="Entrance credential"

              ADD CHARACTER_ENCODING ATTRS d=utf-8 i=utf-8 passed=utf-8
              ADD CONFORMANCE ATTRS d=M i=M passed=M
              ADD LABEL en ATTRS d="Schema digest" i="Credential Issuee" passed="Passed"
              ADD INFORMATION en ATTRS d="Schema digest" i="Credential Issuee" passed="Enables or disables passing"
      responses:
        '200':
          description: OCA Bundle created successfully
          content:
            application/json:
              schema:
                type: object
                items:
                  type: object
                  properties:
                    success:
                      type: boolean
                    said:
                      type: string

  /oca-bundles/search:
    get:
      tags: [Public API]
      summary: Search OCA Bundles
      parameters:
        - name: q
          in: query
          required: true
          description: Query to search through OCA Bundles
          schema:
            type: string
        - name: lang
          in: query
          required: false
          description: Language to prioritize in search
          schema:
            type: string
      responses:
        '200':
          description: Successful response
        '404':
          description: Bundle not found

  /oca-bundles/{said}:
    get:
      tags: [Public API]
      summary: Get OCA Bundle
      parameters:
        - name: said
          in: path
          required: true
          description: OCA Bundle SAID
          schema:
            type: string
        - name: w
          in: query
          description: With dependecies - dereference all nested SAID and provide in form of an array
          schema:
            type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BundleWithDeps'
        '404':
          description: Bundle not found

  /oca-bundles/{said}/steps:
    get:
      tags: [Public API]
      summary: List OCAFile steps to get OCA Bundle
      parameters:
        - name: said
          in: path
          required: true
          description: OCA Bundle SAID
          schema:
            type: string
        - name: extend
          in: query
          description: Extend steps by resulted OCA Bundle
          schema:
            type: boolean
      responses:
        '200':
          description: Successful response
        '404':
          description: Bundle not found

  /oca-bundles/{said}/ocafile:
    get:
      tags: [Public API]
      summary: List OCAFile to get OCA Bundle
      parameters:
        - name: said
          in: path
          required: true
          description: OCA Bundle SAID
          schema:
            type: string
      responses:
        '200':
          description: Successful response
        '404':
          description: Bundle not found

  /oca-bundles/{said}/data-entry:
    get:
      tags: [Public API]
      summary: Download OCA Bundle data entry XLSX file
      parameters:
        - name: said
          in: path
          required: true
          description: OCA Bundle SAID
          schema:
            type: string
      responses:
        '200':
          description: Successful response
        '404':
          description: Bundle not found

  /explore/{said}:
    get:
      tags: [Public API]
      summary: Get relations of any OCA object
      parameters:
        - name: said
          in: path
          required: true
          description: OCA object SAID
          schema:
            type: string
      responses:
        '200':
          description: Successful response
        '404':
          description: Bundle not found

  /objects:
    get:
      tags: [Public API]
      summary: Get list of OCA objects
      parameters:
        - name: said
          in: query
          required: true
          description: List of OCA object SAIDs separated by comma
          schema:
            type: string
      responses:
        '200':
          description: Successful response
        '404':
          description: Bundle not found

components:
  securitySchemes:
    namespaceToken:
      type: http
      scheme: bearer
  schemas:
    BundleWithDeps:
      type: object
      properties:
        bundles:
          type: object
          description: Main oca bundle
        dependencies:
          type: array
          items:
            type: object
            description: oca bundle