mirror of
https://github.com/googleforgames/open-match.git
synced 2025-03-29 13:41:23 +00:00
04f676a221
* Enabled telemetry when generating assets (#945) * Optimize developer workflow (#943) * Remove k8s probes in example mmfs and evaluator (#942) * Update release template (#944) * Fix scale test based on the config changes (#948) * Update go.mod dendencies (#949) * Disable Redis initContainer by default (#941) * Bumped helm version and dependencies versions for k8s 1.16 support (#938) * Disable WI in create-gke-cluster step (#947) * Turn off subcharts by default (#954) * Split out MMF and Evaluator install from open-match-demo (#956) * Move Match Function installation to the matchmaker.yaml - since customization.yaml is now optional when using default evaluator installation steps (#957) * Define Makefile and RBAC rules for open-match-demo namespace migration (#958) * Have MMF and Evaluator in customize chart use different configs (#959) * Fix namespace dependency on CI (#967) * Update tutorial modules to use v0.8 rc (#963) * A Tutorial to customize the evaluator (#970) * Publish helm index.yaml file to helm install open-match (#962) * Generate static yaml to install open match demo (#969) * Generate static yaml to install open match demo * Update Makefile to sync with the latest demo update * Add a tutorial for using the default evaluator (#961) * Add the solution for Matchmaker 101 tutorial to a separate solution folder. (#971) * Add logging to the default evaluator (#964) * Add solution folder to Matchmaker 102 tutorial (#973) * Ignore reaper error (#974) * Harden the open-match parent chart (#972) * Fix typo in folder name (#975) * More cleanup (#976) * Remove redundant matchmaker scaffold and update tutorials (#979) * Update release numbers to 0.8, and presubmit's formatting changes
479 lines
23 KiB
JSON
479 lines
23 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "Backend",
|
|
"version": "1.0",
|
|
"contact": {
|
|
"name": "Open Match",
|
|
"url": "https://open-match.dev",
|
|
"email": "open-match-discuss@googlegroups.com"
|
|
},
|
|
"license": {
|
|
"name": "Apache 2.0 License",
|
|
"url": "https://github.com/googleforgames/open-match/blob/master/LICENSE"
|
|
}
|
|
},
|
|
"schemes": [
|
|
"http",
|
|
"https"
|
|
],
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"paths": {
|
|
"/v1/backend/matches:fetch": {
|
|
"post": {
|
|
"summary": "FetchMatches triggers a MatchFunction with the specified MatchProfiles, while each MatchProfile \nreturns a set of match proposals. FetchMatches method streams the results back to the caller.\nFetchMatches immediately returns an error if it encounters any execution failures.\n - If the synchronizer is enabled, FetchMatch will then call the synchronizer to deduplicate proposals with overlapped tickets.",
|
|
"operationId": "FetchMatches",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.(streaming responses)",
|
|
"schema": {
|
|
"$ref": "#/x-stream-definitions/openmatchFetchMatchesResponse"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Returned when the resource does not exist.",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "string"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/openmatchFetchMatchesRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"Backend"
|
|
]
|
|
}
|
|
},
|
|
"/v1/backend/tickets:assign": {
|
|
"post": {
|
|
"summary": "AssignTickets overwrites the Assignment field of the input TicketIds.",
|
|
"operationId": "AssignTickets",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/openmatchAssignTicketsResponse"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Returned when the resource does not exist.",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "string"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/openmatchAssignTicketsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"Backend"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"openmatchAssignTicketsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"ticket_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "TicketIds is a list of strings representing Open Match generated Ids which apply to an Assignment."
|
|
},
|
|
"assignment": {
|
|
"$ref": "#/definitions/openmatchAssignment",
|
|
"description": "An Assignment specifies game connection related information to be associated with the TicketIds."
|
|
}
|
|
}
|
|
},
|
|
"openmatchAssignTicketsResponse": {
|
|
"type": "object"
|
|
},
|
|
"openmatchAssignment": {
|
|
"type": "object",
|
|
"properties": {
|
|
"connection": {
|
|
"type": "string",
|
|
"description": "Connection information for this Assignment."
|
|
},
|
|
"error": {
|
|
"$ref": "#/definitions/rpcStatus",
|
|
"description": "Error when finding an Assignment for this Ticket."
|
|
},
|
|
"extensions": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"$ref": "#/definitions/protobufAny"
|
|
},
|
|
"description": "Customized information not inspected by Open Match, to be used by the match\nmaking function, evaluator, and components making calls to Open Match.\nOptional, depending on the requirements of the connected systems."
|
|
}
|
|
},
|
|
"description": "An Assignment represents a game server assignment associated with a Ticket. Open\nmatch does not require or inspect any fields on assignment."
|
|
},
|
|
"openmatchDoubleRangeFilter": {
|
|
"type": "object",
|
|
"properties": {
|
|
"double_arg": {
|
|
"type": "string",
|
|
"description": "Name of the ticket's search_fields.double_args this Filter operates on."
|
|
},
|
|
"max": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"description": "Maximum value. Defaults to positive infinity (any value above minv)."
|
|
},
|
|
"min": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"description": "Minimum value. Defaults to 0."
|
|
}
|
|
},
|
|
"title": "Filters numerical values to only those within a range.\n double_arg: \"foo\"\n max: 10\n min: 5\nmatches:\n {\"foo\": 5}\n {\"foo\": 7.5}\n {\"foo\": 10}\ndoes not match:\n {\"foo\": 4}\n {\"foo\": 10.01}\n {\"foo\": \"7.5\"}\n {}"
|
|
},
|
|
"openmatchFetchMatchesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"config": {
|
|
"$ref": "#/definitions/openmatchFunctionConfig",
|
|
"title": "FunctionConfig specifies a MMF address and client type for Backend to establish connections with the MMF"
|
|
},
|
|
"profiles": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/openmatchMatchProfile"
|
|
},
|
|
"description": "MatchProfiles that will be sent to thhe MMF specified in the FunctionConfig."
|
|
}
|
|
}
|
|
},
|
|
"openmatchFetchMatchesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"match": {
|
|
"$ref": "#/definitions/openmatchMatch",
|
|
"description": "A Match generated by the user-defined MMF with the specified MatchProfiles.\nA valid Match response will contain at least one ticket."
|
|
}
|
|
}
|
|
},
|
|
"openmatchFunctionConfig": {
|
|
"type": "object",
|
|
"properties": {
|
|
"host": {
|
|
"type": "string"
|
|
},
|
|
"port": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"type": {
|
|
"$ref": "#/definitions/openmatchFunctionConfigType"
|
|
}
|
|
},
|
|
"title": "FunctionConfig specifies a MMF address and client type for Backend to establish connections with the MMF"
|
|
},
|
|
"openmatchFunctionConfigType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"GRPC",
|
|
"REST"
|
|
],
|
|
"default": "GRPC"
|
|
},
|
|
"openmatchMatch": {
|
|
"type": "object",
|
|
"properties": {
|
|
"match_id": {
|
|
"type": "string",
|
|
"description": "A Match ID that should be passed through the stack for tracing."
|
|
},
|
|
"match_profile": {
|
|
"type": "string",
|
|
"description": "Name of the match profile that generated this Match."
|
|
},
|
|
"match_function": {
|
|
"type": "string",
|
|
"description": "Name of the match function that generated this Match."
|
|
},
|
|
"tickets": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/openmatchTicket"
|
|
},
|
|
"description": "Tickets belonging to this match."
|
|
},
|
|
"rosters": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/openmatchRoster"
|
|
},
|
|
"title": "Set of Rosters that comprise this Match"
|
|
},
|
|
"extensions": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"$ref": "#/definitions/protobufAny"
|
|
},
|
|
"description": "Customized information not inspected by Open Match, to be used by the match\nmaking function, evaluator, and components making calls to Open Match.\nOptional, depending on the requirements of the connected systems."
|
|
}
|
|
},
|
|
"description": "A Match is used to represent a completed match object. It can be generated by\na MatchFunction as a proposal or can be returned by OpenMatch as a result in\nresponse to the FetchMatches call.\nWhen a match is returned by the FetchMatches call, it should contain at least \none ticket to be considered as valid."
|
|
},
|
|
"openmatchMatchProfile": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Name of this match profile."
|
|
},
|
|
"pools": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/openmatchPool"
|
|
},
|
|
"description": "Set of pools to be queried when generating a match for this MatchProfile.\nThe pool names can be used in empty Rosters to specify composition of a\nmatch."
|
|
},
|
|
"rosters": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/openmatchRoster"
|
|
},
|
|
"description": "Set of Rosters for this match request. Could be empty Rosters used to\nindicate the composition of the generated Match or they could be partially\npre-populated Ticket list to be used in scenarios such as backfill / join\nin progress."
|
|
},
|
|
"extensions": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"$ref": "#/definitions/protobufAny"
|
|
},
|
|
"description": "Customized information not inspected by Open Match, to be used by the match\nmaking function, evaluator, and components making calls to Open Match.\nOptional, depending on the requirements of the connected systems."
|
|
}
|
|
},
|
|
"description": "A MatchProfile is Open Match's representation of a Match specification. It is\nused to indicate the criteria for selecting players for a match. A\nMatchProfile is the input to the API to get matches and is passed to the\nMatchFunction. It contains all the information required by the MatchFunction\nto generate match proposals."
|
|
},
|
|
"openmatchPool": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "A developer-chosen human-readable name for this Pool."
|
|
},
|
|
"double_range_filters": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/openmatchDoubleRangeFilter"
|
|
},
|
|
"description": "Set of Filters indicating the filtering criteria. Selected players must\nmatch every Filter."
|
|
},
|
|
"string_equals_filters": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/openmatchStringEqualsFilter"
|
|
}
|
|
},
|
|
"tag_present_filters": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/openmatchTagPresentFilter"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"openmatchRoster": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "A developer-chosen human-readable name for this Roster."
|
|
},
|
|
"ticket_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Tickets belonging to this Roster."
|
|
}
|
|
},
|
|
"description": "A Roster is a named collection of Ticket IDs. It exists so that a Tickets\nassociated with a Match can be labelled to belong to a team, sub-team etc. It\ncan also be used to represent the current state of a Match in scenarios such\nas backfill, join-in-progress etc."
|
|
},
|
|
"openmatchSearchFields": {
|
|
"type": "object",
|
|
"properties": {
|
|
"double_args": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "number",
|
|
"format": "double"
|
|
},
|
|
"description": "Float arguments. Filterable on ranges."
|
|
},
|
|
"string_args": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "String arguments. Filterable on equality."
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Filterable on presence or absence of given value."
|
|
}
|
|
},
|
|
"description": "Search fields are the fields which Open Match is aware of, and can be used\nwhen specifying filters."
|
|
},
|
|
"openmatchStringEqualsFilter": {
|
|
"type": "object",
|
|
"properties": {
|
|
"string_arg": {
|
|
"type": "string",
|
|
"description": "Name of the ticket's search_fields.string_args this Filter operates on."
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "Filters strings exactly equaling a value.\n string_arg: \"foo\"\n value: \"bar\"\nmatches:\n {\"foo\": \"bar\"}\ndoes not match:\n {\"foo\": \"baz\"}\n {\"bar\": \"foo\"}\n {}"
|
|
},
|
|
"openmatchTagPresentFilter": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tag": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "Filters to the tag being present on the search_fields.\n tag: \"foo\"\nmatches:\n [\"foo\"]\n [\"bar\",\"foo\"]\ndoes not match:\n [\"bar\"]\n []"
|
|
},
|
|
"openmatchTicket": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Id represents an auto-generated Id issued by Open Match."
|
|
},
|
|
"assignment": {
|
|
"$ref": "#/definitions/openmatchAssignment",
|
|
"description": "An Assignment represents a game server assignment associated with a Ticket. \nOpen Match does not require or inspect any fields on Assignment."
|
|
},
|
|
"search_fields": {
|
|
"$ref": "#/definitions/openmatchSearchFields",
|
|
"description": "Search fields are the fields which Open Match is aware of, and can be used\nwhen specifying filters."
|
|
},
|
|
"extensions": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"$ref": "#/definitions/protobufAny"
|
|
},
|
|
"description": "Customized information not inspected by Open Match, to be used by the match\nmaking function, evaluator, and components making calls to Open Match.\nOptional, depending on the requirements of the connected systems."
|
|
}
|
|
},
|
|
"description": "A Ticket is a basic matchmaking entity in Open Match. A Ticket represents either an\nindividual 'Player' or a 'Group' of players. Open Match will not interpret\nwhat the Ticket represents but just treat it as a matchmaking unit with a set\nof SearchFields. Open Match stores the Ticket in state storage and enables an\nAssignment to be associated with this Ticket."
|
|
},
|
|
"protobufAny": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type_url": {
|
|
"type": "string",
|
|
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"format": "byte",
|
|
"description": "Must be a valid serialized protocol buffer of the above specified type."
|
|
}
|
|
},
|
|
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := \u0026pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }"
|
|
},
|
|
"rpcStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code]."
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client."
|
|
},
|
|
"details": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/protobufAny"
|
|
},
|
|
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
|
|
}
|
|
},
|
|
"description": "- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error\nmessage, and error details. The error code should be an enum value of\n[google.rpc.Code][google.rpc.Code], but it may accept additional error codes\nif needed. The error message should be a developer-facing English message\nthat helps developers *understand* and *resolve* the error. If a localized\nuser-facing error message is needed, put the localized message in the error\ndetails or localize it in the client. The optional error details may contain\narbitrary information about the error. There is a predefined set of error\ndetail types in the package `google.rpc` that can be used for common error\nconditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
|
|
"title": "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). The error model is designed to be:"
|
|
},
|
|
"runtimeStreamError": {
|
|
"type": "object",
|
|
"properties": {
|
|
"grpc_code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"http_code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"http_status": {
|
|
"type": "string"
|
|
},
|
|
"details": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/protobufAny"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-stream-definitions": {
|
|
"openmatchFetchMatchesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"result": {
|
|
"$ref": "#/definitions/openmatchFetchMatchesResponse"
|
|
},
|
|
"error": {
|
|
"$ref": "#/definitions/runtimeStreamError"
|
|
}
|
|
},
|
|
"title": "Stream result of openmatchFetchMatchesResponse"
|
|
}
|
|
},
|
|
"externalDocs": {
|
|
"description": "Open Match Documentation",
|
|
"url": "https://open-match.dev/site/docs/"
|
|
}
|
|
}
|