nelmio/api-doc-bundle v4.23.0

on PHP Packagist

Changelog

• Cache configuration option nelmio_api_doc.cache.item_id now automatically gets the area appended.

  nelmio_api_doc:
      cache:
          pool: app.cache
          item_id: nelmio_api_doc.docs
      areas:
          default: 
              ...
          area1:   
              ...

  Result in cache keys: nelmio_api_doc.docs.default & nelmio_api_doc.docs.area1 to be used respectively.
• Added cache configuration option per area.

  nelmio_api_doc:
      areas:
          default: # Manual cache configuration
              cache:
                  pool: app.cache
                  item_id: nelmio_api_doc.docs.default
              ...
          area1:   
              cache:
                  pool: app.cache
                  item_id: nelmio_api_doc.docs.area1
              ...

  Non-configured options will be inherited from nelmio_api_doc.cache.
• Fixed vendor extensions (x-*) from configuration not being outputted in the generated specification.

  nelmio_api_doc:
      documentation:
          info:
              title: 'My API'
              description: 'My API description'
              x-foo: 'bar'

  Now results in JSON specification:

  {
    ...
    "info": {
      "title": "API",
      "version": "1.0",
      "x-foo": "bar"
    },
    ...
  }

• Updated nullable enum handling to align with the behaviour of other object types. It now uses wraps nullable enums with oneOf instead of allOf.

What's Changed

• fix: invalid nullable enums with OAS 3.1 version by @bnowak in #2226
• Fix for using cache pools with multiple areas by @Brajk19 in #2232
• fix-2224: fix vendor extension being ignored by @DjordyKoert in #2230
• Prepare 4.23.0 by @DjordyKoert in #2238

New Contributors

• @bnowak made their first contribution in #2226

Full Changelog: v4.22.1...v4.23.0