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

clarify Socrata APIs referenced in readme and wiki documentation #9

Closed
ryan-hall opened this issue Sep 23, 2019 · 1 comment
Closed

Comments

@ryan-hall
Copy link
Contributor

ryan-hall commented Sep 23, 2019

Write operations to Socrata datasets with the Socrata Open Data API differ from write operations with the more recent Data Management API. Specifying which API this library uses helps prevent user confusion.

Adding something like:

Note: This library supports writing directly to datasets with the Socrata Open Data API. For datasets with one or more data transformations applied to the schema through the Socrata Data Management Experience (the user interface for creating datasets), use the Socrata Data Management API to apply those same transformations to all updates. For more details on when to use SODA vs the Socrata Data Management API, see the Data Management API documentation

to the readme and wiki would help clarify expectations when publishing to Socrata.

I'll open a PR with changes.

ryan-hall added a commit to ryan-hall/PhpSoda that referenced this issue Sep 23, 2019
allejo added a commit that referenced this issue Sep 23, 2019
issue #9: update readme with additional Socrata API documentation
@allejo
Copy link
Owner

allejo commented Sep 23, 2019

Thanks for the PR!

@allejo allejo closed this as completed Sep 23, 2019
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

No branches or pull requests

2 participants