From 7d021388fbf1cae3fef6a1ff21c6c76709a5be1f Mon Sep 17 00:00:00 2001 From: Matt Clark <36630558+mattclark-zerogravit@users.noreply.github.com> Date: Wed, 24 Jan 2024 10:50:43 +0000 Subject: [PATCH] APIS-6689: update documentation to remove requires trust Co-authored-by: Andy Spaven (#106) --- app/resources/api-definition-schema.json | 5 ----- docs/api-definition.md | 1 - 2 files changed, 6 deletions(-) diff --git a/app/resources/api-definition-schema.json b/app/resources/api-definition-schema.json index 2f70590..1517a18 100644 --- a/app/resources/api-definition-schema.json +++ b/app/resources/api-definition-schema.json @@ -63,11 +63,6 @@ "type": "boolean", "default": false }, - "requiresTrust": { - "description": "DEPRECATED. This has been superseded by Private API access", - "type": "boolean", - "default": false - }, "categories": { "description": "The list of service groups the API will be categorised by.", "type": "array", diff --git a/docs/api-definition.md b/docs/api-definition.md index 942f333..f6f7c55 100644 --- a/docs/api-definition.md +++ b/docs/api-definition.md @@ -23,7 +23,6 @@ Details of the API | --- | --- | --- | --- | --- | | `name` | _string_ | Required | ^[A-Z]{1}.*$ | The name for the API (title case i.e. Individual Benefits, not Individual benefits). | | `versions` | _object[]_ | Required | [versions](#versions) | A list of the different versions of the API | -| `requiresTrust` | _boolean_ | Optional | False (default) | DEPRECATED. This has been superseded by Private API access | | `context` | _string_ | Required | ^[a-z]+[a-z/\-]{4,}$ | The unique context for the API. This should be consistent with the HMRC Domain Model. See [API Domain Model](https://confluence.tools.tax.service.gov.uk/display/ApiPlatform/HMRC%27s+API+Domain+Model) | | `isTestSupport` | _boolean_ | Optional | False (default) | Categorises the API as being a Test Support API | | `categories` | _string[]_ | Optional | EXAMPLE
AGENTS
BUSINESS_RATES
CHARITIES
CONSTRUCTION_INDUSTRY_SCHEME
CORPORATION_TAX
CUSTOMS
ESTATES
HELP_TO_SAVE
INCOME_TAX_MTD
LIFETIME_ISA
MARRIAGE_ALLOWANCE
NATIONAL_INSURANCE
PAYE
PENSIONS
PRIVATE_GOVERNMENT
RELIEF_AT_SOURCE
SELF_ASSESSMENT
STAMP_DUTY
TRUSTS
VAT
VAT_MTD
OTHER | The list of service groups the API will be categorised by. |