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

[Doc] Basic API endpoints & usage #38

Open
samqi opened this issue Dec 4, 2023 · 1 comment
Open

[Doc] Basic API endpoints & usage #38

samqi opened this issue Dec 4, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@samqi
Copy link

samqi commented Dec 4, 2023

Problem to solve

  1. What project/feature(s) affected?
    Any project with plone rest API turned on.
  2. Is there a problem with a specific document, or a feature/process that's not addressed sufficiently in docs?
    It's not clear which are regular practical endpoints to be used.
  3. Any other ideas or requests?
    Plone REST API does not document the customised dexterity content types we use.

Further details

  1. Content: What audience is it intended for?
  • Sinar folks,
  • Partners who may need to utilise plone rest api

Proposal

Update into wiki

Who can address the issue

Anyone with knowledge about Plone & REST API

Other links/references

Plone REST API doc page

@samqi samqi added the documentation Improvements or additions to documentation label Dec 4, 2023
@samqi samqi self-assigned this Dec 4, 2023
@samqi samqi changed the title [Doc [Doc] Basic API endpoints & usage Dec 4, 2023
@samqi
Copy link
Author

samqi commented Dec 4, 2023

Very basic barebones API documentation updated into WIki at https://github.com/Sinar/sinarngo/wiki/Plone-REST-API-usage

Wiki details are not specific due to keeping in mind, that different specific sites using these packages may have different contexts so no specifics are added other than generic information for now.

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

No branches or pull requests

1 participant