Rest api design #601
Merged
Rest api design #601
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bumps [zod](https://github.com/colinhacks/zod) from 3.22.2 to 3.22.3. - [Release notes](https://github.com/colinhacks/zod/releases) - [Changelog](https://github.com/colinhacks/zod/blob/master/CHANGELOG.md) - [Commits](colinhacks/zod@v3.22.2...v3.22.3) --- updated-dependencies: - dependency-name: zod dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]>
our logic for how we interact with the manifest not really appropriate for a DRF model ViewSet. so we had a bunch of unused endpoints that was autoamtically created by DRF when we really just needed to RetreiveAPIView
…tablish the resource hierarchy in the RESTful api design we want to establish that these are RCRA related resources that are not central to the haztrak application itself or another environmental act like the clean water act (CWA) which may have their own 'manifest' or definition of an 'EPA site'
…rofile* endpoints
…to generated docs
github-actions
bot
added
client
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Removes a (surprising amount) of unused handler functions (django calls them views) from our rest API design. we also add the 'rcra' accronym (for Resource Conservation and Recovery) into our RESTful API url pattern to roughly signify that a resource is
siteorepaIdresource in those acts, although I'm not sure). This clarifies and makes the app a little more extensible if that information was added at a later date.We also update the auto generated OpenAPI page to better reflect the organization of resources, and add useful details about the requests/responses of our API endpoints.
Issue ticket number and link
Checklist