-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Renaming README and fixed typo in gitignore
- Loading branch information
1 parent
2da8b27
commit e7b18a4
Showing
2 changed files
with
36 additions
and
1 deletion.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,6 +27,6 @@ _testmain.go | |
.env | ||
|
||
gin-bin | ||
go-restful | ||
sg-restful | ||
|
||
Godeps/_workspace |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# SG Restful - WIP | ||
|
||
## NOT PRODUCTION READY! | ||
|
||
SG Restful is a restful interface for the [Shotgun](http://shotgunsoftware.com) Api. | ||
|
||
|
||
## What works currently | ||
|
||
### Entities | ||
|
||
- Read | ||
- Get by id | ||
- Get all | ||
- Returning fields | ||
- Pagination | ||
- Create | ||
- Update | ||
- Delete | ||
|
||
|
||
## Auth | ||
|
||
SG Restful using basic auth for getting script and user credentials. This may change in the future. | ||
|
||
Script `Authorization` header: | ||
``` | ||
Basic <base64 scipt_name:sript_key> | ||
``` | ||
|
||
User `Authorization` header: | ||
( I don't suggest using this unless you have an internal Shotgun sever. ) | ||
``` | ||
Basic-user <base64 user_name:user_password> | ||
``` |