swagger.yaml

openapi: 3.0.0
info:
  title: Team API
  version: 1.0.0
  description: >
    This API allows you to explore and interact with information about teams, including their focus, fundamental team type, and ways to collaborate effectively.

  features:
    - 📊 Team Metrics: Key performance indicators and success measures.
    - 🗣️ Communication: Details on how to get in touch with the team.
    - 📚 Documentation: Useful links and resources for deeper understanding.

servers:
  - url: https://bagg3rs.github.io/team-api/
    description: Production server

tags:
  - name: Team Overview
    description: Information about the team's purpose and capabilities.
  - name: Interfaces
    description: Details on how others can interact with the team.
  - name: Expectations
    description: What the team needs from others to succeed.
  - name: Metrics
    description: Key metrics and feedback loops.

paths:
  /team/overview:
    get:
      tags:
        - Team Overview
      summary: Get team mission and capabilities
      description: Retrieve information about the team's mission, focus, and unique capabilities.
      responses:
        '200':
          description: Successful response with team overview.
          content:
            application/json:
              schema:
                type: object
                properties:
                  mission:
                    type: string
                    example: "Ensuring reliability and scalability of customer-facing platforms."
                  capabilities:
                    type: array
                    items:
                      type: string
                    example:
                      - "Automated CI/CD pipelines"
                      - "Platform observability tools"
                      - "System performance optimisation"

  /team/interfaces:
    get:
      tags:
        - Interfaces
      summary: Get communication and collaboration details
      description: Retrieve details on how to interact with the team, including communication channels and collaboration processes.
      responses:
        '200':
          description: Successful response with interface details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  communication_channels:
                    type: array
                    items:
                      type: string
                    example:
                      - "Slack: #team-platform"
                      - "Email: team@example.com"
                  collaboration_process:
                    type: string
                    example: "Submit requests via Jira board with detailed requirements."

  /team/expectations:
    get:
      tags:
        - Expectations
      summary: Get expectations of other teams
      description: Retrieve the resources, dependencies, and commitments the team needs from others.
      responses:
        '200':
          description: Successful response with expectations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dependencies:
                    type: array
                    items:
                      type: string
                    example:
                      - "IT Ops team for network configurations"
                      - "Product team for prioritisation guidance"
                  commitments:
                    type: string
                    example: "Resolving high-priority incidents within 2 hours with necessary details provided."

  /team/metrics:
    get:
      tags:
        - Metrics
      summary: Get team performance metrics
      description: Retrieve the team's key performance indicators and feedback mechanisms.
      responses:
        '200':
          description: Successful response with metrics and feedback details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  kpis:
                    type: array
                    items:
                      type: string
                    example:
                      - "99.95% uptime for core systems"
                      - "Deployment pipeline success rates >95%"
                  feedback_mechanisms:
                    type: array
                    items:
                      type: string
                    example:
                      - "Quarterly stakeholder surveys"
                      - "Retrospectives for major collaborations"

components:
  schemas:
    Team:
      type: object
      properties:
        mission:
          type: string
          description: The team's mission statement.
        capabilities:
          type: array
          items:
            type: string
          description: The key services or products the team provides.
        communication_channels:
          type: array
          items:
            type: string
          description: Preferred methods of communication.
        dependencies:
          type: array
          items:
            type: string
          description: Dependencies and support needed from other teams.
        metrics:
          type: array
          items:
            type: string
          description: Key metrics to measure the team's success.

externalDocs:
  description: Learn more about the Team API approach
  url: https://github.com/TeamTopologies/Team-API-template#readme