Skip to content

Releases: spryker/documentation-generator-open-api

1.5.0

18 Jul 10:38
Compare
Choose a tag to compare

Included commits: 1.4.3...1.5.0

Improvements

  • Improved metadata information inclusion in the schema generator.
  • Introduced SchemaData.example transfer field.
  • Introduced SchemaProperty.example transfer field.
  • Introduced SchemaProperty.description transfer field.

1.4.3

19 Jun 14:22
Compare
Choose a tag to compare

Included commits: 1.4.2...1.4.3

Improvements

  • Adjusted ControllerAnnotationsContextExpanderPlugin::expand(), RelationshipPluginAnnotationsContextExpanderPlugin::expand() and CustomRouteControllerAnnotationsContextExpanderPlugin::expand() so it handles responses with 204 code.

1.4.2

06 May 14:03
Compare
Choose a tag to compare

Included commits: 1.4.1...1.4.2

Improvements

  • Added PHPStan 1.10.* support.

1.4.1

07 Mar 08:13
Compare
Choose a tag to compare

Included commits: 1.4.0...1.4.1

Fixes

  • Fixed DocumentationGeneratorOpenApiConfig::getAnnotationSourceDirectories() so it returns correct directory patterns for core annotation sources.

1.4.0

11 Jul 14:28
Compare
Choose a tag to compare

Included commits: 1.3.2...1.4.0

Improvements

  • Adjusted DocumentationGeneratorOpenApiSchemaFormatterPlugin::format() with OpenApiSchemaFormatterPluginInterface plugin stack execution.

Adjustments

  • Added DocumentationGeneratorOpenApiExtension module to dependencies.

1.3.2

23 Jan 13:56
Compare
Choose a tag to compare

Included commits: 1.3.1...1.3.2

Fixes

  • Adjusted DocumentationGeneratorOpenApiSchemaFormatterPlugin::format() so it formats data in an array instead of stdClass() object which is not supported by OpenAPI.

1.3.1

18 Jan 12:46
Compare
Choose a tag to compare

Included commits: 1.3.0...1.3.1

Fixes

  • Fixed documentation generation bug for patch endpoints.

1.3.0

27 Dec 10:39
Compare
Choose a tag to compare

Included commits: 1.2.0...1.3.0

Improvements

  • Introduced Annotation.summary transfer field.
  • Adjusted DocumentationGeneratorOpenApiSchemaFormatterPlugin so now it gets summary from the transfer field instead of the array.

1.2.0

23 Dec 15:42
Compare
Choose a tag to compare

Included commits: 1.1.0...1.2.0

Fixes

  • Improved DocumentationGeneratorOpenApiSchemaFormatterPlugin so now it sets correct protocol schema.

1.1.0

17 Nov 14:43
Compare
Choose a tag to compare

Included commits: 1.0.0...1.1.0

Improvements

  • Introduced GlueResourceMethodConfiguration.isSnakeCased transfer field.
  • Introduced Annotation.requestAttributesClassName transfer field.
  • Adjusted DocumentationGeneratorOpenApiSchemaFormatterPlugin so now supports both CamelCase and snake_case naming conventions for request and response data.

Fixes

  • Adjusted DocumentationGeneratorOpenApiSchemaFormatterPlugin so now it correctly generates documentation for request data.