Last active
May 14, 2016 14:15
-
-
Save joetm/1926d6528b7539b17bcc497ce095f6c2 to your computer and use it in GitHub Desktop.
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
| { | |
| "apiVersion": "1.0.0", | |
| "swaggerVersion": "1.2", | |
| "resourcePath": "/soc", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "protocols": [ | |
| "http" | |
| ], | |
| "apis": [ | |
| { | |
| "path": "/soc/code/{code}", | |
| "operations": [ | |
| { | |
| "method": "GET", | |
| "summary": "Get extended information about a particular SOC code.", | |
| "position": 0, | |
| "notes": "", | |
| "deprecated": false, | |
| "nickname": "getSOCInfo", | |
| "parameters": [ | |
| { | |
| "name": "code", | |
| "description": "The SOC code.", | |
| "required": true, | |
| "paramType": "path", | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "type": "SOCInfo" | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/soc/search", | |
| "operations": [ | |
| { | |
| "method": "GET", | |
| "summary": "Find SOC codes by keywords - pretty much like googling it.", | |
| "position": 0, | |
| "notes": "Returns a maximum of 30 items, sorted by relevance. Search doesn't work for qualifications, because they're usually very similar between similar jobs.", | |
| "deprecated": false, | |
| "nickname": "find", | |
| "parameters": [ | |
| { | |
| "name": "q", | |
| "description": "Search string.", | |
| "required": true, | |
| "paramType": "query", | |
| "type": "string" | |
| } | |
| ], | |
| "type": "array", | |
| "items": { | |
| "$ref": "SOCInfo" | |
| } | |
| } | |
| ] | |
| } | |
| ], | |
| "models": { | |
| "SOCInfo": { | |
| "id": "SOCInfo", | |
| "name": "SOCInfo", | |
| "qualifiedType": "org.careersdata.lmiforall.api.SOCInfo", | |
| "required": [ | |
| "soc", | |
| "title", | |
| "description", | |
| "qualifications", | |
| "tasks" | |
| ], | |
| "properties": { | |
| "soc": { | |
| "position": 0, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "title": { | |
| "position": 1, | |
| "type": "string" | |
| }, | |
| "description": { | |
| "position": 2, | |
| "type": "string" | |
| }, | |
| "qualifications": { | |
| "position": 3, | |
| "type": "string" | |
| }, | |
| "tasks": { | |
| "position": 4, | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "basePath": "http://api.lmiforall.org.uk/api/v1" | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment