package golem.apidefinition.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc CreateApiDefinition (CreateApiDefinitionRequest, CreateApiDefinitionResponse)

  api_definition_service.proto:10

  message CreateApiDefinitionRequest

  api_definition_service.proto:27

  • oneof api_definition

    • ApiDefinitionRequest definition = 1

    • string openapi = 2

  message CreateApiDefinitionResponse

  api_definition_service.proto:34

  • oneof result

    • ApiDefinition success = 1

    • ApiDefinitionError error = 2

• rpc UpdateApiDefinition (UpdateApiDefinitionRequest, UpdateApiDefinitionResponse)

  api_definition_service.proto:11

  message UpdateApiDefinitionRequest

  api_definition_service.proto:41

  • oneof api_definition

    • ApiDefinitionRequest definition = 1

    • string openapi = 2

  message UpdateApiDefinitionResponse

  api_definition_service.proto:48

  • oneof result

    • ApiDefinition success = 1

    • ApiDefinitionError error = 2

• rpc GetApiDefinition (GetApiDefinitionRequest, GetApiDefinitionResponse)

  api_definition_service.proto:12

  message GetApiDefinitionRequest

  api_definition_service.proto:55

  • optional ApiDefinitionId api_definition_id = 1

  • string version = 2

  message GetApiDefinitionResponse

  api_definition_service.proto:60

  • oneof result

    • ApiDefinition success = 1

    • ApiDefinitionError error = 2

• rpc GetApiDefinitionVersions (GetApiDefinitionVersionsRequest, GetApiDefinitionVersionsResponse)

  api_definition_service.proto:13

  message GetApiDefinitionVersionsRequest

  api_definition_service.proto:67

  • optional ApiDefinitionId api_definition_id = 1

  message GetApiDefinitionVersionsResponse

  api_definition_service.proto:71

  • oneof result

    • ApiDefinitionList success = 1

    • ApiDefinitionError error = 2

• rpc GetAllApiDefinitions (GetAllApiDefinitionsRequest, GetAllApiDefinitionsResponse)

  api_definition_service.proto:14

  message GetAllApiDefinitionsRequest

  api_definition_service.proto:90

  (message has no fields)

  message GetAllApiDefinitionsResponse

  api_definition_service.proto:92

  • oneof result

    • ApiDefinitionList success = 1

    • ApiDefinitionError error = 2

• rpc DeleteApiDefinition (DeleteApiDefinitionRequest, DeleteApiDefinitionResponse)

  api_definition_service.proto:15

  message DeleteApiDefinitionRequest

  api_definition_service.proto:78

  • optional ApiDefinitionId api_definition_id = 1

  • string version = 2

  message DeleteApiDefinitionResponse

  api_definition_service.proto:83

  • oneof result

    • common.Empty success = 1

    • ApiDefinitionError error = 2

Used in: CreateApiDefinitionResponse, DeleteApiDefinitionResponse, GetAllApiDefinitionsResponse, GetApiDefinitionResponse, GetApiDefinitionVersionsResponse, UpdateApiDefinitionResponse

• oneof error

  • common.ErrorsBody bad_request = 1

  • RouteValidationErrorsBody invalid_routes = 2

  • common.ErrorBody unauthorized = 3

  • common.ErrorBody limit_exceeded = 4

  • common.ErrorBody not_found = 5

  • common.ErrorBody already_exists = 6

  • common.ErrorBody internal_error = 7

  • common.ErrorBody not_draft = 8

Used in: CreateApiDefinitionRequest, UpdateApiDefinitionRequest

• optional ApiDefinitionId id = 1

• string version = 2

• oneof definition

  • HttpApiDefinition http = 3

• bool draft = 4

• string method = 1

• string path = 2

• optional component.ComponentId component = 3

• string detail = 4

Used in: ApiDefinitionError

• repeated string errors = 1