Ordnance Survey · OpenAPI Overlay 1.0.0

API Evangelist enhancements for OS Linked Identifiers API

5 actions 5 updates documentation extends openapi/ordnance-survey-linked-identifiers-openapi.json
Generated by API Evangelist Written by API Evangelist tooling for Ordnance Survey's API. It is a proposal applied on top of the contract, not a document Ordnance Survey publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

operationIdx-apievangelist-notex-apievangelist-providerx-apievangelist-provider-idx-apievangelist-apix-apievangelist-documentationx-apievangelist-artifactsx-apievangelist-rate-limit

Targets 5

$.info
$.paths['/featureTypes/{featureType}/{id}'].get
$.paths['/identifierTypes/{identifierType}/{id}'].get
$.paths['/identifiers/{id}'].get
$.paths['/productVersionInfo/{correlationMethod}'].get

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for OS Linked Identifiers API
  version: 1.0.0
  x-generated: '2026-07-26'
  x-method: generated
  x-description: Non-destructive enhancements layered over the Ordnance Survey OpenAPI harvested in openapi/ordnance-survey-linked-identifiers-openapi.json.
    The original document is never mutated.
extends: openapi/ordnance-survey-linked-identifiers-openapi.json
actions:
- target: $.info
  update:
    x-apievangelist-provider: Ordnance Survey
    x-apievangelist-provider-id: ordnance-survey
    x-apievangelist-api: OS Linked Identifiers API
    x-apievangelist-documentation: https://docs.os.uk/os-apis/accessing-os-apis/os-linked-identifiers-api
    x-apievangelist-artifacts:
      authentication: authentication/ordnance-survey-authentication.yml
      conventions: conventions/ordnance-survey-conventions.yml
      errors: errors/ordnance-survey-problem-types.yml
      lifecycle: lifecycle/ordnance-survey-lifecycle.yml
      rate_limits: rate-limits/ordnance-survey-rate-limits.yml
      conformance: conformance/ordnance-survey-conformance.yml
    x-apievangelist-rate-limit: 600 transactions per minute per API per live-mode project; 50 in development
      mode
- target: $.paths['/featureTypes/{featureType}/{id}'].get
  update:
    operationId: getLinkedIdentifiersByFeatureType
    x-apievangelist-note: operationId added by API Evangelist; the published OS document omits it.
- target: $.paths['/identifierTypes/{identifierType}/{id}'].get
  update:
    operationId: getLinkedIdentifiersByIdentifierType
    x-apievangelist-note: operationId added by API Evangelist; the published OS document omits it.
- target: $.paths['/identifiers/{id}'].get
  update:
    operationId: getLinkedIdentifiers
    x-apievangelist-note: operationId added by API Evangelist; the published OS document omits it.
- target: $.paths['/productVersionInfo/{correlationMethod}'].get
  update:
    operationId: getLinkedIdentifiersProductVersionInfo
    x-apievangelist-note: operationId added by API Evangelist; the published OS document omits it.