-
Notifications
You must be signed in to change notification settings - Fork 182
Add File Move Operation to PATCH Endpoint (only the relevant commits) #191
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
Open
mairas
wants to merge
5
commits into
coddingtonbear:main
Choose a base branch
from
mairas:move-only
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+475
−52
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
58f70cf
feat: implement file move operation
duquesnay f97a004
refactor: simplify PATCH endpoint validation logic
duquesnay 7fbaf0a
feat: add path validation security and consistent error handling to f…
duquesnay 3f6b44f
docs: Add OpenAPI documentation for file move operation
duquesnay 6564048
Implement a custom MOVE HTTP method
mairas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| { | ||
| tags: [ | ||
| 'Vault Files', | ||
| ], | ||
| summary: 'Move a file to a new location in your vault.\n', | ||
| description: 'Moves a file from its current location to a new location specified in the Destination header. This operation preserves file history and updates internal links. The destination path must be provided in the Destination header following WebDAV conventions.\n', | ||
| parameters: [ | ||
| { | ||
| name: 'Destination', | ||
| 'in': 'header', | ||
| description: 'The new path for the file (relative to your vault root). Path must not contain ".." or start with "/" for security reasons.\n', | ||
| required: true, | ||
| schema: { | ||
| type: 'string', | ||
| format: 'path', | ||
| }, | ||
| }, | ||
| ], | ||
| responses: { | ||
| '201': { | ||
| description: 'File successfully moved', | ||
| content: { | ||
| 'application/json': { | ||
| schema: { | ||
| type: 'object', | ||
| properties: { | ||
| message: { | ||
| type: 'string', | ||
| example: 'File successfully moved', | ||
| }, | ||
| oldPath: { | ||
| type: 'string', | ||
| example: 'folder/file.md', | ||
| }, | ||
| newPath: { | ||
| type: 'string', | ||
| example: 'another-folder/file.md', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '400': { | ||
| description: 'Bad request - Missing Destination header, invalid destination path, or path traversal attempt.\n', | ||
| content: { | ||
| 'application/json': { | ||
| schema: { | ||
| '$ref': '#/components/schemas/Error', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '404': { | ||
| description: 'Source file does not exist.', | ||
| content: { | ||
| 'application/json': { | ||
| schema: { | ||
| '$ref': '#/components/schemas/Error', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '405': { | ||
| description: 'Your path references a directory instead of a file; this request method is valid only for files.\n', | ||
| content: { | ||
| 'application/json': { | ||
| schema: { | ||
| '$ref': '#/components/schemas/Error', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '409': { | ||
| description: 'Destination file already exists.', | ||
| content: { | ||
| 'application/json': { | ||
| schema: { | ||
| '$ref': '#/components/schemas/Error', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] While updating heading comments to include all operations (append, prepend, replace) provides better context, this change is inconsistent with the PR's stated purpose of adding MOVE functionality. These are documentation improvements to existing PATCH operation examples and should ideally be in a separate commit or PR focused on documentation updates.