/
swagger.json
1 lines (1 loc) · 33.9 KB
/
swagger.json
1
{"swagger":"2.0","info":{"title":"The feedpushr API","description":"A simple feed aggregator daemon with sugar on top.","contact":{"name":"Nicolas Carlier","url":"https://github.com/ncarlier"},"license":{"name":"MIT","url":"https://github.com/ncarlier/feedpushr/blob/master/LICENSE"},"version":""},"host":"localhost:8080","basePath":"/v2","schemes":["http"],"consumes":["application/json","application/xml","application/gob","application/x-gob"],"produces":["application/json","application/xml","application/gob","application/x-gob"],"paths":{"/":{"get":{"tags":["index"],"summary":"get index","description":"Get basic API information.","operationId":"index#get","produces":["application/vnd.feedpushr.info.v2+json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Info"}}},"schemes":["http"]}},"/explore":{"get":{"tags":["explore"],"summary":"get explore","description":"Search RSS feed using external search engine","operationId":"explore#get","produces":["application/vnd.feedpushr.explore.v2+json; type=collection","application/vnd.goa.error"],"parameters":[{"name":"q","in":"query","description":"Search query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ExploreResponseCollection"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}}},"schemes":["http"]}},"/feeds":{"get":{"tags":["feed"],"summary":"list feed","description":"Retrieve all feeds","operationId":"feed#list","produces":["application/vnd.feedpushr.feeds-page.v2+json","application/vnd.goa.error"],"parameters":[{"name":"page","in":"query","description":"Page to fetch","required":false,"type":"integer","default":1,"minimum":1},{"name":"q","in":"query","description":"Search query","required":false,"type":"string"},{"name":"size","in":"query","description":"Page size","required":false,"type":"integer","default":10,"minimum":1}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FeedsPageResponse"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}},"404":{"description":"Not Found"}},"schemes":["http"]},"post":{"tags":["feed"],"summary":"create feed","description":"Create a new feed","operationId":"feed#create","produces":["application/vnd.feedpushr.feed.v2+json","application/vnd.goa.error"],"parameters":[{"name":"enable","in":"query","description":"Feed activation status","required":false,"type":"boolean"},{"name":"tags","in":"query","description":"Comma separated list of tags","required":false,"type":"string"},{"name":"title","in":"query","description":"Feed title (will overide official feed title)","required":false,"type":"string"},{"name":"url","in":"query","description":"Feed URL","required":true,"type":"string","format":"uri"}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/FeedResponse"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}}},"schemes":["http"]}},"/feeds/{id}":{"get":{"tags":["feed"],"summary":"get feed","description":"Retrieve feed with given ID","operationId":"feed#get","produces":["application/vnd.feedpushr.feed.v2+json","application/vnd.goa.error"],"parameters":[{"name":"id","in":"path","description":"Feed ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FeedResponse"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}},"404":{"description":"Not Found"}},"schemes":["http"]},"put":{"tags":["feed"],"summary":"update feed","description":"Update a feed","operationId":"feed#update","produces":["application/vnd.feedpushr.feed.v2+json","application/vnd.goa.error"],"parameters":[{"name":"id","in":"path","description":"Feed ID","required":true,"type":"string"},{"name":"tags","in":"query","description":"Comma separated list of tags","required":false,"type":"string"},{"name":"title","in":"query","description":"Feed title","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FeedResponse"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}},"404":{"description":"Not Found"}},"schemes":["http"]},"delete":{"tags":["feed"],"summary":"delete feed","description":"Delete a feed","operationId":"feed#delete","produces":["application/vnd.goa.error"],"parameters":[{"name":"id","in":"path","description":"Feed ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}},"404":{"description":"Not Found"}},"schemes":["http"]}},"/feeds/{id}/start":{"post":{"tags":["feed"],"summary":"start feed","description":"Start feed aggregation","operationId":"feed#start","produces":["application/vnd.goa.error"],"parameters":[{"name":"id","in":"path","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}},"404":{"description":"Not Found"}},"schemes":["http"]}},"/feeds/{id}/stop":{"post":{"tags":["feed"],"summary":"stop feed","description":"Stop feed aggregation","operationId":"feed#stop","produces":["application/vnd.goa.error"],"parameters":[{"name":"id","in":"path","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}},"404":{"description":"Not Found"}},"schemes":["http"]}},"/filters/_specs":{"get":{"tags":["filter"],"summary":"specs filter","description":"Retrieve all filter types available","operationId":"filter#specs","produces":["application/vnd.feedpushr.filter-spec.v2+json; type=collection"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FilterSpecResponseCollection"}}},"schemes":["http"]}},"/healthz":{"get":{"tags":["health"],"summary":"get health","description":"Perform health check.","operationId":"health#get","produces":["text/plain"],"responses":{"200":{"description":"OK"}},"schemes":["http"]}},"/opml":{"get":{"tags":["opml"],"summary":"get opml","description":"Get all feeds as an OPML format","operationId":"opml#get","produces":["application/vnd.goa.error","application/xml"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}}},"schemes":["http"]},"post":{"tags":["opml"],"summary":"upload opml","description":"Upload an OPML file to create feeds","operationId":"opml#upload","produces":["application/vnd.feedpushr.ompl-import-job.v2+json","application/vnd.goa.error"],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OPMLImportJobResponse"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}}},"schemes":["http"]}},"/opml/status/{id}":{"get":{"tags":["opml"],"summary":"status opml","description":"Get OPML import status","operationId":"opml#status","produces":["application/vnd.goa.error","text/event-stream"],"parameters":[{"name":"id","in":"path","description":"Import job ID","required":true,"type":"integer"}],"responses":{"200":{"description":"OK"},"404":{"description":"Not Found","schema":{"$ref":"#/definitions/error"}}},"schemes":["http"]}},"/outputs":{"get":{"tags":["output"],"summary":"list output","description":"Retrieve all outputs definitions","operationId":"output#list","produces":["application/vnd.feedpushr.output.v2+json; type=collection"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OutputResponseCollection"}}},"schemes":["http"]},"post":{"tags":["output"],"summary":"create output","description":"Create a new output","operationId":"output#create","produces":["application/vnd.feedpushr.output.v2+json","application/vnd.goa.error"],"parameters":[{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/CreateOutputPayload"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/OutputResponse"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}}},"schemes":["http"]}},"/outputs/_specs":{"get":{"tags":["output"],"summary":"specs output","description":"Retrieve all output types available","operationId":"output#specs","produces":["application/vnd.feedpushr.output-spec.v2+json; type=collection"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OutputSpecResponseCollection"}}},"schemes":["http"]}},"/outputs/{id}":{"get":{"tags":["output"],"summary":"get output","description":"Retrieve output with given ID","operationId":"output#get","produces":["application/vnd.feedpushr.output.v2+json","application/vnd.goa.error"],"parameters":[{"name":"id","in":"path","description":"Output ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OutputResponse"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}},"404":{"description":"Not Found"}},"schemes":["http"]},"put":{"tags":["output"],"summary":"update output","description":"Update an output","operationId":"output#update","produces":["application/vnd.feedpushr.output.v2+json","application/vnd.goa.error"],"parameters":[{"name":"id","in":"path","description":"Output ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/UpdateOutputPayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OutputResponse"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}},"404":{"description":"Not Found"}},"schemes":["http"]},"delete":{"tags":["output"],"summary":"delete output","description":"Delete an output","operationId":"output#delete","produces":["application/vnd.goa.error"],"parameters":[{"name":"id","in":"path","description":"Output ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}},"404":{"description":"Not Found"}},"schemes":["http"]}},"/outputs/{id}/filters":{"post":{"tags":["output"],"summary":"createFilter output","description":"Create a new filter","operationId":"output#createFilter","produces":["application/vnd.feedpushr.filter.v2+json","application/vnd.goa.error"],"parameters":[{"name":"id","in":"path","description":"Output ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/CreateFilterOutputPayload"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/FilterResponse"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}},"404":{"description":"Not Found"}},"schemes":["http"]}},"/outputs/{id}/filters/{idFilter}":{"put":{"tags":["output"],"summary":"updateFilter output","description":"Update a filter","operationId":"output#updateFilter","produces":["application/vnd.feedpushr.filter.v2+json","application/vnd.goa.error"],"parameters":[{"name":"id","in":"path","description":"Output ID","required":true,"type":"string"},{"name":"idFilter","in":"path","description":"Filter ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/UpdateFilterOutputPayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FilterResponse"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}},"404":{"description":"Not Found"}},"schemes":["http"]},"delete":{"tags":["output"],"summary":"deleteFilter output","description":"Delete a filter","operationId":"output#deleteFilter","produces":["application/vnd.goa.error"],"parameters":[{"name":"id","in":"path","description":"Filter ID","required":true,"type":"string"},{"name":"idFilter","in":"path","description":"Filter ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}},"404":{"description":"Not Found"}},"schemes":["http"]}},"/pshb":{"get":{"tags":["pshb"],"summary":"sub pshb","description":"Callback to validate the (un)subscription to the topic of a Hub","operationId":"pshb#sub","produces":["application/vnd.goa.error","text/plain"],"parameters":[{"name":"hub.challenge","in":"query","description":"A hub-generated random string","required":true,"type":"string"},{"name":"hub.lease_seconds","in":"query","description":"The hub-determined number of seconds that the subscription will stay active before expiring","required":false,"type":"integer"},{"name":"hub.mode","in":"query","description":"The literal string \"subscribe\" or \"unsubscribe\"","required":true,"type":"string","enum":["subscribe","unsubscribe"]},{"name":"hub.topic","in":"query","description":"The topic URL given in the corresponding subscription request","required":true,"type":"string","format":"uri"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}}},"schemes":["http"]},"post":{"tags":["pshb"],"summary":"pub pshb","description":"Publication endpoint for PSHB hubs","operationId":"pshb#pub","produces":["application/vnd.goa.error","text/plain"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/error"}}},"schemes":["http"]}},"/swagger.json":{"get":{"tags":["swagger"],"summary":"get swagger","description":"Get OpenAPI specifications","operationId":"swagger#get","responses":{"200":{"description":"OK"}},"schemes":["http"]}},"/vars":{"get":{"tags":["vars"],"summary":"get vars","description":"Get all internals exp vars","operationId":"vars#get","responses":{"200":{"description":"OK"}},"schemes":["http"]}}},"definitions":{"CreateFilterOutputPayload":{"title":"CreateFilterOutputPayload","type":"object","properties":{"alias":{"type":"string","description":"Alias of the filter","example":"foo"},"condition":{"type":"string","description":"Conditional expression of the output","example":"\"foo\" in Tags"},"name":{"type":"string","description":"Name of the filter","example":"fetch"},"props":{"type":"object","description":"Filter properties","example":"-","additionalProperties":true}},"example":{"alias":"foo","condition":"\"foo\" in Tags","name":"fetch","props":"-"},"required":["alias","name","condition"]},"CreateOutputPayload":{"title":"CreateOutputPayload","type":"object","properties":{"alias":{"type":"string","description":"Alias of the output","example":"foo"},"condition":{"type":"string","description":"Conditional expression of the output","example":"\"foo\" in Tags"},"name":{"type":"string","description":"Name of the output","example":"http"},"props":{"type":"object","description":"Output properties","example":"-","additionalProperties":true}},"example":{"alias":"foo","condition":"\"foo\" in Tags","name":"http","props":"-"},"required":["alias","name","condition"]},"ExploreResponse":{"title":"Mediatype identifier: application/vnd.feedpushr.explore.v2+json; view=default","type":"object","properties":{"desc":{"type":"string","description":"Feed description","example":"A short description..."},"htmlUrl":{"type":"string","description":"URL of the feed website","example":"http://www.hashicorp.com/blog"},"title":{"type":"string","description":"Feed title","example":"Blog news..."},"xmlUrl":{"type":"string","description":"URL of the XML feed","example":"http://www.hashicorp.com/feed.xml"}},"description":"The search result (default view)","example":{"desc":"A short description...","htmlUrl":"http://www.hashicorp.com/blog","title":"Blog news...","xmlUrl":"http://www.hashicorp.com/feed.xml"},"required":["title","desc","xmlUrl","htmlUrl"]},"ExploreResponseCollection":{"title":"Mediatype identifier: application/vnd.feedpushr.explore.v2+json; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/ExploreResponse"},"description":"ExploreResponseCollection is the media type for an array of ExploreResponse (default view)","example":[{"desc":"A short description...","htmlUrl":"http://www.hashicorp.com/blog","title":"Blog news...","xmlUrl":"http://www.hashicorp.com/feed.xml"},{"desc":"A short description...","htmlUrl":"http://www.hashicorp.com/blog","title":"Blog news...","xmlUrl":"http://www.hashicorp.com/feed.xml"},{"desc":"A short description...","htmlUrl":"http://www.hashicorp.com/blog","title":"Blog news...","xmlUrl":"http://www.hashicorp.com/feed.xml"}]},"FeedResponse":{"title":"Mediatype identifier: application/vnd.feedpushr.feed.v2+json; view=default","type":"object","properties":{"cdate":{"type":"string","description":"Date of creation","example":"2001-04-14T11:31:36Z","format":"date-time"},"errorCount":{"type":"integer","description":"Number of consecutive aggregation errors","example":3744847684773844858,"format":"int64"},"errorMsg":{"type":"string","description":"Last aggregation error","example":"Suscipit voluptas."},"htmlUrl":{"type":"string","description":"URL of the feed website","example":"http://www.hashicorp.com/blog"},"hubUrl":{"type":"string","description":"URL of the PubSubHubbud hub","example":"http://pubsubhubbub.appspot.com"},"id":{"type":"string","description":"ID of feed (MD5 of the xmlUrl)","example":"5bfb841c028281c0051828c115fd1f50"},"lastCheck":{"type":"string","description":"Last aggregation pass","example":"1981-09-22T23:39:59Z","format":"date-time"},"mdate":{"type":"string","description":"Date of modification","example":"1975-05-22T16:26:55Z","format":"date-time"},"nbProcessedItems":{"type":"integer","description":"Total number of processed items","example":2455384998049050733,"format":"int64"},"nextCheck":{"type":"string","description":"Next aggregation pass","example":"1982-07-23T05:02:45Z","format":"date-time"},"status":{"type":"string","description":"Aggregation status","example":"running","enum":["running","stopped"]},"tags":{"type":"array","items":{"type":"string","example":"Et reiciendis sed vero."},"description":"List of tags","example":["foo","bar"]},"title":{"type":"string","description":"Title of the Feed","example":"Hashicorp Blog"},"xmlUrl":{"type":"string","description":"URL of the XML feed","example":"http://www.hashicorp.com/feed.xml"}},"description":"A RSS feed (default view)","example":{"cdate":"2001-04-14T11:31:36Z","errorCount":3744847684773844858,"errorMsg":"Suscipit voluptas.","htmlUrl":"http://www.hashicorp.com/blog","hubUrl":"http://pubsubhubbub.appspot.com","id":"5bfb841c028281c0051828c115fd1f50","lastCheck":"1981-09-22T23:39:59Z","mdate":"1975-05-22T16:26:55Z","nbProcessedItems":2455384998049050733,"nextCheck":"1982-07-23T05:02:45Z","status":"running","tags":["foo","bar"],"title":"Hashicorp Blog","xmlUrl":"http://www.hashicorp.com/feed.xml"},"required":["id","xmlUrl","title","cdate","mdate"]},"FeedResponseCollection":{"title":"Mediatype identifier: application/vnd.feedpushr.feed.v2+json; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/FeedResponse"},"description":"FeedResponseCollection is the media type for an array of FeedResponse (default view)","example":[{"cdate":"2001-04-14T11:31:36Z","errorCount":3744847684773844858,"errorMsg":"Suscipit voluptas.","htmlUrl":"http://www.hashicorp.com/blog","hubUrl":"http://pubsubhubbub.appspot.com","id":"5bfb841c028281c0051828c115fd1f50","lastCheck":"1981-09-22T23:39:59Z","mdate":"1975-05-22T16:26:55Z","nbProcessedItems":2455384998049050733,"nextCheck":"1982-07-23T05:02:45Z","status":"running","tags":["foo","bar"],"title":"Hashicorp Blog","xmlUrl":"http://www.hashicorp.com/feed.xml"},{"cdate":"2001-04-14T11:31:36Z","errorCount":3744847684773844858,"errorMsg":"Suscipit voluptas.","htmlUrl":"http://www.hashicorp.com/blog","hubUrl":"http://pubsubhubbub.appspot.com","id":"5bfb841c028281c0051828c115fd1f50","lastCheck":"1981-09-22T23:39:59Z","mdate":"1975-05-22T16:26:55Z","nbProcessedItems":2455384998049050733,"nextCheck":"1982-07-23T05:02:45Z","status":"running","tags":["foo","bar"],"title":"Hashicorp Blog","xmlUrl":"http://www.hashicorp.com/feed.xml"},{"cdate":"2001-04-14T11:31:36Z","errorCount":3744847684773844858,"errorMsg":"Suscipit voluptas.","htmlUrl":"http://www.hashicorp.com/blog","hubUrl":"http://pubsubhubbub.appspot.com","id":"5bfb841c028281c0051828c115fd1f50","lastCheck":"1981-09-22T23:39:59Z","mdate":"1975-05-22T16:26:55Z","nbProcessedItems":2455384998049050733,"nextCheck":"1982-07-23T05:02:45Z","status":"running","tags":["foo","bar"],"title":"Hashicorp Blog","xmlUrl":"http://www.hashicorp.com/feed.xml"}]},"FeedsPageResponse":{"title":"Mediatype identifier: application/vnd.feedpushr.feeds-page.v2+json; view=default","type":"object","properties":{"current":{"type":"integer","description":"Current page number","example":1,"format":"int64"},"data":{"$ref":"#/definitions/FeedResponseCollection"},"size":{"type":"integer","description":"Max number of feeds by page","example":100,"format":"int64"},"total":{"type":"integer","description":"Total number of feeds","example":99,"format":"int64"}},"description":"A pagignated list of feeds (default view)","example":{"current":1,"data":[{"cdate":"2001-04-14T11:31:36Z","errorCount":3744847684773844858,"errorMsg":"Suscipit voluptas.","htmlUrl":"http://www.hashicorp.com/blog","hubUrl":"http://pubsubhubbub.appspot.com","id":"5bfb841c028281c0051828c115fd1f50","lastCheck":"1981-09-22T23:39:59Z","mdate":"1975-05-22T16:26:55Z","nbProcessedItems":2455384998049050733,"nextCheck":"1982-07-23T05:02:45Z","status":"running","tags":["foo","bar"],"title":"Hashicorp Blog","xmlUrl":"http://www.hashicorp.com/feed.xml"}],"size":100,"total":99},"required":["total","current","size","data"]},"FilterResponse":{"title":"Mediatype identifier: application/vnd.feedpushr.filter.v2+json; view=default","type":"object","properties":{"alias":{"type":"string","description":"Alias of the filter","example":"foo"},"condition":{"type":"string","description":"Conditional expression of the filter","example":"\"foo\" in Tags"},"desc":{"type":"string","description":"Description of the filter","example":"This filter will..."},"enabled":{"type":"boolean","description":"Status","default":false,"example":true},"id":{"type":"string","description":"ID of the filter","example":"Ut pariatur qui voluptatibus."},"name":{"type":"string","description":"Name of the filter","example":"fetch"},"nbError":{"type":"integer","description":"Number of error","default":0,"example":10,"format":"int64"},"nbSuccess":{"type":"integer","description":"Number of success","default":0,"example":10,"format":"int64"},"props":{"type":"object","description":"Filter properties","example":"-","additionalProperties":true}},"description":"A filter (default view)","example":{"alias":"foo","condition":"\"foo\" in Tags","desc":"This filter will...","enabled":true,"id":"Ut pariatur qui voluptatibus.","name":"fetch","nbError":10,"nbSuccess":10,"props":"-"},"required":["id","alias","name","desc","condition","props"]},"FilterResponseCollection":{"title":"Mediatype identifier: application/vnd.feedpushr.filter.v2+json; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/FilterResponse"},"description":"FilterResponseCollection is the media type for an array of FilterResponse (default view)","example":[{"alias":"foo","condition":"\"foo\" in Tags","desc":"This filter will...","enabled":true,"id":"Ut pariatur qui voluptatibus.","name":"fetch","nbError":10,"nbSuccess":10,"props":"-"},{"alias":"foo","condition":"\"foo\" in Tags","desc":"This filter will...","enabled":true,"id":"Ut pariatur qui voluptatibus.","name":"fetch","nbError":10,"nbSuccess":10,"props":"-"},{"alias":"foo","condition":"\"foo\" in Tags","desc":"This filter will...","enabled":true,"id":"Ut pariatur qui voluptatibus.","name":"fetch","nbError":10,"nbSuccess":10,"props":"-"}]},"FilterSpecResponse":{"title":"Mediatype identifier: application/vnd.feedpushr.filter-spec.v2+json; view=default","type":"object","properties":{"desc":{"type":"string","description":"Description of the filter","example":"Add a prefix to the tittle..."},"name":{"type":"string","description":"Name of the filter","example":"title"},"props":{"$ref":"#/definitions/PropSpecCollection"}},"description":"The filter specification (default view)","example":{"desc":"Add a prefix to the tittle...","name":"title","props":[{"desc":"New articles are sent as JSON document to...","name":"url","options":{"Veritatis laudantium autem deserunt saepe.":"Consequuntur id earum accusantium quidem non."},"type":"text"},{"desc":"New articles are sent as JSON document to...","name":"url","options":{"Veritatis laudantium autem deserunt saepe.":"Consequuntur id earum accusantium quidem non."},"type":"text"}]},"required":["name","desc","props"]},"FilterSpecResponseCollection":{"title":"Mediatype identifier: application/vnd.feedpushr.filter-spec.v2+json; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/FilterSpecResponse"},"description":"FilterSpecResponseCollection is the media type for an array of FilterSpecResponse (default view)","example":[{"desc":"Add a prefix to the tittle...","name":"title","props":[{"desc":"New articles are sent as JSON document to...","name":"url","options":{"Veritatis laudantium autem deserunt saepe.":"Consequuntur id earum accusantium quidem non."},"type":"text"},{"desc":"New articles are sent as JSON document to...","name":"url","options":{"Veritatis laudantium autem deserunt saepe.":"Consequuntur id earum accusantium quidem non."},"type":"text"}]}]},"Info":{"title":"Mediatype identifier: application/vnd.feedpushr.info.v2+json; view=default","type":"object","properties":{"_links":{"type":"object","description":"HAL links","example":{"Culpa mollitia modi consequatur maxime occaecati necessitatibus.":{"href":"url"}},"additionalProperties":true},"desc":{"type":"string","description":"Service description","example":"Feed aggregator daemon with sugar on top"},"name":{"type":"string","description":"Service name","example":"feedpushr"},"version":{"type":"string","description":"Service version","example":"v3.0.0"}},"description":"API info (default view)","example":{"_links":{"Culpa mollitia modi consequatur maxime occaecati necessitatibus.":{"href":"url"}},"desc":"Feed aggregator daemon with sugar on top","name":"feedpushr","version":"v3.0.0"},"required":["name","desc","version","_links"]},"OPMLImportJobResponse":{"title":"Mediatype identifier: application/vnd.feedpushr.ompl-import-job.v2+json; view=default","type":"object","properties":{"id":{"type":"string","description":"ID of the import job","example":"Eligendi illum."}},"description":"OPMLImportJobResponse media type (default view)","example":{"id":"Eligendi illum."},"required":["id"]},"OutputResponse":{"title":"Mediatype identifier: application/vnd.feedpushr.output.v2+json; view=default","type":"object","properties":{"alias":{"type":"string","description":"Alias of the output channel","example":"foo"},"condition":{"type":"string","description":"Conditional expression of the filter","example":"\"foo\" in Tags"},"desc":{"type":"string","description":"Description of the output channel","example":"New articles are sent as JSON document to..."},"enabled":{"type":"boolean","description":"Status","default":false,"example":true},"filters":{"$ref":"#/definitions/FilterResponseCollection"},"id":{"type":"string","description":"ID of the output","example":"Sint tenetur commodi soluta similique."},"name":{"type":"string","description":"Name of the output channel","example":"fetch"},"nbError":{"type":"integer","description":"Number of error","default":0,"example":10,"format":"int64"},"nbSuccess":{"type":"integer","description":"Number of success","default":0,"example":10,"format":"int64"},"props":{"type":"object","description":"Output channel properties","example":"-","additionalProperties":true}},"description":"The output channel (default view)","example":{"alias":"foo","condition":"\"foo\" in Tags","desc":"New articles are sent as JSON document to...","enabled":true,"filters":[{"alias":"foo","condition":"\"foo\" in Tags","desc":"This filter will...","enabled":true,"id":"Ut pariatur qui voluptatibus.","name":"fetch","nbError":10,"nbSuccess":10,"props":"-"},{"alias":"foo","condition":"\"foo\" in Tags","desc":"This filter will...","enabled":true,"id":"Ut pariatur qui voluptatibus.","name":"fetch","nbError":10,"nbSuccess":10,"props":"-"}],"id":"Sint tenetur commodi soluta similique.","name":"fetch","nbError":10,"nbSuccess":10,"props":"-"},"required":["id","alias","name","desc","condition","props"]},"OutputResponseCollection":{"title":"Mediatype identifier: application/vnd.feedpushr.output.v2+json; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/OutputResponse"},"description":"OutputResponseCollection is the media type for an array of OutputResponse (default view)","example":[{"alias":"foo","condition":"\"foo\" in Tags","desc":"New articles are sent as JSON document to...","enabled":true,"filters":[{"alias":"foo","condition":"\"foo\" in Tags","desc":"This filter will...","enabled":true,"id":"Ut pariatur qui voluptatibus.","name":"fetch","nbError":10,"nbSuccess":10,"props":"-"},{"alias":"foo","condition":"\"foo\" in Tags","desc":"This filter will...","enabled":true,"id":"Ut pariatur qui voluptatibus.","name":"fetch","nbError":10,"nbSuccess":10,"props":"-"}],"id":"Sint tenetur commodi soluta similique.","name":"fetch","nbError":10,"nbSuccess":10,"props":"-"}]},"OutputSpecResponse":{"title":"Mediatype identifier: application/vnd.feedpushr.output-spec.v2+json; view=default","type":"object","properties":{"desc":{"type":"string","description":"Description of the output channel","example":"New articles are sent as JSON document to..."},"name":{"type":"string","description":"Name of the output channel","example":"fetch"},"props":{"$ref":"#/definitions/PropSpecCollection"}},"description":"The output channel specification (default view)","example":{"desc":"New articles are sent as JSON document to...","name":"fetch","props":[{"desc":"New articles are sent as JSON document to...","name":"url","options":{"Veritatis laudantium autem deserunt saepe.":"Consequuntur id earum accusantium quidem non."},"type":"text"}]},"required":["name","desc","props"]},"OutputSpecResponseCollection":{"title":"Mediatype identifier: application/vnd.feedpushr.output-spec.v2+json; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/OutputSpecResponse"},"description":"OutputSpecResponseCollection is the media type for an array of OutputSpecResponse (default view)","example":[{"desc":"New articles are sent as JSON document to...","name":"fetch","props":[{"desc":"New articles are sent as JSON document to...","name":"url","options":{"Veritatis laudantium autem deserunt saepe.":"Consequuntur id earum accusantium quidem non."},"type":"text"}]}]},"PropSpec":{"title":"Mediatype identifier: application/vnd.feedpushr.prop-spec.v2+json; view=default","type":"object","properties":{"desc":{"type":"string","description":"Description of the output channel","example":"New articles are sent as JSON document to..."},"name":{"type":"string","description":"Name of the property","example":"url"},"options":{"type":"object","description":"Property options","example":{"Veritatis laudantium autem deserunt saepe.":"Consequuntur id earum accusantium quidem non."},"additionalProperties":true},"type":{"type":"string","description":"Property type ('text', 'url', ...)","example":"text"}},"description":"The specification of a property (default view)","example":{"desc":"New articles are sent as JSON document to...","name":"url","options":{"Veritatis laudantium autem deserunt saepe.":"Consequuntur id earum accusantium quidem non."},"type":"text"},"required":["name","desc","type"]},"PropSpecCollection":{"title":"Mediatype identifier: application/vnd.feedpushr.prop-spec.v2+json; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/PropSpec"},"description":"PropSpecCollection is the media type for an array of PropSpec (default view)","example":[{"desc":"New articles are sent as JSON document to...","name":"url","options":{"Veritatis laudantium autem deserunt saepe.":"Consequuntur id earum accusantium quidem non."},"type":"text"},{"desc":"New articles are sent as JSON document to...","name":"url","options":{"Veritatis laudantium autem deserunt saepe.":"Consequuntur id earum accusantium quidem non."},"type":"text"}]},"UpdateFilterOutputPayload":{"title":"UpdateFilterOutputPayload","type":"object","properties":{"alias":{"type":"string","description":"Alias of the filter","example":"foo"},"condition":{"type":"string","description":"Conditional expression of the output","example":"\"foo\" in Tags"},"enabled":{"type":"boolean","description":"Filter status","default":false,"example":"-"},"props":{"type":"object","description":"Filter properties","example":"-","additionalProperties":true}},"example":{"alias":"foo","condition":"\"foo\" in Tags","enabled":"-","props":"-"}},"UpdateOutputPayload":{"title":"UpdateOutputPayload","type":"object","properties":{"alias":{"type":"string","description":"Alias of the output","example":"foo"},"condition":{"type":"string","description":"Conditional expression of the output","example":"\"foo\" in Tags"},"enabled":{"type":"boolean","description":"Output status","default":false,"example":"-"},"props":{"type":"object","description":"Output properties","example":"-","additionalProperties":true}},"example":{"alias":"foo","condition":"\"foo\" in Tags","enabled":"-","props":"-"}},"error":{"title":"Mediatype identifier: application/vnd.goa.error; view=default","type":"object","properties":{"code":{"type":"string","description":"an application-specific error code, expressed as a string value.","example":"invalid_value"},"detail":{"type":"string","description":"a human-readable explanation specific to this occurrence of the problem.","example":"Value of ID must be an integer"},"id":{"type":"string","description":"a unique identifier for this particular occurrence of the problem.","example":"3F1FKVRR"},"meta":{"type":"object","description":"a meta object containing non-standard meta-information about the error.","example":{"timestamp":1458609066},"additionalProperties":true},"status":{"type":"string","description":"the HTTP status code applicable to this problem, expressed as a string value.","example":"400"}},"description":"Error response media type (default view)","example":{"code":"invalid_value","detail":"Value of ID must be an integer","id":"3F1FKVRR","meta":{"timestamp":1458609066},"status":"400"}}},"responses":{"Accepted":{"description":"Accepted"},"NoContent":{"description":"No Content"},"NotFound":{"description":"Not Found"},"OK":{"description":"OK"}},"externalDocs":{"description":"feedpushr guide","url":"https://github.com/ncarlier/feedpusher/README.md"}}