Skip to content

Conversation

@dependabot
Copy link
Contributor

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

Bumps @cparra/apexdocs from 2.3.0 to 2.12.0.

Release notes

Sourced from @​cparra/apexdocs's releases.

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

Ability to specify the name of the output file through a new CLI argument

Ability to override the schema references when referencing custom classes from RestResource files.

v2.9.0

OpenApi Definition support

ApexDocs now support creating an OpenApi definition file for the @RestResources classes in your source code. See the Generating OpenApi REST Definitions section of the README file for full details and usage.

v2.8.1

Upgrading to use the latest version of the Apex Reflection library

v2.8.0

Inheritance support

... (truncated)

Commits
  • f070832 Merge pull request #66 from cesarParra/2.12_rc
  • 627761d 2.12.0 release
  • 99b4ffa Merge pull request #65 from cesarParra/2.11.0_rc
  • 4783647 2.11.0 Release
  • 6948906 Code cleanup
  • 0123653 Grouping improvements.
  • 26241ce Working rough draft of response body parsing using method parameters when no ...
  • 0a6c236 Working rough draft of request body parsing using method parameters when no A...
  • 65dcb79 Refactoring
  • 798fe4b Merge pull request #63 from cesarParra/2.10.0_release_candidate
  • Additional commits viewable in compare view

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 2.3.0 to 2.12.0.
- [Release notes](https://github.com/cesarParra/apexdocs/releases)
- [Commits](cesarParra/apexdocs@v2.3.0...v2.12.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Jan 1, 2023
@codecov-commenter
Copy link

Codecov Report

Base: 98.92% // Head: 98.40% // Decreases project coverage by -0.52% ⚠️

Coverage data is based on head (0c58115) compared to base (5234b5e).
Patch coverage: 95.65% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #96      +/-   ##
==========================================
- Coverage   98.92%   98.40%   -0.53%     
==========================================
  Files           3        3              
  Lines         186      188       +2     
==========================================
+ Hits          184      185       +1     
- Misses          2        3       +1     
Impacted Files Coverage Δ
force-app/main/default/classes/Safely.cls 97.43% <50.00%> (-1.25%) ⬇️
force-app/main/default/classes/CanTheUser.cls 98.83% <100.00%> (ø)
...e-app/main/default/tests/ApexRecipes_TestUtils.cls 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Feb 1, 2023

Superseded by #103.

@dependabot dependabot bot closed this Feb 1, 2023
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/cparra/apexdocs-2.12.0 branch February 1, 2023 11:05
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.

2 participants