lifecycle.yml

---
# APIs JSON/YAML Specification Details
specificationVersion: '0.1'
specificationType: 'Lifecycle'

# Overview of this API
name: API Lifecycle
description: This is an APIs JSON/YAML definition providing a lifecycle view of a single API, providing a template of possibly building blocks that can be used to govern the consistent delivery of APIs.
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
url: http://example.com/apis.json

# Tags for helping organize
tags:
- Application Programming Interface
- API

# Time frame for API evolution
created: '2023-07-19'
modified: '2023-07-19'

define:

  guidance: https://example.com/define/guidance/

  # Navigating Change
  version:
      current: 'http://example.com/next'
      next: 'http://example.com/next'
      previous: 'http://example.com/next'

  source:

    - type: workspace
      title: Postman Workspace
      url: 'https://example.com/private-workspace'   
      
    - type: repository
      title: GitHub Repository
      url: 'https://github.com/repo'   

  # The machine readable contract for the API
  contracts:

    openapi:
      
      - version: 3.1
        title: Example API
        url: https://example.com/openapi    

    asyncapi:
      
      - version: 2.0
        title: Example API
        url: https://example.com/asyncapi              

  # Development
  # Staging
  # Production
  environments: 

    # Environment for development
    development:

      name: Development
      url: 'https://www.postman.com/environment'  
      variables:
          base_url: 'http://example.com/development'       
          api_key: 'xe3847d3J78393jkdm1123'  

    # Environment for production
    staging:

        name: Staging
        url: 'https://www.postman.com/environment'  
        variables:
            base_url: 'http://example.com/staging'       
            api_key: 'xe3847d3J78393jkdm1123'                


    # Environment for production
    production:

        name: Production
        url: 'https://www.postman.com/environment'  
        variables:
            base_url: 'http://example.com/production'       
            api_key: 'xe3847d3J78393jkdm1123'                

  # Design
  # Pre-Release    
  # Active
  # Recommended
  # Retired
  # Deprecated
  maturity: 'Active'

  # Public
  # Internal
  # Group
  # Partner
  visibility: 'Internal'

# Designing before we develop
design:

  guidance: https://example.com/design/guidance/

  # All Mocks
  mock:           

    - type: sandbox
      title: Mock Server
      url: 'https://example.com/mock'
      collection: 'https://www.postman.com/collection'        

  # Documentation
  document:

    # Reference Documentation
    - type: reference
      title: Reference Documentation
      url: 'https://example.com/documentation'
      collection: 'https://www.postman.com/collection'

    # Onboarding Documentation
    - type: onboarding
      title: Onboarding Documentation
      url: 'https://example.com/documentation'
      collection: 'https://www.postman.com/collection'                  

    # Workflow Documentation
    - type: workflow
      title: Business Workflow Documentation
      url: 'https://example.com/documentation'
      collection: 'https://www.postman.com/collection'

# Deployment
develop:    

  guidance: https://example.com/develop/guidance/

  pipelines:

    # Pipeline
    - type: github-action
      title: Github Action
      url: 'https://github.com/org/repo/actions'       

  gateway:

    # Gateway
    - type: aws-api-gateway
      title: AWS API Gateway
      region: us-east1
      url: ' https://uab3sjk0mna.execute-api.us-east-1.amazonaws.com'            
      sync: true

# Management
manage:

  guidance: https://example.com/management/guidance/

  onboarding:

    # Onboarding
    - type: access
      title: Login / Registration
      url: 'https://example.com/login'                           

    # Plan
    - type: aws-api-gateway-plan
      title: Plan
      url: 'https://console.aws.amazon.com/apigateway/home?#/usage-plans/859pid'                              

  # SDKs
  sdks:

      label: SDKs
      guidance: http://example.com/guidance
      elements:     

          # Python
          - type: python
            title: Python Library
            url: 'https://github.com/sdks/python'                           

          # Node.js
          - type: node.js
            title: Node.js Library
            url: 'https://github.com/sdks/nodejs'   

          # Go
          - type: go
            title: Go Library
            url: 'https://github.com/sdks/go'   

  # Milestones for the API (Achieved and Target)
  milestones:

      # Design
      - type: design
        description: 'Design agreed upon by stakeholders.'
        date: '2021-05-01'

      # Design Review
      - type: design-review
        description: 'Went through design review.'
        date: '2021-06-01'          

      # Staging
      - type: staging
        description: 'Left staging phase of development.'
        date: '2021-07-01'

      # Security Review
      - type: security-review
        description: 'Went through security review.'
        date: '2021-06-01'           

      # Active
      - type: active
        description: 'Put into production as active API.'
        date: '2021-07-15'   

      # Retire
      - type: retire
        description: 'Planned retirement date.'
        date: '2025-07-15'                            

      # Deprecation
      - type: deprecation
        description: 'Planned deprecation date.'
        date: '2025-12-15'

  # Managing change
  changelog:

      - type: Alpha Release
        description: 'Achieved the alpha release'
        date: '2023-05-01'
        url: http://example.com/changelog/

      - type: Beta Release
        description: 'Achieved the beta release'
        date: '2023-06-01'        
        url: http://example.com/changelog/
                     
