@bluefly/openstandardagents 0.2.4 → 0.2.7

package/openapi/reference-implementations/crewai-agent-api.openapi.yaml

@@ -0,0 +1,149 @@
+openapi: 3.1.0
+info:
+  title: CrewAI Research Agent API
+  version: 1.0.0
+  description: |
+    CrewAI research agent for multi-agent collaboration.
+    Specializes in gathering comprehensive information on assigned topics.
+
+x-ossa-metadata:
+  version: 0.2.5-RC
+  compliance:
+    level: basic
+    frameworks:
+      - OSSA
+      - OpenAPI 3.1
+      - CrewAI
+
+x-ossa:
+  version: 0.2.5-RC
+  agent:
+    id: research-agent
+    type: worker
+    compliance:
+      standards:
+        - openapi-first
+      validated: true
+      validatedAt: "2024-01-15T10:00:00Z"
+
+servers:
+  - url: http://localhost:3000
+    description: Local development
+
+tags:
+  - name: research
+    description: Research operations
+  - name: collaboration
+    description: Multi-agent collaboration operations
+
+paths:
+  /research:
+    post:
+      summary: Conduct research
+      description: Gather comprehensive information on assigned research topic
+      operationId: conductResearch
+      tags: [research]
+      x-ossa-capability: research
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      x-ossa-llm:
+        provider: openai
+        model: gpt-4
+        temperature: 0.3
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [topic]
+              properties:
+                topic:
+                  type: string
+                  description: Research topic
+                depth:
+                  type: string
+                  enum: [shallow, medium, deep]
+                  default: medium
+                sources:
+                  type: array
+                  items:
+                    type: string
+                  description: Preferred sources
+      responses:
+        '200':
+          description: Research completed
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  topic:
+                    type: string
+                  findings:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        source:
+                          type: string
+                        content:
+                          type: string
+                        relevance:
+                          type: number
+                  summary:
+                    type: string
+                  sources:
+                    type: array
+                    items:
+                      type: string
+
+  /collaborate:
+    post:
+      summary: Collaborate with other agents
+      description: Coordinate with other CrewAI agents for collaborative tasks
+      operationId: collaborate
+      tags: [collaboration]
+      x-ossa-capability: collaborate
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [task, agents]
+              properties:
+                task:
+                  type: string
+                  description: Collaborative task
+                agents:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      agent_id:
+                        type: string
+                      role:
+                        type: string
+      responses:
+        '200':
+          description: Collaboration initiated
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  collaboration_id:
+                    type: string
+                  status:
+                    type: string
+                    enum: [initiated, in_progress, completed]
+                  agents:
+                    type: array
+                    items:
+                      type: object
+

package/openapi/reference-implementations/critic-agent-api.openapi.yaml

