{ "opencollection": "1.0.0", "info": { "name": "Usage Proxy Greetings API", "version": "20190111" }, "items": [ { "info": { "name": "greetings", "type": "folder" }, "items": [ { "info": { "name": "Get a warm greeting by id from the SAPI app.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190111/greeting/:greetingId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "greetingId", "value": "", "type": "path", "description": "Greeting ID to return.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the root compartment." }, { "name": "fields", "value": "", "type": "query", "description": "Partial response refers to an optimization technique offered\nby the RESTful web APIs, to return only the information \n(fields) required by the client. In this mechanism, the client\nsends the required field names as the query parameters for\nan API to the server, and the server trims down the default\nresponse content by removing the fields that are not required\nby the client. The parameter controls which fields to\nreturn and should be a query string parameter called \"fields\" of\nan array type, provide the values as enums, and use collectionFormat.\n" } ] }, "docs": "Gets a warm greeting from your template application.\n" }, { "info": { "name": "Returns a list of Greetings", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190111/greetings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the root compartment." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call. Default: (`50`)\n\nExample: '500'\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the 'opc-next-page' response header from the previous \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending ('ASC') or descending ('DESC').\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order ('sortOrder').\n" } ] }, "docs": "Collection API where you can get a warm greeting by ID from the SAPI application, and other collection parameters that are available.\n" } ] } ], "bundled": true }