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

Create a more formal "Specification" Markdown file for our existing resource-type and location oriented API specs #289

Closed
cookeac opened this issue Apr 7, 2022 · 2 comments
Labels
documentation enhancement New feature or request

Comments

@cookeac
Copy link
Collaborator

cookeac commented Apr 7, 2022

The current API specs are documented in OpenAPI specification, but the other expectations for them are in the Wiki.
The Wiki is not versioned, so changes to the expectations are not captured from release to release.

We should create a specification document as was done for the streaming API, and save this as a .md file in the repository. This could make use of content from the Wiki (for instance, fault tolerant reader pattern, identifer types, how batch methods work).

@cookeac cookeac added enhancement New feature or request documentation labels Apr 7, 2022
@stale
Copy link

stale bot commented Jul 6, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale-issue Identifies that an issue is stale and will be closed unless reactivated. label Jul 6, 2022
@cookeac cookeac removed the stale-issue Identifies that an issue is stale and will be closed unless reactivated. label Jul 6, 2022
@cookeac
Copy link
Collaborator Author

cookeac commented Sep 8, 2022

Resolved by #311 - see /docs/location-based-api.md

@cookeac cookeac closed this as completed Sep 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant