Fetch Available Packages in Repository - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Fetch Available Packages in Repository","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/ba77f57b-02d1-3e26-99d6-40948a543c9c","info":{"title":"Crosswork AppManager API","description":"AppManager provides API methods for managing Crosswork applications that run on top of Kubernetes. This includes install-activate, deactivate, update, and uninstall for these applications. It also provides APIs to manage the internal package repository from which application installs are carried out.","version":"3.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/APP/app-overview.md"}},"openapi":"3.0.0","servers":[{"url":"/crosswork/platform/v2"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer token for API authentication."}}},"spec":{"description":"Returns the list of apps available in CW repository. API doesnt support cw_query (SQL like filter).","summary":"Fetch Available Packages in Repository","operationId":"ApplicationManagerService_GetPackagesInRepository","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"package_groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","title":"Id for application"},"name":{"type":"string","title":"Marketing application name"},"category":{"type":"string","enum":["UNKNOWN_CATEGORY","EXTERNAL_APP","PLATFORM"],"default":"UNKNOWN_CATEGORY","description":"- EXTERNAL_APP: INTERNAL_APP = 1; reserved\n - PLATFORM: INFRA","title":"App Object Category to indicate whether it app is external app or an internal app or platform","example":"EXTERNAL_APP","$$ref":"#/components/schemas/app_managerCategory"}},"title":"Repo Package Name id groups","example":{"id":"pkgGroup1234","name":"Example Package Group","category":"EXTERNAL_APP"},"$$ref":"#/components/schemas/app_managerPackageNameIdGroups"},"title":"Repository data"},"query_options":{"type":"object","properties":{"filters":{"type":"object","properties":{"filter_fields":{"type":"array","items":{"type":"object","properties":{"key_value":{"type":"object","properties":{"key":{"type":"string"},"string_value":{"type":"string","title":"Commented out is reserved for future use.\nbytes bytes_value = 2;"},"bool_value":{"type":"boolean"},"uint64_value":{"type":"string","format":"uint64","title":"uint32 uint32_value = 5;"},"sint64_value":{"type":"string","format":"int64","title":"sint32 sint32_value = 7;"},"double_value":{"type":"number","format":"double"}},"title":"Generic Key value message","example":{"key":"status","string_value":"ACTIVE"},"$$ref":"#/components/schemas/common_platformKeyValue"},"comparison_operator":{"type":"string","enum":["COMPARISON_UNKNOWN","CONTAINS","ICONTAINS","EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","GREATER_THAN","GREATER_THAN_OR_EQUAL","NOT_EQUAL"],"default":"COMPARISON_UNKNOWN","description":"- CONTAINS: STRING contains.Case sensitive May not be supported for all data types\n - ICONTAINS: STRING contains.Case Insensitive. May not be supported for all data types\n - EQUAL: Equal.\n - LESS_THAN: Commented ones are for future use\n Less than.\n - LESS_THAN_OR_EQUAL: // Less than or equal.\n - GREATER_THAN: // Greater than.\n - GREATER_THAN_OR_EQUAL: // Greater than or equal.\n - NOT_EQUAL: NOT EQUAL","title":"Comparison Operator","example":"EQUAL","$$ref":"#/components/schemas/common_platformComparisonOperator"}},"title":"Key Value filter set","example":{"key_value":{"key":"status","string_value":"ACTIVE"},"comparison_operator":"EQUAL"},"$$ref":"#/components/schemas/common_platformFilterKeyValue"},"title":"Key Value filters"},"logical_operator":{"type":"string","enum":["OPERATOR_LOGICAL_UNKNOWN","AND","OR"],"default":"OPERATOR_LOGICAL_UNKNOWN","description":"- AND: Logical AND\n - OR: Logical OR","title":"Logical Operator","example":"AND","$$ref":"#/components/schemas/common_platformLogicalOperator"},"sort_operator":{"type":"string","enum":["SORT_UNSPECIFIED","ASCENDING","DESCENDING"],"default":"SORT_UNSPECIFIED","description":"The sort direction.\n\n - SORT_UNSPECIFIED: Unspecified. This value must not be used.\n - ASCENDING: Ascending.\n - DESCENDING: Descending.","example":"ASCENDING","$$ref":"#/components/schemas/common_platformSortOperator"}},"title":"KeyValue Filter Set","example":{"filter_fields":[{"key_value":{"key":"status","string_value":"ACTIVE"},"comparison_operator":"EQUAL"}],"logical_operator":"AND","sort_operator":"ASCENDING"},"$$ref":"#/components/schemas/common_platformFilterKeyValueSet"},"cw_query":{"type":"object","properties":{"query":{"type":"string","title":"SQL like filter query\nselect * from robotnodedata where provider.provider.name='nso101'"}},"title":"SQL like CW query style","example":{"query":"select * from applications where status='ACTIVE'"},"$$ref":"#/components/schemas/common_platformCWQuery"},"pagination":{"type":"object","properties":{"page_token":{"type":"string","title":"Page token to echo back to get next page, is empty or page token is empty,\nthen there is no more results"},"page_size":{"type":"integer","format":"int64","title":"page_size"}},"title":"Pagination option","example":{"page_token":"","page_size":10},"$$ref":"#/components/schemas/common_platformPagination"}},"title":"Query Options","example":{"filters":{"filter_fields":[{"key_value":{"key":"status","string_value":"ACTIVE"},"comparison_operator":"EQUAL"}],"logical_operator":"AND","sort_operator":"ASCENDING"},"cw_query":{"query":"select * from applications where status='ACTIVE'"},"pagination":{"page_token":"","page_size":10}},"$$ref":"#/components/schemas/common_platformQueryOptions"},"result":{"type":"object","properties":{"request_result":{"type":"string","enum":["UNKNOWN_RESULT","REJECTED","ACCEPTED"],"default":"UNKNOWN_RESULT","description":"- REJECTED: Request has been rejected\n - ACCEPTED: Request has been accepted for processing","title":"Request - reply\nresponse","example":"ACCEPTED","$$ref":"#/components/schemas/app_managerRequestResult"},"error":{"type":"object","properties":{"message":{"type":"string","title":"Message is a textual description of reason for rejection, and can be safely passed on to operator through logs\nor UI"}},"title":"Error associated with an Object","example":{"message":"An error occurred due to invalid input."},"$$ref":"#/components/schemas/common_platformError"}},"description":"Result is used to convey whether an operation (individual or in a batch)\nhas been accepted or rejected. For sync API's an error or rejection indicates failure of operation.\nA string error message accompanies rejection to support troubleshooting. For notification objects,\nrejection represents failure to do intended operation.","example":{"request_result":"ACCEPTED","error":null},"$$ref":"#/components/schemas/app_managerResult"}},"title":"Get Application in repository which are composite type","example":{"package_groups":[{"id":"pkgGroup1234","name":"Example Package Group","category":"EXTERNAL_APP"}],"query_options":{"filters":null,"cw_query":null,"pagination":{"page_token":"","page_size":10}},"result":{"request_result":"ACCEPTED","error":null}},"$$ref":"#/components/schemas/app_managerGetPackagesInRepositoryResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"type_url":{"type":"string","description":"A URL/resource name whose content describes the type of the\nserialized protocol buffer message.\n\nFor URLs which use the scheme `http`, `https`, or no scheme, the\nfollowing restrictions and interpretations apply:\n\n* If no scheme is provided, `https` is assumed.\n* The last segment of the URL's path must represent the fully\n qualified name of the type (as in `path/google.protobuf.Duration`).\n The name should be in a canonical form (e.g., leading \".\" is\n not accepted).\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\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(&foo)) {\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 := &pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := &pb.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 }","$$ref":"#/components/schemas/protobufAny"}}},"example":{"error":"RuntimeException","code":500,"message":"An unexpected error occurred during execution.","details":[{"type_url":"type.googleapis.com/google.protobuf.Any","value":"Error details in binary format"}]},"$$ref":"#/components/schemas/gatewayruntimeError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"query_options":{"type":"object","properties":{"filters":{"type":"object","properties":{"filter_fields":{"type":"array","items":{"type":"object","properties":{"key_value":{"type":"object","properties":{"key":{"type":"string"},"string_value":{"type":"string","title":"Commented out is reserved for future use.\nbytes bytes_value = 2;"},"bool_value":{"type":"boolean"},"uint64_value":{"type":"string","format":"uint64","title":"uint32 uint32_value = 5;"},"sint64_value":{"type":"string","format":"int64","title":"sint32 sint32_value = 7;"},"double_value":{"type":"number","format":"double"}},"title":"Generic Key value message","example":{"key":"status","string_value":"ACTIVE"},"$$ref":"#/components/schemas/common_platformKeyValue"},"comparison_operator":{"type":"string","enum":["COMPARISON_UNKNOWN","CONTAINS","ICONTAINS","EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL","GREATER_THAN","GREATER_THAN_OR_EQUAL","NOT_EQUAL"],"default":"COMPARISON_UNKNOWN","description":"- CONTAINS: STRING contains.Case sensitive May not be supported for all data types\n - ICONTAINS: STRING contains.Case Insensitive. May not be supported for all data types\n - EQUAL: Equal.\n - LESS_THAN: Commented ones are for future use\n Less than.\n - LESS_THAN_OR_EQUAL: // Less than or equal.\n - GREATER_THAN: // Greater than.\n - GREATER_THAN_OR_EQUAL: // Greater than or equal.\n - NOT_EQUAL: NOT EQUAL","title":"Comparison Operator","example":"EQUAL","$$ref":"#/components/schemas/common_platformComparisonOperator"}},"title":"Key Value filter set","example":{"key_value":{"key":"status","string_value":"ACTIVE"},"comparison_operator":"EQUAL"},"$$ref":"#/components/schemas/common_platformFilterKeyValue"},"title":"Key Value filters"},"logical_operator":{"type":"string","enum":["OPERATOR_LOGICAL_UNKNOWN","AND","OR"],"default":"OPERATOR_LOGICAL_UNKNOWN","description":"- AND: Logical AND\n - OR: Logical OR","title":"Logical Operator","example":"AND","$$ref":"#/components/schemas/common_platformLogicalOperator"},"sort_operator":{"type":"string","enum":["SORT_UNSPECIFIED","ASCENDING","DESCENDING"],"default":"SORT_UNSPECIFIED","description":"The sort direction.\n\n - SORT_UNSPECIFIED: Unspecified. This value must not be used.\n - ASCENDING: Ascending.\n - DESCENDING: Descending.","example":"ASCENDING","$$ref":"#/components/schemas/common_platformSortOperator"}},"title":"KeyValue Filter Set","example":{"filter_fields":[{"key_value":{"key":"status","string_value":"ACTIVE"},"comparison_operator":"EQUAL"}],"logical_operator":"AND","sort_operator":"ASCENDING"},"$$ref":"#/components/schemas/common_platformFilterKeyValueSet"},"cw_query":{"type":"object","properties":{"query":{"type":"string","title":"SQL like filter query\nselect * from robotnodedata where provider.provider.name='nso101'"}},"title":"SQL like CW query style","example":{"query":"select * from applications where status='ACTIVE'"},"$$ref":"#/components/schemas/common_platformCWQuery"},"pagination":{"type":"object","properties":{"page_token":{"type":"string","title":"Page token to echo back to get next page, is empty or page token is empty,\nthen there is no more results"},"page_size":{"type":"integer","format":"int64","title":"page_size"}},"title":"Pagination option","example":{"page_token":"","page_size":10},"$$ref":"#/components/schemas/common_platformPagination"}},"title":"Query Options","example":{"filters":{"filter_fields":[{"key_value":{"key":"status","string_value":"ACTIVE"},"comparison_operator":"EQUAL"}],"logical_operator":"AND","sort_operator":"ASCENDING"},"cw_query":{"query":"select * from applications where status='ACTIVE'"},"pagination":{"page_token":"","page_size":10}},"$$ref":"#/components/schemas/common_platformQueryOptions"}},"title":"Get Application in repository","example":{"query_options":{"filters":null,"cw_query":null,"pagination":{"page_token":"","page_size":10}}},"$$ref":"#/components/schemas/app_managerGetPackagesInRepositoryRequest"}}},"description":"Specifies query options for filtering packages in the repository.","required":true},"tags":["ApplicationManagerService"],"__originalOperationId":"ApplicationManagerService_GetPackagesInRepository","security":[{"bearerAuth":[]}],"method":"post","path":"/capp/repository/packagenameidgroups/query"}}