Skip to content

Commit

Permalink
feat(firebaseml): update the API
Browse files Browse the repository at this point in the history
#### firebaseml:v1
The following keys were changed:
- resources.operations.methods.cancel.description
- resources.operations.methods.delete.description
- resources.operations.methods.list.description
- schemas.Empty.description
- schemas.ModelOperationMetadata.description
- schemas.ModelOperationMetadata.properties.name.description
- schemas.Operation.description
- schemas.Operation.properties.done.description
- schemas.Operation.properties.metadata.description
- schemas.Operation.properties.name.description
- schemas.Operation.properties.response.description
- schemas.Status.description
- schemas.Status.properties.details.description
- schemas.Status.properties.message.description

#### firebaseml:v1beta2
The following keys were added:
- schemas.Model.properties.activeOperations.readOnly
- schemas.Model.properties.createTime.readOnly
- schemas.Model.properties.etag.readOnly
- schemas.Model.properties.modelHash.readOnly
- schemas.Model.properties.updateTime.readOnly
- schemas.ModelState.properties.validationError.readOnly
- schemas.TfLiteModel.properties.managedUpload.readOnly
- schemas.TfLiteModel.properties.sizeBytes.readOnly

The following keys were changed:
- resources.projects.resources.models.methods.create.description
- resources.projects.resources.models.methods.create.parameters.parent.description
- resources.projects.resources.models.methods.delete.parameters.name.description
- resources.projects.resources.models.methods.get.parameters.name.description
- resources.projects.resources.models.methods.list.parameters.filter.description
- resources.projects.resources.models.methods.list.parameters.parent.description
- resources.projects.resources.models.methods.patch.parameters.name.description
- resources.projects.resources.operations.methods.get.description
- schemas.Empty.description
- schemas.ListModelsResponse.properties.nextPageToken.description
- schemas.Model.properties.displayName.description
- schemas.Model.properties.etag.description
- schemas.Model.properties.name.description
- schemas.Model.properties.state.description
- schemas.ModelOperationMetadata.description
- schemas.ModelOperationMetadata.properties.name.description
- schemas.ModelState.description
- schemas.ModelState.properties.validationError.description
- schemas.Operation.description
- schemas.Operation.properties.done.description
- schemas.Operation.properties.metadata.description
- schemas.Operation.properties.name.description
- schemas.Operation.properties.response.description
- schemas.Status.description
- schemas.Status.properties.details.description
- schemas.Status.properties.message.description
- schemas.TfLiteModel.properties.gcsTfliteUri.description
- schemas.TfLiteModel.properties.managedUpload.description
  • Loading branch information
yoshi-automation authored and JustinBeckwith committed Aug 5, 2020
1 parent 6538587 commit 900d029
Show file tree
Hide file tree
Showing 4 changed files with 71 additions and 70 deletions.
30 changes: 15 additions & 15 deletions discovery/firebaseml-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"flatPath": "v1/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "firebaseml.operations.cancel",
Expand Down Expand Up @@ -136,7 +136,7 @@
]
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "firebaseml.operations.delete",
Expand All @@ -161,7 +161,7 @@
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1/operations",
"httpMethod": "GET",
"id": "firebaseml.operations.list",
Expand Down Expand Up @@ -204,7 +204,7 @@
}
}
},
"revision": "20200527",
"revision": "20200803",
"rootUrl": "https://firebaseml.googleapis.com/",
"schemas": {
"CancelOperationRequest": {
Expand All @@ -214,7 +214,7 @@
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
Expand All @@ -238,7 +238,7 @@
"type": "object"
},
"ModelOperationMetadata": {
"description": "This is returned in the longrunning operations\nfor create/update.",
"description": "This is returned in the longrunning operations for create/update.",
"id": "ModelOperationMetadata",
"properties": {
"basicOperationStatus": {
Expand All @@ -255,18 +255,18 @@
"type": "string"
},
"name": {
"description": "The name of the model we are creating/updating\nThe name must have the form `projects/{project_id}/models/{model_id}`",
"description": "The name of the model we are creating/updating The name must have the form `projects/{project_id}/models/{model_id}`",
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"error": {
Expand All @@ -278,26 +278,26 @@
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.",
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).",
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
Expand All @@ -306,7 +306,7 @@
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
Expand All @@ -317,7 +317,7 @@
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
Expand Down
Loading

0 comments on commit 900d029

Please sign in to comment.