@@ -0,0 +1,151 @@
+openapi: 3.1.0
+info:
+  title: Code Quality Critic Agent API
+  version: 1.0.0
+  description: |
+    Quality assurance agent for code review, testing, and continuous improvement.
+    Analyzes code quality, detects issues, and suggests improvements.
+
+x-ossa-metadata:
+  version: 0.2.5-RC
+  compliance:
+    level: intermediate
+    frameworks:
+      - OSSA
+      - OpenAPI 3.1
+
+x-ossa:
+  version: 0.2.5-RC
+  agent:
+    id: code-quality-critic
+    type: critic
+    compliance:
+      standards:
+        - openapi-first
+        - type-safe
+      validated: true
+      validatedAt: "2024-01-15T10:00:00Z"
+
+servers:
+  - url: https://critic.platform.com/api/v1
+    description: Production
+
+tags:
+  - name: review
+    description: Code review operations
+  - name: analysis
+    description: Code analysis operations
+
+paths:
+  /review:
+    post:
+      summary: Review code changes
+      description: Analyze code changes for quality, security, and best practices
+      operationId: reviewCode
+      tags: [review]
+      x-ossa-capability: review-changes
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      x-ossa-llm:
+        provider: openai
+        model: gpt-4
+        temperature: 0.2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [code, language]
+              properties:
+                code:
+                  type: string
+                  description: Code to review
+                language:
+                  type: string
+                  enum: [javascript, typescript, python, java, go, rust, csharp]
+                diff:
+                  type: string
+                  description: Git diff of changes
+      responses:
+        '200':
+          description: Review completed
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  issues:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        severity:
+                          type: string
+                          enum: [critical, high, medium, low]
+                        type:
+                          type: string
+                          enum: [security, performance, maintainability, style]
+                        message:
+                          type: string
+                        line:
+                          type: integer
+                  suggestions:
+                    type: array
+                    items:
+                      type: string
+                  quality_score:
+                    type: number
+                    minimum: 0
+                    maximum: 100
+
+  /analyze:
+    post:
+      summary: Analyze code quality
+      description: Perform comprehensive code quality analysis
+      operationId: analyzeCode
+      tags: [analysis]
+      x-ossa-capability: analyze-code
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [code]
+              properties:
+                code:
+                  type: string
+                metrics:
+                  type: array
+                  items:
+                    type: string
+                    enum: [complexity, maintainability, reliability, security, performance, testability]
+      responses:
+        '200':
+          description: Analysis completed
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  metrics:
+                    type: object
+                    properties:
+                      complexity:
+                        type: number
+                      maintainability:
+                        type: number
+                      reliability:
+                        type: number
+                      security:
+                        type: number
+                      performance:
+                        type: number
+                      testability:
+                        type: number
+

package/openapi/reference-implementations/document-analyzer-api.openapi.yaml

@@ -0,0 +1,217 @@
+openapi: 3.1.0
+info:
+  title: Document Analyzer Agent API
+  version: 2.1.0
+  description: |
+    Production document analysis agent with NLP capabilities.
+    Analyzes documents for sentiment, extracts entities, generates summaries, and classifies content.
+
+x-ossa-metadata:
+  version: 0.2.5-RC
+  compliance:
+    level: intermediate
+    frameworks:
+      - OSSA
+      - OpenAPI 3.1
+
+x-ossa:
+  version: 0.2.5-RC
+  agent:
+    id: document-analyzer
+    type: worker
+    compliance:
+      standards:
+        - openapi-first
+        - type-safe
+      validated: true
+      validatedAt: "2024-01-15T10:00:00Z"
+
+servers:
+  - url: https://document-analyzer.platform.com/api/v1
+    description: Production
+
+tags:
+  - name: analysis
+    description: Document analysis operations
+  - name: extraction
+    description: Text extraction operations
+
+paths:
+  /analyze:
+    post:
+      summary: Analyze document
+      description: Comprehensive document analysis with sentiment and entity extraction
+      operationId: analyzeDocument
+      tags: [analysis]
+      x-ossa-capability: analyze_document
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      x-ossa-llm:
+        provider: openai
+        model: gpt-4o-mini
+        temperature: 0.3
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [document]
+              properties:
+                document:
+                  type: string
+                  description: Document text to analyze
+                include_entities:
+                  type: boolean
+                  default: true
+                include_sentiment:
+                  type: boolean
+                  default: true
+      responses:
+        '200':
+          description: Analysis completed
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  sentiment:
+                    type: object
+                    properties:
+                      score:
+                        type: number
+                      label:
+                        type: string
+                      confidence:
+                        type: number
+                  entities:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        type:
+                          type: string
+                        text:
+                          type: string
+                        start:
+                          type: integer
+                        end:
+                          type: integer
+                  summary:
+                    type: string
+
+  /extract:
+    post:
+      summary: Extract text from document
+      description: Extract text from various document formats (PDF, DOCX, images)
+      operationId: extractText
+      tags: [extraction]
+      x-ossa-capability: extract_text
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              required: [document]
+              properties:
+                document:
+                  type: string
+                  format: binary
+                  description: Document file to extract text from
+      responses:
+        '200':
+          description: Text extracted
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  text:
+                    type: string
+                  metadata:
+                    type: object
+                    properties:
+                      format:
+                        type: string
+                      pages:
+                        type: integer
+
+  /summarize:
+    post:
+      summary: Summarize document
+      description: Generate concise document summary
+      operationId: summarizeDocument
+      tags: [analysis]
+      x-ossa-capability: summarize_document
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [text]
+              properties:
+                text:
+                  type: string
+                  description: Document text to summarize
+                max_length:
+                  type: integer
+                  default: 500
+                  description: Maximum summary length in characters
+      responses:
+        '200':
+          description: Summary generated
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  summary:
+                    type: string
+                  length:
+                    type: integer
+
+  /classify:
+    post:
+      summary: Classify document
+      description: Classify document into predefined categories
+      operationId: classifyDocument
+      tags: [analysis]
+      x-ossa-capability: classify_document
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [text]
+              properties:
+                text:
+                  type: string
+                  description: Document text to classify
+      responses:
+        '200':
+          description: Classification completed
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  category:
+                    type: string
+                  confidence:
+                    type: number
+                    minimum: 0
+                    maximum: 1
+

