{ "opencollection": "1.0.0", "info": { "name": "Functions Service Functions Management API", "version": "20181201" }, "items": [ { "info": { "name": "functionsManagement", "type": "folder" }, "items": [ { "info": { "name": "Lists applications for a compartment", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20181201/applications", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this resource belongs.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. 1 is the minimum, 50 is the maximum.\n\nDefault: 10\n" }, { "name": "page", "value": "", "type": "query", "description": "The pagination token for a list query returned by a previous operation\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only applications that match the lifecycle state in this parameter.\nExample: `Creating`\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only applications with display names that match the display name string. Matching is exact.\n" }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only applications with the specified OCID.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Specifies the attribute with which to sort the rules.\n\nDefault: `displayName`\n\n* **timeCreated:** Sorts by timeCreated.\n* **displayName:** Sorts by displayName.\n* **id:** Sorts by id.\n" } ] }, "docs": "Lists applications for a compartment." }, { "info": { "name": "Creates a new application", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20181201/applications", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new application." }, { "info": { "name": "Retrieves an application", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20181201/applications/:applicationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this application.\n" } ] }, "docs": "Retrieves an application." }, { "info": { "name": "Modifies an application", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20181201/applications/:applicationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this application.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies an application" }, { "info": { "name": "Deletes an application", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20181201/applications/:applicationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this application.\n" } ] }, "docs": "Deletes an application." }, { "info": { "name": "Moves an application into a different compartment. When provided, If-Match is checked against ETag values of the resource.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20181201/applications/:applicationId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this application.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an application into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see [Moving Resources Between Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Lists functions for an application", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20181201/functions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "applicationId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the application to which this function belongs.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. 1 is the minimum, 50 is the maximum.\n\nDefault: 10\n" }, { "name": "page", "value": "", "type": "query", "description": "The pagination token for a list query returned by a previous operation\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only functions that match the lifecycle state in this parameter.\nExample: `Creating`\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only functions with display names that match the display name string. Matching is exact.\n" }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only functions with the specified OCID.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Specifies the attribute with which to sort the rules.\n\nDefault: `displayName`\n\n* **timeCreated:** Sorts by timeCreated.\n* **displayName:** Sorts by displayName.\n* **id:** Sorts by id.\n" } ] }, "docs": "Lists functions for an application." }, { "info": { "name": "Creates a new function", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20181201/functions", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new function." }, { "info": { "name": "Retrieves a function", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20181201/functions/:functionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "functionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this function.\n" } ] }, "docs": "Retrieves a function." }, { "info": { "name": "Modifies a function", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20181201/functions/:functionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "functionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this function.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a function" }, { "info": { "name": "Deletes a function", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20181201/functions/:functionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "functionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this function.\n" } ] }, "docs": "Deletes a function." }, { "info": { "name": "Get a list of all Pre-built Function(PBF) Listing versions.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20181201/pbfListingVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pbfListingId", "value": "", "type": "query", "description": "unique PbfListing identifier" }, { "name": "pbfListingVersionId", "value": "", "type": "query", "description": "unique PbfListingVersion identifier" }, { "name": "name", "value": "", "type": "query", "description": "Matches a PbfListingVersion based on a provided semantic version name for a PbfListingVersion. \nEach PbfListingVersion name is unique with respect to its associated PbfListing.\n" }, { "name": "isCurrentVersion", "value": "", "type": "query", "description": "Matches the current version (the most recently added version with an Active \nlifecycleState) associated with a PbfListing.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. 1 is the minimum, 50 is the maximum.\n\nDefault: 10\n" }, { "name": "page", "value": "", "type": "query", "description": "The pagination token for a list query returned by a previous operation\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending.\n" } ] }, "docs": "Fetches a wrapped list of all Pre-built Function(PBF) Listing versions. Returns a PbfListingVersionCollection \ncontaining an array of PbfListingVersionSummary response models.\n\nNote that the PbfListingIdentifier must be provided as a query parameter, otherwise an exception shall \nbe thrown.\n" }, { "info": { "name": "Get details for a specific version of a Pre-built Function(PBF) Listing.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20181201/pbfListingVersions/:pbfListingVersionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pbfListingVersionId", "value": "", "type": "path", "description": "unique PbfListingVersion identifier" } ] }, "docs": "Gets a PbfListingVersion by identifier for a PbfListing." }, { "info": { "name": "Get a list of all Pre-built Function(PBF) Listings.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20181201/pbfListings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pbfListingId", "value": "", "type": "query", "description": "unique PbfListing identifier" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire PBF name given." }, { "name": "nameContains", "value": "", "type": "query", "description": "A filter to return only resources that contain the supplied filter text in the PBF name given." }, { "name": "nameStartsWith", "value": "", "type": "query", "description": "A filter to return only resources that start with the supplied filter text in the PBF name given." }, { "name": "trigger", "value": "", "type": "query", "description": "A filter to return only resources that match the service trigger sources of a PBF." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. 1 is the minimum, 50 is the maximum.\n\nDefault: 10\n" }, { "name": "page", "value": "", "type": "query", "description": "The pagination token for a list query returned by a previous operation\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending.\n" } ] }, "docs": "Fetches a wrapped list of all Pre-built Function(PBF) Listings. Returns a PbfListingCollection containing \nan array of PbfListingSummary response models.\n" }, { "info": { "name": "Gets a list of all Triggers.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20181201/pbfListings/triggers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the service trigger source of a PBF." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. 1 is the minimum, 50 is the maximum.\n\nDefault: 10\n" }, { "name": "page", "value": "", "type": "query", "description": "The pagination token for a list query returned by a previous operation\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n" } ] }, "docs": "Returns a list of Triggers.\n" }, { "info": { "name": "Get a Pre-built Function(PBF) Listing.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20181201/pbfListings/:pbfListingId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pbfListingId", "value": "", "type": "path", "description": "unique PbfListing identifier" } ] }, "docs": "Fetches a Pre-built Function(PBF) Listing. Returns a PbfListing response model.\n" } ] } ], "bundled": true }