{"openapi":"3.0.0","servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/r2b2/3dp/1.0.0"}],"info":{"description":"API for delivering 3D metadata","version":"0.1.0","title":"3D Public API","contact":{"email":"donotreply@si.edu"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"tags":[{"name":"admins","description":"API administrators"},{"name":"partners","description":"Operations available to partners"},{"name":"developers","description":"Operations available to the general public"}],"paths":{"/discover":{"get":{"tags":["admins","partners"],"summary":"discovers models","operationId":"discoverModels","description":"By passing in the appropriate options, you can discover related and available models","parameters":[{"in":"query","name":"queryString","description":"pass an optional query string for looking up models","required":false,"schema":{"type":"string"}},{"in":"query","name":"start","description":"row at which to start (number of records to skip)","schema":{"type":"integer","format":"int32","minimum":0}},{"in":"query","name":"limit","description":"maximum number of records to return","schema":{"type":"integer","format":"int32","minimum":0,"maximum":100}}],"responses":{"200":{"description":"models matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ModelItem"}}}}},"400":{"description":"bad input parameter"}}}},"/search":{"get":{"tags":["admins","developers","partners"],"summary":"searches models","operationId":"searchModels","description":"By passing in the appropriate options, you can search for available models","parameters":[{"in":"query","name":"searchString","description":"pass an optional search string for looking up 3D models","required":false,"schema":{"type":"string"}},{"in":"query","name":"start","description":"row at which to start (number of records to skip)","schema":{"type":"integer","format":"int32","minimum":0}},{"in":"query","name":"limit","description":"maximum number of records to return","schema":{"type":"integer","format":"int32","minimum":0,"maximum":100}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ModelItem"}}}}},"400":{"description":"bad input parameter"}}}},"/3dmodel":{"get":{"tags":["admins","partners","developers"],"summary":"retrieves 3D model item","operationId":"get3DModel","description":"By passing in the model ID you can retrieve a 3D model item.","parameters":[{"in":"query","name":"modelId","description":"pass a model ID to retrieve the model Item","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"model matching ID","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ModelItem"}}}},"400":{"description":"bad input parameter"},"404":{"description":"No 3D model matching provided modelID."}}},"post":{"tags":["admins"],"summary":"adds a model item","operationId":"addModel","description":"Adds a model to the system","responses":{"200":{"description":"model updated"},"201":{"description":"model created"},"400":{"description":"invalid input, object invalid"},"409":{"description":"A 3D model already exists with the same title."}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelItem"}}},"description":"Model item to add"}}},"/partnerLicense":{"get":{"tags":["partners"],"summary":"retrieves partner license","operationId":"getPartnerLicense","description":"By passing in the ID you can retrieve a partner license.","parameters":[{"in":"query","name":"partnerId","description":"pass a partner ID to retrieve their license","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"partner license corresponding to partner ID","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PartnerLicenseItem"}}}},"400":{"description":"bad input parameter"},"404":{"description":"No license found matching provided partnerId."}}}},"/partner":{"get":{"tags":["admins"],"summary":"retrieves partner","operationId":"getPartner","description":"By passing in the ID you can retrieve a partner record.","parameters":[{"in":"query","name":"partnerId","description":"pass a partner ID to retrieve their record","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"partner matching ID","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PartnerItem"}}}},"400":{"description":"bad input parameter"},"404":{"description":"No partner found matching provided partnerId."}}},"post":{"tags":["admins"],"summary":"adds a partner item","operationId":"addPartner","description":"Adds or edits a partner in the system","responses":{"200":{"description":"partner updated"},"201":{"description":"partner created"},"400":{"description":"invalid input, object invalid"},"409":{"description":"A partner with this title already exists."}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerItem"}}},"description":"Partner item to add or update"}}},"/partners":{"get":{"tags":["admins"],"summary":"retrieves partner records","operationId":"getPartners","description":"By passing in parameters you can return partner data.","parameters":[{"in":"query","name":"searchString","description":"pass an optional search string for partners","required":false,"schema":{"type":"string"}},{"in":"query","name":"start","description":"row at which to start (number of records to skip)","schema":{"type":"integer","format":"int32","minimum":0}},{"in":"query","name":"limit","description":"maximum number of records to return","schema":{"type":"integer","format":"int32","minimum":0,"maximum":100}}],"responses":{"200":{"description":"partners matching query beginning at row start for a total of limit rows","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PartnerItem"}}}}},"400":{"description":"bad input parameter"}}}},"/searchUsage":{"get":{"tags":["admins"],"summary":"retrieves usage data for partner","operationId":"searchUsage","description":"By passing in paraemters you can query partner usage data.","parameters":[{"in":"query","name":"searchString","description":"pass a search term to retrieve matching partners","required":true,"schema":{"type":"string"}},{"in":"query","name":"partnerId","description":"pass a partner ID to retrieve their usage data","required":true,"schema":{"type":"string"}},{"in":"query","name":"start","description":"row at which to start (number of records to skip)","schema":{"type":"integer","format":"int32","minimum":0}},{"in":"query","name":"limit","description":"maximum number of records to return","schema":{"type":"integer","format":"int32","minimum":0,"maximum":100}}],"responses":{"200":{"description":"usage data matching query","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PartnerItem"}}}},"400":{"description":"bad input parameter"}}}}},"components":{"schemas":{"ModelItem":{"type":"object","required":["id","title","public","published"],"properties":{"id":{"type":"string","format":"uuid","example":"p2b-1517667604453-1519836472051-0"},"title":{"type":"string","example":"Cosmic Buddha"},"public":{"type":"boolean","example":true},"published":{"type":"boolean","example":true}}},"PartnerItem":{"type":"object","required":["id","title","public","published"],"properties":{"id":{"type":"string","format":"uuid","example":"p2b-1517667604453-1519836472051-0"},"title":{"type":"string","example":"Facebook"},"public":{"type":"boolean","example":true},"published":{"type":"boolean","example":true}}},"PartnerLicenseItem":{"type":"object","required":["id","partnerid","licensetitle","licenseurl"],"properties":{"id":{"type":"string","format":"uuid","example":"p2b-1517667604453-1519836472051-0"},"partnerid":{"type":"string","format":"uuid","example":"p2b-1517667604453-1519836472051-0"},"licensetitle":{"type":"string","example":"Apache 2.0"},"licenseurl":{"type":"string","example":"http://www.apache.org/licenses/LICENSE-2.0.html"}}},"UsageItem":{"type":"object","required":["id","partnerid","action","endpoint","query","timestamp"],"properties":{"id":{"type":"string","format":"uuid","example":"p2b-1517667604453-1519836472051-0"},"partnerid":{"type":"string","format":"uuid","example":"p2b-1517667604453-1519836472051-0"},"action":{"type":"string","example":"GET"},"endpoint":{"type":"string","example":"partner"},"query":{"type":"array","items":{"$ref":"#/components/schemas/QueryItem"}},"timestamp":{"type":"string","format":"date-time","example":"2018-04-16T16:06:05Z"}}},"QueryItem":{"type":"object","required":["param"],"properties":{"param":{"type":"string","example":"q"},"value":{"type":"string","example":"soccer ball"}}}}}}