# All Tests
test:

  guidance: https://example.com/test/guidance/

  areas:

    - type: contract
      title: Contract Testing
      url: 'https://example.com/contract-testing'
      collection: 'https://www.postman.com/collection'

    - type: performance
      title: Performance Testing
      url: 'https://example.com/performance-testing'
      collection: 'https://www.postman.com/collection'

    - type: security
      title: OWASP Top 10
      url: 'https://example.com/owasp-security-testing'
      collection: 'https://www.postman.com/collection'

# All Monitors
monitor:

  guidance: https://example.com/monitor/guidance/

  areas:              

      - type: uptime
        title: Uptime Monitor
        url: 'https://example.com/monitor'
        collection: 'https://www.postman.com/collection'
        environment: 'https://www.postman.com/environment'

      - type: security
        title: Recurring Security Testing Monitor
        url: 'https://example.com/monitor'
        collection: 'https://www.postman.com/collection'
        environment: 'https://www.postman.com/environment'

      - type: contract
        title: Contract Testing Monitor
        url: 'https://example.com/monitor'
        collection: 'https://www.postman.com/collection'
        environment: 'https://www.postman.com/environment'                                    

      - type: performance
        title: US East Regional Performance Testing Monitor
        url: 'https://example.com/monitor'
        collection: 'https://www.postman.com/collection'
        environment: 'https://www.postman.com/environment'

      - type: performance
        title: US West Regional Performance Testing Monitor
        url: 'https://example.com/monitor'
        collection: 'https://www.postman.com/collection'
        environment: 'https://www.postman.com/environment'                  

# Observability
observe:          

  guidance: https://example.com/observe/guidance/

  areas:

    - type: reports
      title: Report Dashboard
      url: 'https://example.com/reports' 

    - type: change-log
      title: Change Log
      url: 'https://example.com/change-log'      

    - type: activity
      title: Activity
      url: 'https://example.com/activity'     

    - type: apm
      title: Datadog
      url: 'https://datadog.com/dashboard'   
      sync: true   

    - type: aws-api-gateway
      title: Gateway Usage Report
      url: ' https://uab3sjk0mna.execute-api.us-east-1.amazonaws.com/usage'  
      sync: true                    

    - type: uptime
      title: Uptime Monitor Results
      url: 'https://example.com/monitor/results'

    - type: security
      title: Recurring Security Testing Monitor Results
      url: 'https://example.com/monitor/results'

    - type: contract
      title: Contract Testing Monitor Results
      url: 'https://example.com/monitor/results'                                   

    - type: performance
      title: US East Regional Performance Testing Monitor Results
      url: 'https://example.com/monitor/results'

    - type: performance
      title: US West Regional Performance Testing Monitor Results
      url: 'https://example.com/monitor/results'                                                

# Discovery
distribute:            

  guidance: https://example.com/distribute/guidance/

  ares:

    - type: portal
      title: Public Portal
      url: 'https://example.com/public-portal'                 

# Governance
govern:

  guidance: https://example.com/governance/guidance/

  ares:

    - type: lifecycle-rules
      title: Lifecycle Rules
      description: Spectral rules governing this APIs JSON/YAML definition.
      url: 'https://example.com/design-rules' 

    - type: design-rules
      title: Design Rules
      description: Spectral rules governing the design of the API using OpenAPI.
      url: 'https://example.com/design-rules'    

    - type: management-rules
      title: Management Rules
      description: Spectral rules governing the gateway and related operations.
      url: 'https://example.com/management-rules'                       

    - type: documentation-rules
      title: Documentation Rules
      description: Spectral rules that ensure documentation is rich and complete.
      url: 'https://example.com/documentation-rules'   

    - type: testing-rules
      title: Testing Rules
      description: Spectralrules that ensure testing is in place and operating.
      url: 'https://example.com/testing-rules'                                                    

support:

  # General Support for the API
  contact:

    - FN: APIs.json
      email: info@apisjson.org
      url: https://example.com/contact/

  # Who is Maintaining this APIs JSON/YAML
  maintainers:

    - FN: Kin Lane
      X-twitter: apievangelist
      email: info@apievangelist.com  

# Other Related APIs to Include
include:
- name: Another Example API
  url: http://example.com/apis.json