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

Document new API in OCP\Authentication #11282

Merged
merged 1 commit into from Dec 4, 2023
Merged

Conversation

come-nc
Copy link
Contributor

@come-nc come-nc commented Nov 13, 2023

☑️ Resolves

🖼️ Screenshots

Screenshot_20231113_151951

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
@come-nc come-nc added this to the Nextcloud 28 milestone Nov 13, 2023
@come-nc come-nc self-assigned this Nov 13, 2023
@ChristophWurst
Copy link
Member

New APIs should have a persistent place, e.g. somewhere we already have docs about authentication.

The upgrade docs purpose is to help maintains of existing apps keep their app alive for the next major. They only need to know about stuff that was changed or removed.

In other words, someone potentially developing against this new API will have a hard time finding docs.

Hope this makes sense.

@come-nc
Copy link
Contributor Author

come-nc commented Nov 13, 2023

New APIs should have a persistent place, e.g. somewhere we already have docs about authentication.

The upgrade docs purpose is to help maintains of existing apps keep their app alive for the next major. They only need to know about stuff that was changed or removed.

In other words, someone potentially developing against this new API will have a hard time finding docs.

Hope this makes sense.

In https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/security.html ?

Most of OCP is not documented outside of https://nextcloud-server.netlify.app, which already lists https://nextcloud-server.netlify.app/classes/ocp-authentication-token-iprovider and https://nextcloud-server.netlify.app/classes/ocp-authentication-token-itoken

@ChristophWurst
Copy link
Member

In https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/security.html ?

Sounds good!

The current state is not great, yeah. We have to start somewhere …

@come-nc
Copy link
Contributor Author

come-nc commented Dec 4, 2023

/backport to stable28

@come-nc
Copy link
Contributor Author

come-nc commented Dec 4, 2023

Merging this as it’s still better than nothing and #11283 will conflict if merged first.

@come-nc come-nc merged commit b92ce24 into master Dec 4, 2023
8 checks passed
@come-nc come-nc deleted the feat/document-ocp-itoken branch December 4, 2023 08:09
@AndyScherzinger
Copy link
Member

@come-nc I created a separate ticket to docuemnt the newly added APIs on a to-be created dev manual page, see #11352

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants