Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump @cparra/apexdocs from 1.15.0 to 2.13.1 #96

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Mar 1, 2023

Bumps @cparra/apexdocs from 1.15.0 to 2.13.1.

Release notes

Sourced from @​cparra/apexdocs's releases.

v2.13.0

Improvements

Support for the @ignore tag.

An @ignore tag can now be used in any ApexDoc to have the annotated code be ignored during the documentation creation process.

Improved error handling

When dealing with uncaught exceptions, the process now exits with an exit code of 1

Upgraded to use the latest version of the Apex Reflection library, which support for the latest Apex improvements introduced during Winter 23

General improvements when generating OpenApi definitions

v2.12.0

General Improvements

Upgraded to latest version of the Apex Reflection library, which now ignores ApexDoc blocks in unexpected places of the code. This should improve the noise when parsing files with regular comments throughout the source code that are not meant to be apex docs, but still use the ApexDoc comment syntax /** ... */

OpenApi Improvements

RestResource annotations ending in a wildcard character are now cleanedup during the generation of the OpenApi definition file. e.g /Accounts/* will now simply be /Accounts/

2.11.0

Grouping improvements

OpenApi definition file improvements

  • When parsing an HTTP related method, if no ApexDocs are given to override the request body definition, the method's arguments will be used to form the OpenApi's request body section for that endpoint
  • Similarly, when no ApexDocs are given to override the response body, the method's return type will be used to form the response corresponding to the 200 status code.

v2.10.0

General updates

Namespace support

A new property has been added to allow for a package namespace to be specified. When set, the generated files will be created with the prepended namespace.

When generating an OpenApi definition, the namespace will be added to the file's server URL section, complying with how REST APIs for managed packages are exposed by Salesforce.

Upgraded to use the latest version of the Apex Reflection library

This version includes support for methods named void, which (for some reason) is allowed by Apex even though it is a keyword that should be reserved

OpenApi generator updates

... (truncated)

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [@cparra/apexdocs](https://github.com/cesarParra/apexdocs) from 1.15.0 to 2.13.1.
- [Release notes](https://github.com/cesarParra/apexdocs/releases)
- [Commits](https://github.com/cesarParra/apexdocs/commits)

---
updated-dependencies:
- dependency-name: "@cparra/apexdocs"
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Mar 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants