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

Add example content to OData /datasets/{name}.svc 200 response #1122

Merged
merged 1 commit into from
Apr 13, 2024

Conversation

spwoodcock
Copy link
Contributor

@spwoodcock spwoodcock commented Apr 11, 2024

The problem this PR solves

The Service Document endpoint for datasets was missing an example 200 response:
https://docs.getodk.org/central-api-odata-endpoints/#id1

image

What was done to fix it

  • Previously we had: content: {}.
  • Updated to include actual content.

What has been done to verify that this works as intended?

Loaded the yaml into https://editor.swagger.io/

image

image

Why is this the best possible solution? Were any other approaches considered?

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

  • I assume this will be copied to getodk/docs, so is user facing.

Does this change require updates to the API documentation? If so, please update docs/api.md as part of this PR.

  • I think this PR template needs an update to reference docs/api.yaml ! 😄

Before submitting this PR, please make sure you have:

  • run make test and confirmed all checks still pass OR confirm CircleCI build passes
  • verified that any code from external sources are properly credited in comments or that everything is internally sourced

Copy link
Member

@lognaturel lognaturel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thank you!

Do you have a use for the service document? We have so far assumed it's only of value to clients that already use the OData standard (Excel, etc). It could be somewhat useful for arbitrary clients using submissions because of repeats but it feels less clear to me for entities.

@lognaturel lognaturel merged commit 18c7072 into getodk:master Apr 13, 2024
1 check passed
@spwoodcock spwoodcock deleted the docs/missing-entity-odata-200 branch April 13, 2024 04:52
@spwoodcock
Copy link
Contributor Author

No I don't use the service document, I just saw this when I was going through the docs 😄

I only use the data endpoint with filter and select params.

@matthew-white
Copy link
Member

I think this PR template needs an update to reference docs/api.yaml ! 😄

Haha good catch! I've opened #1124 to make that change. Thanks for making a note of that.

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

Successfully merging this pull request may close these issues.

3 participants