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

API documentation inconsistencies #1118

Closed
alxndrsn opened this issue Mar 27, 2024 · 2 comments · Fixed by #1132
Closed

API documentation inconsistencies #1118

alxndrsn opened this issue Mar 27, 2024 · 2 comments · Fixed by #1132
Assignees
Labels
documentation API docs, readme, developer docs

Comments

@alxndrsn
Copy link
Contributor

There are two API endpoints which are documented, but do not seem to correspond to real routes in code:

GET    /v1/test/:key/projects/:id/forms/:id/attachments/:name
PATCH  /v1/projects/:id/forms/:id/draft/submissions/:id/attachments/:name

cc @matthew-white

@matthew-white matthew-white added the documentation API docs, readme, developer docs label Mar 27, 2024
@matthew-white
Copy link
Member

GET    /v1/test/:key/projects/:id/forms/:id/attachments/:name

It looks like this should be .../draft/attachments/:name:

service.get('/test/:key/projects/:projectId/forms/:id/draft/attachments/:name', endpoint((container, { params }, request, response) => {

PATCH  /v1/projects/:id/forms/:id/draft/submissions/:id/attachments/:name

I'm pretty sure we only POST to submission attachment endpoints, not PATCH.

service.post(
`${base}/:instanceId/attachments/:name`,

dataOutputs('/projects/:projectId/forms/:formId/draft/submissions', true, (params, Forms) =>

@github-project-automation github-project-automation bot moved this to 🕒 backlog in ODK Central Mar 27, 2024
@matthew-white matthew-white self-assigned this Apr 9, 2024
@matthew-white matthew-white moved this from 🕒 backlog to ✏️ in progress in ODK Central Apr 26, 2024
@matthew-white
Copy link
Member

PATCH  /v1/projects/:id/forms/:id/draft/submissions/:id/attachments/:name

I'm actually not seeing this one in the docs anywhere. Maybe we fixed it already? @alxndrsn, let me know if I'm missing something and you still see it in the docs.

matthew-white added a commit that referenced this issue Apr 26, 2024
matthew-white added a commit that referenced this issue Apr 29, 2024
@github-project-automation github-project-automation bot moved this from ✏️ in progress to ✅ done in ODK Central Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation API docs, readme, developer docs
Projects
Status: ✅ done
Development

Successfully merging a pull request may close this issue.

2 participants