package/openapi/reference-implementations/getting-started-hello-world-api.openapi.yaml

@@ -0,0 +1,149 @@
+openapi: 3.1.0
+info:
+  title: Hello World Agent API
+  version: 1.0.0
+  description: |
+    Minimal OSSA-compliant agent API demonstrating basic capabilities.
+    This agent can greet users, echo messages, and report its status.
+    Perfect for learning OSSA fundamentals and testing deployments.
+
+x-ossa-metadata:
+  version: 0.2.5-RC
+  compliance:
+    level: basic
+    frameworks:
+      - OSSA
+      - OpenAPI 3.1
+
+x-ossa:
+  version: 0.2.5-RC
+  agent:
+    id: hello-world-agent
+    type: worker
+    compliance:
+      standards:
+        - openapi-first
+      validated: true
+      validatedAt: "2024-01-15T10:00:00Z"
+
+servers:
+  - url: http://localhost:3000
+    description: Local development server
+
+tags:
+  - name: greeting
+    description: Greeting operations
+  - name: echo
+    description: Echo operations
+  - name: status
+    description: Status operations
+
+paths:
+  /greet:
+    post:
+      summary: Generate greeting
+      description: Generates a personalized greeting message for a user
+      operationId: greet
+      tags: [greeting]
+      x-ossa-capability: greeting
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      x-ossa-llm:
+        provider: openai
+        model: gpt-3.5-turbo
+        temperature: 0.7
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [name]
+              properties:
+                name:
+                  type: string
+                  description: Name to greet
+                  example: "Alice"
+                language:
+                  type: string
+                  enum: [en, es, fr, de]
+                  default: en
+                  description: Language for greeting
+      responses:
+        '200':
+          description: Greeting generated successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: The greeting message
+                  timestamp:
+                    type: string
+                    format: date-time
+
+  /echo:
+    post:
+      summary: Echo input
+      description: Echo back a message sent to the agent
+      operationId: echo
+      tags: [echo]
+      x-ossa-capability: echo_message
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [message]
+              properties:
+                message:
+                  type: string
+                  description: Message to echo
+      responses:
+        '200':
+          description: Message echoed
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  echo:
+                    type: string
+                  received_at:
+                    type: string
+                    format: date-time
+
+  /status:
+    get:
+      summary: Get agent status
+      description: Returns the current status of the agent
+      operationId: getStatus
+      tags: [status]
+      x-ossa-capability: get_status
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      responses:
+        '200':
+          description: Agent status
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    enum: [online, offline, maintenance]
+                  version:
+                    type: string
+                  uptime:
+                    type: integer
+                    description: Uptime in seconds
+