Badger Maps · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Badger Maps Users API

6 actions 6 updates update extends openapi/badger-maps-users-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Badger Maps's API. It is a proposal applied on top of the contract, not a document Badger Maps publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-operationx-apievangelist-agentic-accessx-apievangelist-providerx-apievangelist-enrichedx-apievangelist-source-contractx-apievangelist-source-urlx-apievangelist-artifactsx-idempotency

Targets 5

$.info
$.servers
$.paths['/profiles/'].get
$.paths['/login/'].post
$.paths['/search/users/'].get

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Badger Maps Users API
  version: 1.0.0
extends: openapi/badger-maps-users-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: apis.yml + repository artifacts; no provider content is modified
actions:
- target: $.info
  description: Record API Evangelist provenance and the runtime semantics the provider documents outside
    the spec.
  update:
    x-apievangelist-provider: badger-maps
    x-apievangelist-enriched: '2026-08-13'
    x-apievangelist-source-contract: openapi/_original/badger-maps-apiary-blueprint.apib
    x-apievangelist-source-url: https://jsapi.apiary.io/apis/badgerupdatedapi.apib
    x-apievangelist-artifacts:
      conventions: conventions/badger-maps-conventions.yml
      errors: errors/badger-maps-error-codes.yml
      data-model: data-model/badger-maps-data-model.yml
      lifecycle: lifecycle/badger-maps-lifecycle.yml
      rate-limits: rate-limits/badger-maps-rate-limits.yml
      webhooks: asyncapi/badger-maps-webhooks.yml
      sandbox: sandbox/badger-maps-sandbox.yml
- target: $.info
  description: Runtime constraints stated in the provider documentation but not expressible in the base
    spec.
  update:
    x-idempotency:
      supported: false
      note: No idempotency key; a retried create duplicates the record.
    x-pagination:
      supported: false
      note: Collection endpoints return bare JSON arrays with no cursor or page parameters.
    x-rate-limit:
      quota: 25000 requests per day per team
      headers: null
      note: No RateLimit-* response headers are published.
    x-versioning:
      scheme: uri-path
      current: v2
    x-access-gate:
      self_serve: false
      note: API/Developer Key must be enabled by Badger Maps support before it authenticates.
- target: $.servers
  description: Add the Apiary mock server as a documented non-production target.
  update: []
  x-note: Left empty deliberately - the Apiary mock host carries a rotating anonymous token and must be
    read at runtime from https://jsapi.apiary.io/apis/badgerupdatedapi.swagger.json (urls.mock). See sandbox/badger-maps-sandbox.yml.
- target: $.paths['/profiles/'].get
  description: Tag operation getProfile with its API Evangelist agent-access classification.
  update:
    x-apievangelist-operation: getProfile
    x-apievangelist-agentic-access: agentic-access/badger-maps-agentic-access.yml
- target: $.paths['/login/'].post
  description: Tag operation login with its API Evangelist agent-access classification.
  update:
    x-apievangelist-operation: login
    x-apievangelist-agentic-access: agentic-access/badger-maps-agentic-access.yml
- target: $.paths['/search/users/'].get
  description: Tag operation searchUsers with its API Evangelist agent-access classification.
  update:
    x-apievangelist-operation: searchUsers
    x-apievangelist-agentic-access: agentic-access/badger-maps-agentic-access.yml