getcodesamplesrequest.md

GetCodeSamplesRequest

Example Usage

import { GetCodeSamplesRequest } from "@speakeasyapi/code-samples/models/operations";

let value: GetCodeSamplesRequest = {
  registryUrl: "https://spec.speakeasy.com/org/ws/my-source",
  operationIds: [
    "getPets",
  ],
  methodPaths: [
    {
      method: "get",
      path: "/pets",
    },
  ],
  languages: [
    "python",
    "javascript",
  ],
};

Fields

Field	Type	Required	Description	Example
registryUrl	string	➖	The registry URL from which to retrieve the snippets.	https://spec.speakeasy.com/org/ws/my-source
operationIds	string[]	➖	The operation IDs to retrieve snippets for.	getPets
methodPaths	operations.MethodPaths[]	➖	The method paths to retrieve snippets for.	[ { "method": "get", "path": "/pets" } ]
languages	string[]	➖	The languages to retrieve snippets for.	[ "python", "javascript" ]