Publishing an API group with FaUAPI DevOps pipeline task

DevOps Pipeline Task Name: FaUAPI-Publish-Api-Group

This FaUAPI DevOps pipeline task will publish an API group after the API group is configured and created.

The required inputs for this pipeline task are outlined in the table below: | Input Name | Required? | Type | Description | Default Value | | --------------- | ------------------------------ | ----------------------------------------------------------------------------------- |------------------- |------------------ | | AutomationToken | Required | String | Workspace automation token. This is obtained by following the steps in Adding a workspace automation token. | - | FaUAPIInstance | Required | String | Instance which the API is to be configured. Valid value string are ('DEV', 'Test', 'PREPROD', 'PROD'). | - ApiGroupName | Required | String | The name of the API group to publish. | - |

Now, let's look at an example of publishing an API using FaUAPI DevOps pipeline tasks.

Example:

To publish an API using FaUAPI DevOps pipeline task:

1. Go to DfE Azure DevOps URL.
2. Sign in to DfE Azure DevOps.
3. Go to the Solutions Development project.
4. Select Pipelines from the left sidebar tab options. This will show you the Pipeline page with search.
5. Type the word or phrase for the pipeline task you want to create into the search box.
6. Select the relevant FaUAPI DevOps pipeline task from the search result. This will show you the pipeline task creation page.
7. Select the relevant environment from the FaUAPI instance radio options (Development, Test, Pre-Production, Production).

Sample Pipeline YAML file (API only) In the sample pipeline file, you

variables:
 - group: "EXAMPLE-VARIABLE-GROUP"
      
steps:
- task: FaUAPI-Configure-API-Group@1
  inputs:
    AutomationToken: "$(AUTOMATION-TOKEN)"
    FaUAPIInstance: "$(TARGET-INSTANCE)"
    ApiGroupDefinition: "json/apigroup.json"
- task: FaUAPI-Publish-API@1
  inputs:
    AutomationToken: "$(AUTOMATION-TOKEN)"
    FaUAPIInstance: "$(TARGET-INSTANCE)"
    ApiGroupName: "$(API_GROUP_NAME)"

Sample API group definition file (JSON)

{
  "backendType": "http",
  "classification": "Across government services",
  "description": "This is an example description of sufficient length",
  "displayName": "Example API Group",
  "isHosted": true,
  "majorVersion": "1",
  "name": "example-api",
  "overview": "This is an example overview. You need this in order to publish.",
  "versionScheme": "UrlSuffix",
  "visibility": "Private",
  "schema": {
      "description": "This is an example API group schema",
      "fileName": "schema.json",
      "name": "schema.json",
      "type": "schema",
      "schemaType": "openapi",
      "DefinitionFilePath": "json/schema.json"
  },
  "authentications":[
    {
      "autoEnforce": true,
      "enabled": true,
      "parameters": {
        "HeaderName": "Ocp-Apim-Subscription-Key",
        "QueryName": "Subscription-Key"
      },
      "type": "SubscriptionKey"
    }
  ],
  "environments": [
    {
      "backendMode": "Explicit",
      "backendUrl": "http://www.example.com/",
      "canSubscribe": true,
      "enabled": true,
      "name": "live",
      "requiresApproval": false,
      "visibility": "Inherit"
    }
  ],
  "releases": [
    {
      "availableFrom": "2025-09-01",
      "availableTo": "2025-12-30",
      "isCurrent": true,
      "name": "1.0",
      "notes": "Example release notes\r\nThis can contain *markdown*",
      "tag": "Live"
    }
  ]
}

Sample schema file (JSON)

{
    "openapi": "3.0.1",
    "info": {
      "title": "Api group Example",
      "version": "v1"
    },
    "servers": [
      {
        "url": "https://example-api.platform.education.gov.uk/v1"
      }
    ],
    "paths": {
      "/api/linked-test": {
        "post": {
          "tags": [
            "example_post"
          ],
          "summary": "Run",
          "operationId": "Run",
          "responses": {
            "200": {
              "description": "Success"
            }
          }
        }
      },
      "/api/example-get": {
        "get": {
          "tags": [
            "example_get"
          ],
          "summary": "Dog",
          "operationId": "Dog",
          "responses": {
            "200": {
              "description": "Success"
            }
          }
        }
      }
    },
    "components": {
      "securitySchemes": {
        "apiKeyHeader": {
          "type": "apiKey",
          "name": "Ocp-Apim-Subscription-Key",
          "in": "header"
        },
        "apiKeyQuery": {
          "type": "apiKey",
          "name": "subscription-key",
          "in": "query"
        }
      }
    },
    "security": [
      {
        "apiKeyHeader": [ ]
      },
      {
        "apiKeyQuery": [ ]
      }
    ]
  }

Sample FaUAPI DevOps Pipeline task success message

Sample FaUAPI DevOps Pipeline task error message