Docs: Replace `code.code` with `code.authorizationCode` #220

menewman · 2023-08-15T18:31:30Z

Summary

Now, the documentation for model methods getAuthorizationCode and revokeAuthorizationCode consistently refer to code.authorizationCode rather than code.code.

Linked issue

Closes #216.

Involved parts of the project

Documentation only -- specifically for revokeAuthorizationCode and getAuthorizationCode.

Added tests?

N/A

OAuth2 standard

N/A

Reproduction

N/A

# Conflicts: # lib/grant-types/refresh-token-grant-type.js # package-lock.json

@dsschiramm

Merge pull request node-oauth#109 from dsschiramm/development Thanks to @dsschiramm

…applicable

Bumps [sinon](https://github.com/sinonjs/sinon) from 15.1.0 to 15.2.0. - [Release notes](https://github.com/sinonjs/sinon/releases) - [Changelog](https://github.com/sinonjs/sinon/blob/main/docs/changelog.md) - [Commits](sinonjs/sinon@v15.1.0...v15.2.0) --- updated-dependencies: - dependency-name: sinon dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

…isify-any Merge pull request node-oauth#190 from node-oauth/refactor-native-promises

Bumps [eslint](https://github.com/eslint/eslint) from 8.42.0 to 8.44.0. - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](eslint/eslint@v8.42.0...v8.44.0) --- updated-dependencies: - dependency-name: eslint dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

…yarn/eslint-8.44.0 build(deps-dev): bump eslint from 8.42.0 to 8.44.0

Bumps [eslint](https://github.com/eslint/eslint) from 8.42.0 to 8.46.0. - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](eslint/eslint@v8.42.0...v8.46.0) --- updated-dependencies: - dependency-name: eslint dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

…yarn/eslint-8.46.0 build(deps-dev): bump eslint from 8.42.0 to 8.46.0

…yarn/sinon-15.2.0 build(deps-dev): bump sinon from 15.1.0 to 15.2.0

Bumps [sinon](https://github.com/sinonjs/sinon) from 15.1.0 to 15.2.0. - [Release notes](https://github.com/sinonjs/sinon/releases) - [Changelog](https://github.com/sinonjs/sinon/blob/main/docs/changelog.md) - [Commits](sinonjs/sinon@v15.1.0...v15.2.0) --- updated-dependencies: - dependency-name: sinon dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

@shrihari-prakash

…e-oauth#202 Merge pull request node-oauth#209 from shrihari-prakash/verify-scope-fix thanks to @shrihari-prakash

…yarn/sinon-15.2.0 build(deps-dev): bump sinon from 15.1.0 to 15.2.0

menewman · 2023-08-15T18:33:19Z

@jankapunkt - I'm submitting what I believe is the correct documentation change, but I'm not quite sure how to generate/build the docs (haven't worked with Sphinx before and don't see an obvious "build docs" commands in the NPM package scripts). If you have any advice on building/testing that I should be doing for this, please lmk and I'd be happy to do so

…n-docs

jankapunkt · 2023-08-16T04:49:03Z

Hey @menewman thanks a lot for the PR, this is basically correct but with the exception, that we have a branching issue with git here 🙈

You did nothing wrong, since you were following the contribution guidelines! The issue we have is, that the docs are built on an external platform (readthedocs.io) and are by default pointing to the master branch. This is not covered in the contribution guidelines and I'm sorry for that, since this means extra work for you due to missing information (I will update the guidelines).

Background

Since we have not merged development into master yet, we have the uncomfortable situation of merging things that don't belong to your opened issue #216 and that should not be merged before the stable release 5.0.0 is out.

I even tried to resolve this but this just gets out of hand with such a big branch difference.

Solution

So I looked at your fork and here is how we can fix this the easiest way:

close this issue
checkout the master branch (git checkout master) on your fork
git pull
being on master branch, checkout a new branch git checkout -b docs-fix-code-parameters
do your changes and commit
push to git push origin docs-fix-code-parameters
open a new pull request but target the master branch, instead of development
now, there should only be changes in the docs folder detected by the diff algorithm

menewman · 2023-08-16T08:42:26Z

No worries at all -- and thank you for the detailed steps! I'm happy to re-submit the PR with a different branch target 👍

daniel.santos and others added 30 commits December 18, 2021 18:27

refactor: Remove util.inherits node-oauth#70

3a7e198

refactor: Remove util.inherits node-oauth#70

9460888

refactor: Remove util.inherits node-oauth#70

60afc18

change Object.assign to spread operator

c73b5b2

captureStackTrace removed from OAuthError constructor

1d7b401

fix super constructor call OAuthError

186d85f

OAuthError unit test

ab48e15

revert package.json

c2e6409

Merge branch 'development-upstream' into development

6536fe2

# Conflicts: # lib/grant-types/refresh-token-grant-type.js # package-lock.json

Merge branch 'development' into development

bb96022

Merge branch 'master' into development

f2f6c21

Update authorization-code-grant-type.js

e00a630

refactor(deps): remove util.inherits node-oauth#70

9fd04f6

Merge pull request node-oauth#109 from dsschiramm/development Thanks to @dsschiramm

breaking(deps): remove bluebird and promisify-any

126ceff

docs: add 5.0.0 to changelog

5454497

docs: add 5.x note to readme

085b13d

docs: add 5.x to security policy

2627848

build(core): bump node 14 to 16

cf2adba

fix: replace Promise. calls in async functions with native behaviour

2563e7b

fix(tests): replace Promise. calls with native async behaviour where …

e1fdc23

…applicable

Merge branch 'development' into dependabot/npm_and_yarn/sinon-15.2.0

0448856

refactor: use native promises and async/await, drop bluebird and prom…

3d766a7

…isify-any Merge pull request node-oauth#190 from node-oauth/refactor-native-promises

Merge branch 'development' into dependabot/npm_and_yarn/sinon-15.2.0

64da4eb

Merge branch 'development' into dependabot/npm_and_yarn/eslint-8.44.0

ececdd1

Merge pull request node-oauth#195 from node-oauth/dependabot/npm_and_…

7b940ec

…yarn/eslint-8.44.0 build(deps-dev): bump eslint from 8.42.0 to 8.44.0

Merge branch 'development' into dependabot/npm_and_yarn/eslint-8.46.0

dd2f9b8

Merge branch 'development' into dependabot/npm_and_yarn/sinon-15.2.0

18caaba

jankapunkt and others added 10 commits August 2, 2023 16:27

Merge pull request node-oauth#201 from node-oauth/dependabot/npm_and_…

35e056d

…yarn/eslint-8.46.0 build(deps-dev): bump eslint from 8.42.0 to 8.46.0

Merge pull request node-oauth#193 from node-oauth/dependabot/npm_and_…

4b0459e

…yarn/sinon-15.2.0 build(deps-dev): bump sinon from 15.1.0 to 15.2.0

Marked verifyScope function as optional in model types.

68d01ad

Fix PR comments.

6c4f73a

Merge branch 'development' into verify-scope-fix

1718df3

types: marked verifyScope function as optional node-oauth#209 fix nod…

e29410b

…e-oauth#202 Merge pull request node-oauth#209 from shrihari-prakash/verify-scope-fix thanks to @shrihari-prakash

Merge pull request node-oauth#206 from node-oauth/dependabot/npm_and_…

320f947

…yarn/sinon-15.2.0 build(deps-dev): bump sinon from 15.1.0 to 15.2.0

Docs: Replace code.code with code.authorizationCode

176e49c

Also update sample implementation of getAuthorizationCode

b6ea526

jankapunkt changed the base branch from development to master August 16, 2023 04:32

Merge branch 'master' into fix-replace-code-with-authorization-code-i…

ad76316

…n-docs

jankapunkt mentioned this pull request Aug 16, 2023

Contribution guidelines do not cover how to PR fixes for docs #221

Open

menewman closed this Aug 16, 2023

menewman deleted the fix-replace-code-with-authorization-code-in-docs branch August 16, 2023 08:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Replace `code.code` with `code.authorizationCode` #220

Docs: Replace `code.code` with `code.authorizationCode` #220

menewman commented Aug 15, 2023

menewman commented Aug 15, 2023

jankapunkt commented Aug 16, 2023 •

edited

Loading

menewman commented Aug 16, 2023

Docs: Replace code.code with code.authorizationCode #220

Docs: Replace code.code with code.authorizationCode #220

Conversation

menewman commented Aug 15, 2023

Summary

Linked issue

Involved parts of the project

Added tests?

OAuth2 standard

Reproduction

menewman commented Aug 15, 2023

jankapunkt commented Aug 16, 2023 • edited Loading

menewman commented Aug 16, 2023

Docs: Replace `code.code` with `code.authorizationCode` #220

Docs: Replace `code.code` with `code.authorizationCode` #220

jankapunkt commented Aug 16, 2023 •

edited

Loading