manifest_template.yml

SERVICE_NAME: nrl-consumer-api
PRODUCT_DISPLAY_NAME: nrl-consumer-api
DESCRIPTION: example description
APIGEE_ENVIRONMENTS:
  - name: internal-dev
    display_name: Internal Development
    has_mock_auth: true
    approval_type: auto
    ratelimiting:
      quota:
        enabled: false
      spikeArrest:
        enabled: false
  - name: internal-dev-sandbox
    display_name: Internal Development Sandbox
    portal_visibility: false
    approval_type: auto
    ratelimiting:
      quota:
        enabled: false
      spikeArrest:
        enabled: false
  - name: internal-qa
    display_name: Internal QA
    has_mock_auth: true
    approval_type: auto
    ratelimiting:
      quota:
        enabled: false
      spikeArrest:
        enabled: false
  - name: internal-qa-sandbox
    display_name: Internal QA Sandbox
    portal_visibility: false
    approval_type: auto
    ratelimiting:
      quota:
        enabled: false
      spikeArrest:
        enabled: false
  - name: ref
    display_name: Ref
    has_mock_auth: true
    approval_type: auto
    ratelimiting:
      quota:
        enabled: true
        limit: 30000 # 500/s
        interval: 1
        timeunit: minute
      spikeArrest:
        enabled: true
        ratelimit: '30000pm' # 500/s
  - name: sandbox
    display_name: Sandbox
    portal_visibility: false
    approval_type: auto
    ratelimiting:
      quota:
        enabled: true
        limit: 300 # 5/s
        interval: 1
        timeunit: minute
      spikeArrest:
        enabled: true
        ratelimit: '300pm' # 5/s
  - name: int
    display_name: Integration Testing
    has_mock_auth: true
    approval_type: manual
    ratelimiting:
      quota:
        enabled: true
        limit: 30000  # 500/s
        interval: 1
        timeunit: minute
      spikeArrest:
        enabled: true
        ratelimit: '30000pm' # 500/s
  - name: prod
    display_name: Production
    approval_type: manual
    ratelimiting:
      quota:
        enabled: true
        limit: 30000 # 500/s
        interval: 1
        timeunit: minute
      spikeArrest:
        enabled: true
        ratelimit: '30000pm' # 500/s
---
meta:
  api:
    name: nrl-consumer-api
    guid: e2ee307a-1e7e-4f2e-ae45-788912caa268
    spec_guids:
      - 458e4b8f-509a-4427-8d1a-1ba75223c28c
  schema_version: 1.3
apigee:
  environments:
{% for ENV in APIGEE_ENVIRONMENTS %}
{% set TITLE = PRODUCT_DISPLAY_NAME + ' (' + ENV.display_name + ' Environment)' %}
{% set NAME = SERVICE_NAME + '-' + ENV.name %}
{% set APPROVAL_TYPE = ENV.APPROVAL_TYPE | default('manual' if ENV.name == 'prod' else 'auto') %}
  - name: {{ ENV.name }}
    products:
      - name: {{ NAME }}
        approvalType: {{ APPROVAL_TYPE }}
        attributes:
          - name: access
            value: public
            # For a parameterised example of rate limiting per environment,
            # see https://github.com/NHSDigital/personal-demographics-service-api/blob/master/manifest_template.yml
          - name: ratelimiting
            value:
              {{ NAME }}:
                quota:
{% if ENV.ratelimiting.quota.enabled | default(true) %}
                  enabled: true
                  limit: {{ ENV.ratelimiting.quota.limit | default(300) }}
                  interval: {{ ENV.ratelimiting.quota.interval | default(1) }}
                  timeunit: {{ ENV.ratelimiting.quota.timeunit | default('minute') }}
{% else %}
                  enabled: false
{% endif %}
                spikeArrest:
{% if ENV.ratelimiting.spikeArrest.enabled | default(true) %}
                  enabled: true
                  ratelimit: {{ ENV.ratelimiting.spikeArrest.ratelimit | default('300pm') }}
{% else %}
                  enabled: false
{% endif %}
              app:
                quota:
                  enabled: false
                spikeArrest:
                  enabled: false
        description: {{ DESCRIPTION }}
        displayName: {{ TITLE }}
        environments: [ {{ ENV.name }} ]
        proxies:
          - {{ NAME }}
          - identity-service-{{ ENV.name }}
{% if ENV.has_mock_auth | default(false) %}
          - identity-service-mock-{{ ENV.name }}
{% endif %}
        scopes:
          - 'urn:nhsd:apim:app:level3:{{ SERVICE_NAME }}'
          - 'urn:nhsd:apim:user-nhs-id:aal3:{{ SERVICE_NAME }}'
    specs:
      - name: {{ NAME }}
        path: {{ SERVICE_NAME }}.json
    api_catalog:
      - edgeAPIProductName: {{ NAME }}
        anonAllowed: true
        description: {{ DESCRIPTION }}
        requireCallbackUrl: false
        title: {{ TITLE }}
        visibility: {{ ENV.portal_visibility | default(true) }}
        specId: {{ NAME }}
{% endfor %}