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

README and docs/source/index.rst do not agree on REST API #358

Open
jwodder opened this issue May 4, 2023 · 4 comments
Open

README and docs/source/index.rst do not agree on REST API #358

jwodder opened this issue May 4, 2023 · 4 comments
Labels
documentation Changes only affect the documentation

Comments

@jwodder
Copy link
Collaborator

jwodder commented May 4, 2023

Currently (as of commit 9351c88), the descriptions in the REST API in README.rst and docs/source/index.rst do not completely agree. In particular:

  • Only docs/source/index.rst documents the following endpoints:
    • /projects/{project_id}/subjects/{subject_id}/instruments
    • /projects/{project_id}/subjects/{subject_id}/derivatives/
    • /subjects
    • /subjects/{subject_id}
    • /dataelements
    • /dataelements/{dataelement_id}
  • Only docs/source/index.rst states that /projects and /projects/{project_id} can take a fields query parameter
@jwodder jwodder added the documentation Changes only affect the documentation label May 4, 2023
@yarikoptic
Copy link
Member

after the difference figured out and fixed -- we should "deprecate" README.md as a copy of docs/source/index.rst and keep detailed info within docs (and probably post rendered version on RTD). Ref: #357 (comment)

@yarikoptic
Copy link
Member

apparently there is an RTD project already setup and there is https://pynidm.readthedocs.io

@jwodder
Copy link
Collaborator Author

jwodder commented May 5, 2023

@yarikoptic The docs build is failing, though, so the updates in #357 aren't taking effect. I would need access to the project on Read the Docs in order to figure out what's going on.

@jwodder
Copy link
Collaborator Author

jwodder commented May 5, 2023

The docs are building again now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation
Projects
None yet
Development

No branches or pull requests

2 participants