Retire stackforge/milk
This commit is contained in:
Monty Taylor
parent
a0e6643a1d
commit
5af0e0f7a0
36
.gitignore
vendored
36
.gitignore
vendored
@ -1,36 +0,0 @@
|
|||||||
*.py[cod]
|
|
||||||
|
|
||||||
# C extensions
|
|
||||||
*.so
|
|
||||||
|
|
||||||
# Packages
|
|
||||||
*.egg
|
|
||||||
*.egg-info
|
|
||||||
dist
|
|
||||||
build
|
|
||||||
eggs
|
|
||||||
parts
|
|
||||||
bin
|
|
||||||
var
|
|
||||||
sdist
|
|
||||||
develop-eggs
|
|
||||||
.installed.cfg
|
|
||||||
lib
|
|
||||||
lib64
|
|
||||||
__pycache__
|
|
||||||
|
|
||||||
# Installer logs
|
|
||||||
pip-log.txt
|
|
||||||
|
|
||||||
# Unit test / coverage reports
|
|
||||||
.coverage
|
|
||||||
.tox
|
|
||||||
nosetests.xml
|
|
||||||
|
|
||||||
# Translations
|
|
||||||
*.mo
|
|
||||||
|
|
||||||
# Mr Developer
|
|
||||||
.mr.developer.cfg
|
|
||||||
.project
|
|
||||||
.pydevproject
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
[gerrit]
|
|
||||||
host=review.openstack.org
|
|
||||||
port=29418
|
|
||||||
project=stackforge/milk.git
|
|
||||||
202
LICENSE
202
LICENSE
@ -1,202 +0,0 @@
|
|||||||
Apache License
|
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
|
||||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright {yyyy} {name of copyright owner}
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
you may not use this file except in compliance with the License.
|
|
||||||
You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
limitations under the License.
|
|
||||||
|
|
||||||
115
README.md
115
README.md
@ -1,115 +0,0 @@
|
|||||||
milk
|
|
||||||
====
|
|
||||||
|
|
||||||
ETC cloud API framework project
|
|
||||||
|
|
||||||
The Entertainment Technology Center @ the University of Southern California (ETC)
|
|
||||||
http://www.etcenter.org/ formally launched “Production in the Cloud,” a new
|
|
||||||
project that brings together a core group of key media and cloud-resource leaders
|
|
||||||
to develop guidelines and accelerate innovation and adoption of next-gen cloud-based
|
|
||||||
content creation, production, and distribution tools and processes. Senior executives
|
|
||||||
from the six major studios in coordination with Rackspace, EMC, EVault,
|
|
||||||
Front Porch Digital, Google and other cloud companies convened recently to serve
|
|
||||||
as governing body to collectively guide this process. The project is looking at the
|
|
||||||
life cycle of film and media production, from pre-production collaboration, production,
|
|
||||||
post production and through to archiving.
|
|
||||||
|
|
||||||
This specific part of the effort is around
|
|
||||||
|
|
||||||
* Bringing together various competitive organizations to work on a common goal
|
|
||||||
* Goal of developing an interoperable cloud framework
|
|
||||||
* First steps of socializing well underway
|
|
||||||
* Next important step of creating a prototype was discussed in October
|
|
||||||
* Now we need to execute on design and implementation
|
|
||||||
|
|
||||||
More information go to https://wiki.openstack.org/wiki/Milk
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Contributing
|
|
||||||
|
|
||||||
## Current Requirements
|
|
||||||
|
|
||||||
[git](http://git-scm.com)
|
|
||||||
[Python3](http://www.python.org)
|
|
||||||
[pip](https://pypi.python.org/pypi/pip)
|
|
||||||
[git-review](http://www.mediawiki.org/wiki/Gerrit/git-review)
|
|
||||||
[Django](https://www.djangoproject.com)
|
|
||||||
[virtualenv](http://www.virtualenv.org)
|
|
||||||
[freshen](https://github.com/rlisagor/freshen)
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
[GitHub](https://github.com/stackforge/milk)
|
|
||||||
[Wiki](https://wiki.openstack.org/wiki/Milk)
|
|
||||||
|
|
||||||
## To Contribute
|
|
||||||
|
|
||||||
1. Create a Launchpad account
|
|
||||||
https://login.launchpad.net/+new_account
|
|
||||||
|
|
||||||
2. Join the OpenStack Foundation free
|
|
||||||
https://www.openstack.org/join
|
|
||||||
(Use the email address you plan to use with git for code contributions)
|
|
||||||
|
|
||||||
3. Agree to the the Individual Contributor License agreement:
|
|
||||||
https://review.openstack.org/#/settings/
|
|
||||||
Look under "Agreements" on the left menu.
|
|
||||||
|
|
||||||
4. Add an SSH public key to your launchpad account
|
|
||||||
https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair
|
|
||||||
|
|
||||||
5. Add the same SSH key to your OpenStack Foundation / Gerrit Identity as well
|
|
||||||
https://review.openstack.org/#/settings/
|
|
||||||
Look under "SSH Public Keys" on the left menu.
|
|
||||||
|
|
||||||
6. Add the same SSH keys to your GitHub account
|
|
||||||
Be sure to configure git on your development machine as well if you haven't already.
|
|
||||||
|
|
||||||
$ git config --global user.name "Firstname Lastname"
|
|
||||||
$ git config --global user.email "your_email@youremail.com"
|
|
||||||
|
|
||||||
7. Install git-review. (In addition to python3, and pip3 )
|
|
||||||
|
|
||||||
$ sudo pip install git-review
|
|
||||||
|
|
||||||
8. Clone the GitHub project
|
|
||||||
|
|
||||||
$ git clone https://github.com/stackforge/milk
|
|
||||||
|
|
||||||
9. Create a branch with a descriptive branch name to make your changes.
|
|
||||||
|
|
||||||
$ git co -b add_tests
|
|
||||||
|
|
||||||
10. Without merging your branch with master, submit it for review with git-review.
|
|
||||||
|
|
||||||
$ git review
|
|
||||||
|
|
||||||
11. Track your contributions
|
|
||||||
https://review.openstack.org/#/
|
|
||||||
|
|
||||||
12. If necessary manually add a reviewer
|
|
||||||
Click on your patch listed from #10 above enter one of the following names or emails in the "Add Reviewer" field, and click add.
|
|
||||||
"Sean Robers" <seanrob@yahoo-inc.com>
|
|
||||||
"Joshua Kolden" <joshua@studiopyxis.com>
|
|
||||||
|
|
||||||
|
|
||||||
## Development Spin Up...
|
|
||||||
|
|
||||||
###Tasks
|
|
||||||
|
|
||||||
- [X] Initialize the project in OpenStack and Gerrit.
|
|
||||||
- [X] Create a git project on GitHub.
|
|
||||||
- [X] Create first draft Apiary blueprint for ETC ID system API.
|
|
||||||
- [ ] Establish BDD system, and create initial acceptance tests.
|
|
||||||
- [ ] Build basic Django server to implement blueprint.
|
|
||||||
- [ ] Create command line tool to generate asset ID, and publish to server, via API.
|
|
||||||
|
|
||||||
###How to Get Involved
|
|
||||||
|
|
||||||
The basic goals and timeline:
|
|
||||||
[Milk Wiki](https://wiki.openstack.org/wiki/Milk)
|
|
||||||
|
|
||||||
Creating a user ID in the OpenStack review system Gerrit, to submit changes for review _(do not use github pull requests)_:
|
|
||||||
[Getting Started Lab](http://docs.openstack.org/training-guides/content/operator-getting-started-lab.html)
|
|
||||||
|
|
||||||
7
README.rst
Normal file
7
README.rst
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
This project is no longer maintained.
|
||||||
|
|
||||||
|
The contents of this repository are still available in the Git source code
|
||||||
|
management system. To see the contents of this repository before it reached
|
||||||
|
its end of life, please check out the previous commit with
|
||||||
|
"git checkout HEAD^1".
|
||||||
|
|
||||||
262
apiary.apib
262
apiary.apib
@ -1,262 +0,0 @@
|
|||||||
FORMAT: 1A
|
|
||||||
|
|
||||||
# ETC Cound Framework Milk
|
|
||||||
This is an initial template for the ETC Milk Cloud Production Framework API.
|
|
||||||
In this form it is setup to define multiple experimental apis for live testing.
|
|
||||||
|
|
||||||
|
|
||||||
# API Dev Root [/]
|
|
||||||
Milk-Dev entry point. This entry point list all test APIs provided.
|
|
||||||
|
|
||||||
## Retrieve Entry Point [GET]
|
|
||||||
|
|
||||||
+ Response 200 (application/json)
|
|
||||||
|
|
||||||
{interfaces: [
|
|
||||||
{
|
|
||||||
type: "registery",
|
|
||||||
name: "String API",
|
|
||||||
version "1.0",
|
|
||||||
description: "String API - Draft 1",
|
|
||||||
path: "/string/v1"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
type: "reference",
|
|
||||||
name: "C4 Referece",
|
|
||||||
version "1",
|
|
||||||
description: "Parts of the public C4 API",
|
|
||||||
path: "/c4"
|
|
||||||
}
|
|
||||||
]}
|
|
||||||
|
|
||||||
# String API [/string/v1]
|
|
||||||
Data Model (For Phase 1)
|
|
||||||
|
|
||||||
The following is a basic set of services to call the String metadata API. While
|
|
||||||
the HTTP call will most likely use a JSON POST, this remains to be architected.
|
|
||||||
We have included an example of the HTTP calli in the login API call. In addition,
|
|
||||||
the return format will need to be determined as well.
|
|
||||||
|
|
||||||
# Group Users
|
|
||||||
|
|
||||||
| userID | password | userGUID | email |
|
|
||||||
|--------|-------------|--------------------------------------|----------------|
|
|
||||||
| dax | Password123 | 550e8400-e29b-41d4-a716-446655440000 | chris@daxcloud |
|
|
||||||
|
|
||||||
## User Login [/login]
|
|
||||||
This is used to login to the String API for the first time. After Phase 1, we
|
|
||||||
will use the Keystone authentication API. It returns a session token to be used
|
|
||||||
for the remaining calls.
|
|
||||||
|
|
||||||
### Login [POST]
|
|
||||||
|
|
||||||
+ Request
|
|
||||||
|
|
||||||
{username: "dax", password: "Password123"}
|
|
||||||
|
|
||||||
+ Response 200 (application/json)
|
|
||||||
|
|
||||||
{
|
|
||||||
userGUID: "550e8400-e29b-41d4-a716-446655440000",
|
|
||||||
session_token: "12345678901234567890"
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
# Group Assets and Services
|
|
||||||
The primary registration method to associate an asset ID with a service type and
|
|
||||||
a URI for more information. The call takes an optional description for this
|
|
||||||
association to be retrieved as part of the lookup. In addition, publicly
|
|
||||||
available metadata key-value pairs can be registered through the optional
|
|
||||||
metadataPairs structure, which is a JSON-encoded, square-bracketed, quoted list
|
|
||||||
of data.
|
|
||||||
|
|
||||||
`success = associateAsset(assetHash, serviceToken, URI, description, metadataPairs)`
|
|
||||||
|
|
||||||
| assetHash | service | URI | description | metadata |
|
|
||||||
|---------------------------------|---------|------------------------------------------------------|--------------------------------|-----------------------------------------------------|
|
|
||||||
| 0d6dce44a124443d845af191c3d1b64 | 5 | https://my.service.com/lookup/blah?asset=%assetHash% | The parent owner of this asset | [“Original”, “True”], [“Color-corrected”, “False”], |
|
|
||||||
| | | | and all of its derivatives is | [“Copyright”, “2014 USC ETC”] |
|
|
||||||
| | | | the USC ETC. | |
|
|
||||||
|
|
||||||
|
|
||||||
## Assets and Services Collection [/AssetsServices]
|
|
||||||
### List [GET]
|
|
||||||
|
|
||||||
+ Response 200 (applicaiton/json)
|
|
||||||
|
|
||||||
[
|
|
||||||
{
|
|
||||||
assetHash: "0d6dce44a124443d845af191c3d1b64"
|
|
||||||
service: 5
|
|
||||||
URI: "https://my.service.com/lookup/blah?asset=%assetHash%"
|
|
||||||
description: "The parent owner of this asset and all of its derivatives is the USC ETC."
|
|
||||||
metadata: {
|
|
||||||
Original: true,
|
|
||||||
Color-corrected: false,
|
|
||||||
Copyright: 2014 USC ETC
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
|
|
||||||
## Create [POST]
|
|
||||||
|
|
||||||
+ Request
|
|
||||||
|
|
||||||
+ Headers
|
|
||||||
|
|
||||||
Authorization: Token token="12345678901234567890"
|
|
||||||
|
|
||||||
+ Body
|
|
||||||
|
|
||||||
{
|
|
||||||
assetHash: "0d6dce44a124443d845af191c3d1b64"
|
|
||||||
service: 5
|
|
||||||
URI: "https://my.service.com/lookup/blah?asset=%assetHash%"
|
|
||||||
description: "The parent owner of this asset and all of its derivatives is the USC ETC."
|
|
||||||
metadata: {
|
|
||||||
Original: true,
|
|
||||||
Color-corrected: false,
|
|
||||||
Copyright: 2014 USC ETC
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
+ Response 201
|
|
||||||
|
|
||||||
## Assets and Services Member [/AssetsServices/{assetHash}]
|
|
||||||
### Retrieve [GET]
|
|
||||||
|
|
||||||
+ Response 200 (application/json)
|
|
||||||
|
|
||||||
{
|
|
||||||
assetHash: "0d6dce44a124443d845af191c3d1b64"
|
|
||||||
service: 5
|
|
||||||
URI: "https://my.service.com/lookup/blah?asset=%assetHash%"
|
|
||||||
description: "The parent owner of this asset and all of its derivatives is the USC ETC."
|
|
||||||
metadata: {
|
|
||||||
Original: true,
|
|
||||||
Color-corrected: false,
|
|
||||||
Copyright: 2014 USC ETC
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
## Update [PUT]
|
|
||||||
|
|
||||||
+ Request
|
|
||||||
|
|
||||||
+ Headers
|
|
||||||
|
|
||||||
Authorization: Token token="12345678901234567890"
|
|
||||||
|
|
||||||
+ Body
|
|
||||||
|
|
||||||
{
|
|
||||||
description: "Update description."
|
|
||||||
}
|
|
||||||
|
|
||||||
+ Response 200
|
|
||||||
|
|
||||||
|
|
||||||
## Destroy [DELETE]
|
|
||||||
|
|
||||||
+ Request
|
|
||||||
|
|
||||||
+ Headers
|
|
||||||
|
|
||||||
Authorization: Token token="12345678901234567890"
|
|
||||||
|
|
||||||
+ Response 200
|
|
||||||
|
|
||||||
|
|
||||||
# Group Service Registry
|
|
||||||
|
|
||||||
| service | serviceName | serviceToken | serviceDescription |
|
|
||||||
|---------|-----------------------|--------------|--------------------------------------------------|
|
|
||||||
| 5 | Ownership Information | OWNER | This service type provides ownership information |
|
|
||||||
| | | | about the asset. A non-parameter call to the URI |
|
|
||||||
| | | | will provide more information on how to access |
|
|
||||||
| | | | this service. |
|
|
||||||
|
|
||||||
## Assets and Services Collection [/ServiceRegistry]
|
|
||||||
### List [GET]
|
|
||||||
|
|
||||||
+ Response 200 (applicaiton/json)
|
|
||||||
|
|
||||||
[
|
|
||||||
{
|
|
||||||
service: 5
|
|
||||||
serviceName: "Ownership Information"
|
|
||||||
serviceToken: "OWNER"
|
|
||||||
serviceDescription: "
|
|
||||||
This service type provides ownership information about the
|
|
||||||
asset. A non-parameter call to the URI will provide more
|
|
||||||
information on how to access this service.
|
|
||||||
"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
|
|
||||||
## Create [POST]
|
|
||||||
|
|
||||||
+ Request
|
|
||||||
|
|
||||||
+ Headers
|
|
||||||
|
|
||||||
Authorization: Token token="12345678901234567890"
|
|
||||||
|
|
||||||
+ Body
|
|
||||||
|
|
||||||
{
|
|
||||||
service: 5
|
|
||||||
serviceName: "Ownership Information"
|
|
||||||
serviceToken: "OWNER"
|
|
||||||
serviceDescription: "
|
|
||||||
This service type provides ownership information about the
|
|
||||||
asset. A non-parameter call to the URI will provide more
|
|
||||||
information on how to access this service.
|
|
||||||
"
|
|
||||||
}
|
|
||||||
|
|
||||||
+ Response 201
|
|
||||||
|
|
||||||
## Assets and Services Member [/ServiceRegistry/{service}]
|
|
||||||
### Retrieve [GET]
|
|
||||||
|
|
||||||
+ Response 200 (application/json)
|
|
||||||
|
|
||||||
{
|
|
||||||
service: 5
|
|
||||||
serviceName: "Ownership Information"
|
|
||||||
serviceToken: "OWNER"
|
|
||||||
serviceDescription: "
|
|
||||||
This service type provides ownership information about the
|
|
||||||
asset. A non-parameter call to the URI will provide more
|
|
||||||
information on how to access this service.
|
|
||||||
"
|
|
||||||
}
|
|
||||||
|
|
||||||
## Update [PUT]
|
|
||||||
|
|
||||||
+ Request
|
|
||||||
|
|
||||||
+ Headers
|
|
||||||
|
|
||||||
Authorization: Token token="12345678901234567890"
|
|
||||||
|
|
||||||
+ Body
|
|
||||||
|
|
||||||
{
|
|
||||||
serviceDescription: "Update serviceDescription."
|
|
||||||
}
|
|
||||||
|
|
||||||
+ Response 200
|
|
||||||
|
|
||||||
|
|
||||||
## Destroy [DELETE]
|
|
||||||
|
|
||||||
+ Request
|
|
||||||
|
|
||||||
+ Headers
|
|
||||||
|
|
||||||
Authorization: Token token="12345678901234567890"
|
|
||||||
|
|
||||||
+ Response 200
|
|
||||||
Loading…
Reference in New Issue
Block a user