{ "swagger": "2.0", "info": { "title": "proto-gorm/api/proto-gorm.proto", "version": "version not set" }, "tags": [ { "name": "IntPointService" }, { "name": "IntPointTxn" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/v1/point": { "post": { "summary": "The convention requires the rpc names have Create/Read/Update/List/Delete\nas a prefix. The type is inferred from the response (except for delete),\nso multiple objects can have CURDL handlers in the same service, provided\nthey are given unique suffixes", "operationId": "IntPointService_Create", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/proto_gormCreateIntPointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "body", "description": "Convention dictates that this field be of the given type, and be\nnamed 'payload' in order to autogenerate the handler", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto_gormIntPoint" } } ], "tags": [ "IntPointService" ] } }, "/v1/point/{id}": { "get": { "operationId": "IntPointService_Read", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/proto_gormReadIntPointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "id", "description": "For a read request, the id field is the only to be specified", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "tags": [ "IntPointService" ] }, "delete": { "summary": "rpc List ( ListIntPointRequest ) returns ( ListIntPointResponse ) {\n option (google.api.http) = {\n get: \"/v1/point\"\n };\n}\nrpc ListSomething( google.protobuf.Empty ) returns ( ListSomethingResponse ) {}", "operationId": "IntPointService_Delete", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/proto_gormDeleteIntPointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "id", "description": "Only the id is needed for a delete request", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "tags": [ "IntPointService" ] } }, "/v1/point/{payload.id}": { "patch": { "operationId": "IntPointService_Update", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/proto_gormUpdateIntPointResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "payload.id", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proto_gormIntPoint" } }, { "name": "gerogeriGegege", "in": "query", "required": false, "type": "string" } ], "tags": [ "IntPointService" ] } } }, "definitions": { "proto_gormCreateIntPointResponse": { "type": "object", "properties": { "result": { "$ref": "#/definitions/proto_gormIntPoint", "title": "Convention also requires that the return type be the same and named 'result'" } } }, "proto_gormDeleteIntPointResponse": { "type": "object", "title": "By convention, on DELETE no response data is given, so either a\ngoogle.protobuf.empty, or an empty struct is sufficient" }, "proto_gormIntPoint": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "x": { "type": "integer", "format": "int32" }, "y": { "type": "integer", "format": "int32" } }, "title": "IntPoint is a basic message type representing a single cartesian point\nthat we want to store in a database" }, "proto_gormReadIntPointResponse": { "type": "object", "properties": { "result": { "$ref": "#/definitions/proto_gormIntPoint", "title": "Again the type with 'result' name" } } }, "proto_gormUpdateIntPointResponse": { "type": "object", "properties": { "result": { "$ref": "#/definitions/proto_gormIntPoint" } } }, "proto_gormUpdateSetIntPointResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/proto_gormIntPoint" } } } }, "protobufAny": { "type": "object", "properties": { "@type": { "type": "string" } }, "additionalProperties": {} }, "rpcStatus": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/definitions/protobufAny" } } } }, "v1Field": { "type": "object", "properties": { "name": { "type": "string" }, "subs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/v1Field" } } }, "description": "Field represents a single field for an object.\nIt contains fields name and also may contain a group of sub-fields for cases\nwhen a fields represents some structure." }, "v1FieldSelection": { "type": "string", "format": "string", "properties": { "fields": { "type": "object", "additionalProperties": { "$ref": "#/definitions/v1Field" } } }, "description": "atlas.api.field_selection", "title": "FieldSelection represents a group of fields for some object.\nMain use case for if is to store information about object fields that\nneed to be ratained prior to sending object as a response" } } }