A peer-to-peer stack for code collaboration
Swagger spec under version control (#591)
James Haydon8bb20442f124
diff --git a/cloudbuild.yaml b/cloudbuild.yamlindex 23e87a8..8590887 100644--- a/cloudbuild.yaml+++ b/cloudbuild.yaml@@ -139,7 +139,7 @@ steps:docker push "$image_name:$tag"fi- - id: "Build reference document"+ - id: "Build reference document and swagger spec"waitFor:- "Build"name: $_BUILD_IMAGE@@ -151,11 +151,16 @@ steps:set -euxo pipefailmv docs/source/reference.rst oldref+ mv docs/source/daemon-api.yaml oldswaggerRADPATH="$(pwd)/rad" stack exec radicle-ref-docif ! (diff oldref docs/source/reference.rst); thenecho "Reference docs are not checked in"exit 1fi+ if ! (diff oldswagger docs/source/daemon-api.yaml); then+ echo "Daemon swagger spec is not checked in"+ exit 1+ fi- id: "Check tutorial"waitFor:diff --git a/docs/source/daemon-api.yaml b/docs/source/daemon-api.yamlnew file mode 100644index 0000000..9b99a9c--- /dev/null+++ b/docs/source/daemon-api.yaml@@ -0,0 +1,134 @@+swagger: '2.0'+info:+ version: 0.0.0+ title: Radicle daemon+ description: The radicle-daemon; a long-running background process which materialises+ the state of remote IPFS machines on the users PC, and writes to those IPFS machines+ the user is an owner of.+definitions:+ QueryResponseF:+ required:+ - result+ type: object+ properties:+ result:+ $ref: '#/definitions/RadicleValue'+ Swagger:+ type: object+ description: This swagger spec.+ SendResponseF:+ required:+ - results+ type: object+ properties:+ results:+ items:+ $ref: '#/definitions/RadicleValue'+ type: array+ RadicleValue:+ type: string+ description: A radicle value formatted according to radicle's S-expression syntax.+ NewResponse:+ required:+ - machineId+ type: object+ properties:+ machineId:+ $ref: '#/definitions/MachineId'+ QueryRequestF:+ required:+ - expression+ type: object+ properties:+ expression:+ $ref: '#/definitions/RadicleValue'+ MachineId:+ type: string+ description: The ID (i.e. IPNS name) of an IPFS machine.+ SendRequestF:+ required:+ - expressions+ type: object+ properties:+ expressions:+ items:+ $ref: '#/definitions/RadicleValue'+ type: array+paths:+ /v0/docs:+ get:+ responses:+ '200':+ schema:+ $ref: '#/definitions/Swagger'+ description: ''+ produces:+ - application/json;charset=utf-8+ /v0/machines/new:+ post:+ responses:+ '200':+ schema:+ $ref: '#/definitions/NewResponse'+ description: ''+ produces:+ - application/json;charset=utf-8+ - application/radicle+ /v0/machines/{machineId}/query:+ post:+ consumes:+ - application/radicle+ - application/json;charset=utf-8+ - application/radicle-json+ responses:+ '404':+ description: '`machineId` not found'+ '400':+ description: Invalid `body`+ '200':+ schema:+ $ref: '#/definitions/QueryResponseF'+ description: ''+ produces:+ - application/radicle+ - application/json;charset=utf-8+ - application/radicle-json+ parameters:+ - required: true+ in: path+ name: machineId+ type: string+ - required: true+ schema:+ $ref: '#/definitions/QueryRequestF'+ in: body+ name: body+ /v0/machines/{machineId}/send:+ post:+ consumes:+ - application/radicle+ - application/json;charset=utf-8+ - application/radicle-json+ responses:+ '404':+ description: '`machineId` not found'+ '400':+ description: Invalid `body`+ '200':+ schema:+ $ref: '#/definitions/SendResponseF'+ description: ''+ produces:+ - application/radicle+ - application/json;charset=utf-8+ - application/radicle-json+ parameters:+ - required: true+ in: path+ name: machineId+ type: string+ - required: true+ schema:+ $ref: '#/definitions/SendRequestF'+ in: body+ name: body