Change Updates

Do not miss any Base API Docs changes, ever again

Subscribe to the Base API Docs changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /profile/get-id/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • profiles property Modified
        • customEvents property Modified
GET /profile/get/{username}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • profiles property Modified
        • customEvents property Modified
GET /terms
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, term, original, definition, locale, approved, base_id, author_id, deleted, flags, category, images, key, author properties Modified
        • Properties are now required
          Breaking
      • versions property Modified
        • id, term, original, definition, locale, approved, base_id, author_id, deleted, flags, category, images, key, author properties Modified
          • Properties are now required
            Breaking
GET /terms/search/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, term, original, definition, locale, approved, base_id, author_id, deleted, flags, category, images, key, author properties Modified
        • Properties are now required
          Breaking
      • versions property Modified
        • id, term, original, definition, locale, approved, base_id, author_id, deleted, flags, category, images, key, author properties Modified
          • Properties are now required
            Breaking
GET /user/social-lookup/{provider}/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • text/plain content type Added
13 structure changes including:
13 Additions
Added 13
GET /calendar/today
GET /calendar/{date}
GET /inclusive
GET /inclusive/search/{id}
GET /nouns
GET /nouns/search/{id}
GET /profile/get-id/{id}
GET /profile/get/{username}
GET /sources
GET /sources/{id}
GET /terms
GET /terms/search/{id}
GET /user/social-lookup/{provider}/{identifier}
3 structure changes including:
1 Addition
2 Modifications
Modified 2
GET /pronouns
  • Operation is no longer In Development
  • Operation is now beta
GET /pronouns/{pronoun}
  • Operation is no longer In Development
  • Operation is now beta
Added 1
GET /banner/{pronoun}.png
1 structure change including:
1 Modification
Modified 1 Breaking
GET /pronouns/{pronoun}
  • Path went from /pronouns/{promoun} to /pronouns/{pronoun} (same operationId)
  • Path
  • promoun path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • pronoun path parameter Added
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
Api key headerauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /pronouns/{promoun}
1 structure change including:
1 Modification
Modified 1 Breaking
GET /pronouns
  • Operation is now In Development
  • Authentication
  • Api key header authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
2 structure changes including:
1 Addition
1 Modification
Modified 1 Breaking
GET /pronouns
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pronunciations property Modified
        • Type went from object | null to object
          Breaking
      • aliases, examples properties Modified
        • Type went from array[string] | null to array[string]
          Breaking
      • history, thirdForm, smallForm, sourcesInfo properties Modified
        • Type went from string | null to string
          Breaking
  • Authentication
  • Api key header authentication method Added
Added 1
Api key headerauthentication method
1 structure change including:
1 Modification
Modified 1 Breaking
GET /pronouns
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id, pronoun_set, display_name, created_at, updated_at properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • canonicalName, description, normative, morphemes, pronunciations, plural, pluralHonorific, aliases, history, pronounceable, thirdForm, smallForm, sourcesInfo, nullPronoun, examples, name properties Added